neoscore.interface.text_interface

class neoscore.interface.text_interface.TextInterface[source]

Bases: PositionedObjectInterface

An interface for graphical text objects.

brush: BrushInterface
pen: PenInterface
text: str
font: FontInterface
scale: float = 1
rotation: float = 0

Rotation angle in degrees

background_brush: Optional[BrushInterface] = None
z_index: int = 0

Z-index controlling draw order.

clip_start_x: Optional[Unit] = None

The local starting position of the drawn region in the glyph.

Use None to render from the start

__init__(pos: Point, brush: BrushInterface, pen: PenInterface, text: str, font: FontInterface, scale: float = 1, rotation: float = 0, background_brush: Optional[BrushInterface] = None, z_index: int = 0, clip_start_x: Optional[Unit] = None, clip_width: Optional[Unit] = None) None
clip_width: Optional[Unit] = None

The width of the visible region.

Use None to render to the end.

render()[source]

Render the line to the scene.