CLEAR

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: Font

Sets the given font from the fonts registry. i.e: myText.font = require('Fonts').get("myFontName")

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.

bounds (inherited from PlanarObject)

(get) bounds: Bounds2D (set) (Not Available)

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 SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

height (inherited from PlanarObject)

(get) (Not Available) (set) height: number

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 PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

horizontalAlignment (inherited from PlanarObject)

(get) (Not Available) (set) horizontalAlignment: SceneModule.HorizontalAlignment

Specifies the horizontal alignment.

marginBottom (inherited from PlanarObject)

(get) (Not Available) (set) marginBottom: number

Specifies the size of the bottom margin.

Note: it behaves in a similar way to the margin-bottom CSS property.

marginEnd (inherited from PlanarObject)

(get) (Not Available) (set) marginEnd: number

Specifies the size of the right margin.

Note: it behaves in a similar way to the margin-right CSS property.

marginStart (inherited from PlanarObject)

(get) (Not Available) (set) marginStart: number

Specifies the size of the left margin.

Note: it behaves in a similar way to the margin-left CSS property.

marginTop (inherited from PlanarObject)

(get) (Not Available) (set) marginTop: number

Specifies the size of the top margin.

Note: it behaves in a similar way to the margin-top CSS property.

scalingOption (inherited from PlanarObject)

(get) (Not Available) (set) scalingOption: SceneModule.ScalingOption

Specifies the size adjustment relative to parent.

verticalAlignment (inherited from PlanarObject)

(get) (Not Available) (set) verticalAlignment: SceneModule.VerticalAlignment

Specifies the vertical alignment.

width (inherited from PlanarObject)

(get) (Not Available) (set) width: number

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 PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

xOffset (inherited from PlanarObject)

(get) (Not Available) (set) xOffset: number

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 PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

yOffset (inherited from PlanarObject)

(get) (Not Available) (set) yOffset: number

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 PlanarObject.bounds property. The SceneObjectBase.transform property doesn't affect the layout, the transformation it specifies is applied on top of it.

boundingBoxVisible (inherited from SceneObjectBase)

(get) boundingBoxVisible: BoolSignal (set) (Not Available)

Represents whether or not the bounding box for the object is visible.

cameraVisibility (inherited from SceneObjectBase)

(get) cameraVisibility: CameraVisibility (set) (Not Available)

Represents the CameraVisibility that contains a set of flags that specify the scene object (and its descendants) visibility depending on the active camera.

hidden (inherited from SceneObjectBase)

(get) hidden: BoolSignal (set) hidden: BoolSignal

Specifies whether the scene object and its descendants are hidden.

identifier (inherited from SceneObjectBase)

(get) identifier: String (set) (Not Available)

Specifies the scene object unique identifier. This value is specified internally in AR Studio.

materialIdentifier (inherited from SceneObjectBase)

(get) materialIdentifier: String (set) (Not Available)

Specifies the unique material identifier assigned to scene object. This value is specified internally in AR Studio.

name (inherited from SceneObjectBase)

(get) name: String (set) (Not Available)

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: SceneObjectBase.child, SceneObjectBase.find, SceneModule.root.

outputVisibility (inherited from SceneObjectBase)

(get) outputVisibility: OutputVisibility (set) (Not Available)

Represents the OutputVisibility that contains a set of flags that specify the scene object (and its descendants) visibility depending on the output.

parentWorldTransform (inherited from SceneObjectBase)

(get) parentWorldTransform: TransformSignal (set) (Not Available)

Specifies a TransformSignal object describing the parent's transformation relative to world coordinate system.

transform (inherited from SceneObjectBase)

(get) transform: Transform (set) transform: TransformSignal

Represents the object transformation, in object's local coordinate system.

worldTransform (inherited from SceneObjectBase)

(get) worldTransform: WorldTransform (set) worldTransform: TransformSignal

Specifies a TransformSignal object describing the object's transformation relative to world coordinate system. World transform in not yet supported for Canvas and Legacy canvas. Accessing this property from such objects or any of their children is not allowed.

Methods

MethodDescription

child (inherited from SceneObjectBase)

child(name: string): SceneObjectBase

Returns a child object by name. An exception is thrown if the object isn't found.

See Also: SceneObjectBase.find, SceneModule.root.

find (inherited from SceneObjectBase)

find(name: string): SceneObjectBase

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: SceneObjectBase.child, SceneModule.root.