Highlightable

Qualified name: manim\_dsa.utils.utils.Highlightable

class Highlightable[source]

Bases: object

A mixin class that provides functionality to highlight and unhighlight Manim objects.

highlighting

The highlight effect associated with the object, if any.

Type:

VMobject or None

Methods

highlight

Highlight the object with the specified stroke color and width.

set_highlight

Set the highlight properties.

unhighlight

Remove the highlight from the object.

highlight(stroke_color=ManimColor('#FC6255'), stroke_width=8)[source]

Highlight the object with the specified stroke color and width.

Parameters:
  • stroke_color (ManimColor, optional) – The color of the highlight stroke (default is RED).

  • stroke_width (float, optional) – The width of the highlight stroke (default is 8).

Returns:

The instance with the highlight applied.

Return type:

Highlightable

set_highlight(stroke_color=ManimColor('#FC6255'), stroke_width=8)[source]

Set the highlight properties.

Parameters:
  • stroke_color (ManimColor, optional) – The color of the highlight stroke (default is RED).

  • stroke_width (float, optional) – The width of the highlight stroke (default is 8).

unhighlight()[source]

Remove the highlight from the object.

Returns:

The instance with the highlight removed.

Return type:

Highlightable