Class Canvas

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}`);
Copy