Editor.Components.Canvas
ClassManages 2D canvas rendering and layout properties for a scene object.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
// Canvas is the root for ScreenTransform-based UI layouts. It's most
// commonly used for 2D HUD/UI, but it also works in 3D space — drop it
// on any SceneObject and its children with ScreenTransform render in
// local 2D coordinates. SortingType.Hierarchy draws children in scene
// tree order, which is handy for stacked panels placed in 3D.
// See: https://developers.snap.com/lens-studio/lens-studio-workflow/scene-set-up/2d/canvas-component
const obj = scene.createSceneObject('UICanvas');
const canvas = obj.addComponent('Canvas') as Editor.Components.Canvas;
canvas.unitType = Editor.Components.UnitType.Pixels;
canvas.sortingType = Editor.Components.SortingType.Hierarchy;
canvas.pivot = new vec2(0.5, 0.5);
console.log(`Canvas: unitType=${canvas.unitType}, sorting=${canvas.sortingType}`);
Extends
Properties
debugRenderLayoutRect
debugRenderLayoutRect:
boolean
If enabled, draws the Canvas.layoutRect bounds as a wireframe for debugging Canvas layout.
enabled
enabled:
boolean
Whether the component is active.
Inherited from
hasPrefabChanges
readonlyhasPrefabChanges:boolean
Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot:boolean
Whether this entity is the root of a prefab instance.
Inherited from
Component.isPrefabInstanceRoot
layoutRect
layoutRect:
Rect
The rectangular bounds that define the area child objects are laid out within. Each bound is defined as an offset in world units from the SceneObject's position.
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
pivot
pivot:
vec2
Anchor point for the canvas as a normalized 2D vector.
sceneObject
readonlysceneObject:SceneObject
Scene object this component is attached to.
Inherited from
sortingType
sortingType:
SortingType
Determines how the canvas sorts its children during rendering.
type
readonlytype:string
The entity's type.
Inherited from
unitType
unitType:
UnitType
Specifies the unit system used for canvas measurements.
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Component.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getPrefabInstanceRoot()
getPrefabInstanceRoot():
Prefabable
Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.
Returns
Inherited from
Component.getPrefabInstanceRoot
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean