The PlanarText
class describes text on a plane.
Property | Description |
---|---|
|
Represents the |
|
Sets the given font from the fonts registry. i.e: myText.font = require('Fonts').get("myFontName") |
|
Specifies the font size of the text. |
|
Specifies the line spacing. This is the distance between the baselines in the text. If unspecified, spacing defaults to the font size. |
|
Specifies the material of the scene object. |
|
Specifies the maximum number of lines for the text. If unspecified, the number of lines is unrestricted. |
|
Specifies if the text is scaled to fit the container. |
|
Specifies the text displayed. |
|
Specifies the text spacing. This is the additional distance between letters. Default is zero. Can be negative. |
|
Represents the current 2D bounds relative to the parent element. This is the result of the layout calculation. Values are measured in 3D units. Note: The |
|
Specifies the height of the object. Note: the specific measurement unit used depends on the context. It is usually regular 3D units unless the object is a descendant of a Screen Plane (2D Canvas) object when the unit might be interpreted in a special way. Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via |
|
Specifies the horizontal alignment. |
|
Specifies the size of the bottom margin. Note: it behaves in a similar way to the |
|
Specifies the size of the right margin. Note: it behaves in a similar way to the |
|
Specifies the size of the left margin. Note: it behaves in a similar way to the |
|
Specifies the size of the top margin. Note: it behaves in a similar way to the |
|
Specifies the size adjustment relative to parent. |
|
Specifies the vertical alignment. |
|
Specifies the width of the object. Note: the specific measurement unit used depends on the context. It is usually regular 3D units unless the object is a descendant of a Screen Plane (2D Canvas) object when the unit might be interpreted in a special way. Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via |
|
Specifies the horizontal offset of the object. Note: the specific measurement unit used depends on the context. It is usually regular 3D units unless the object is a descendant of a Screen Plane (2D Canvas) object when the unit might be interpreted in a special way. Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via |
|
Specifies the vertical offset of the object. Note: the specific measurement unit used depends on the context. It is usually regular 3D units unless the object is a descendant of a Screen Plane (2D Canvas) object when the unit might be interpreted in a special way. Note: this parameter is used as an input to the layout algorithm. The layout-calculated size and location of the object is available via |
|
Represents whether or not the bounding box for the object is visible. |
|
Represents the |
|
Specifies whether the scene object and its descendants are hidden. |
|
Specifies the scene object unique identifier. This value is specified internally in AR Studio. |
|
Specifies the unique material identifier assigned to scene object. This value is specified internally in AR Studio. |
|
Specifies the scene object name. This is the unique identifier of the object within the list of its siblings (immediate child objects of the same parent object). Note: the object name is specified in AR Studio UI during design time. Note: the object name must only be unique withing the list of direct siblings. There can be more than object with the same name in the scene as soon as they have different parents. See Also: |
|
Represents the |
|
Specifies a |
|
Represents the object transformation, in object's local coordinate system. |
|
Specifies a |
Method | Description |
---|---|
|
Returns a child object by name. An exception is thrown if the object isn't found. See Also: |
|
Returns a descendant object by name. An exception is thrown if the object isn't found or if more than one is found. Note: object D is considered to be a descendant of object P if either D is a child of P or if such an object C which is a child of P exists that D is a descendant of C. See Also: |