PlanarText

The PlanarText class describes text on a plane.

Properties

PropertyDescription
alignment
(get) alignment: TextAlignmentWrapper
(set) (Not Available)


Represents the TextAlignmentWrapper that contains parameters that specify the text alignment.
font
(get) (Not Available)
(set) font: FontId


Sets the given font from the fonts registry.
fontSize
(get) (Not Available)
(set) fontSize: number


Specifies the font size of the text.
leading
(get) (Not Available)
(set) leading: ?number


Specifies the line spacing. This is the distance between the baselines in the text. If unspecified, spacing defaults to the font size.
material
(get) (Not Available)
(set) material: MaterialBase


Specifies the material of the scene object.
maxLines
(get) (Not Available)
(set) maxLines: ?number


Specifies the maximum number of lines for the text. If unspecified, the number of lines is unrestricted.
scaleToFit
(get) (Not Available)
(set) scaleToFit: boolean


Specifies if the text is scaled to fit the container.
text
(get) text: StringSignal
(set) text: StringSignal


Specifies the text displayed.
tracking
(get) (Not Available)
(set) tracking: number


Specifies the text spacing. This is the additional distance between letters. Default is zero. Can be negative.

Methods

MethodDescription
getMaterial
getMaterial(): Promise<MaterialBase>


Returns a promise that is resolved with the material associated with a given scene object or null if no material was assigned.