CLEAR

Canvas


The Canvas class describes a scene canvas.

Properties

PropertyDescription

bounds

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

height

(get) height: ScalarSignal (set) height: ScalarSignal

Specifies the vertical size, in 3D units. Note: this is only effective when renderMode property is set to WORLD_SPACE.

renderMode

(get) renderMode: SceneModule.RenderMode (set) renderMode: SceneModule.RenderMode

Specifies how Canvas should be rendered. In SCREEN_SPACE mode, Canvas is automatically placed and sized to fit the screen, width and height properties are ignored. transform property is still used, it is applied on top of the focal plane transform. In WORLD_SPACE Canvas behaves as regular 3D object and is sized according to width and height properties.

useSafeAreaMargins

(get) useSafeAreaMargins: BoolSignal (set) useSafeAreaMargins: BoolSignal

Specifies if Canvas should automatically include SafeArea margin to its content. Note: this is only effective when renderMode property is set to SCREEN_SPACE.

width

(get) width: ScalarSignal (set) width: ScalarSignal

Specifies the horizontal size, in 3D units. Note: this is only effective when renderMode property is set to WORLD_SPACE.

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.