Skip to main content

Editor.Components.UnitType

Enum

Settings used with Editor.Components.Canvas.

Index

Enumeration Members

Example

// UnitType selects the coordinate unit of a Canvas component.
// Points — layout units independent of screen density (recommended for UI).
// Pixels — raw screen pixels; useful for pixel-exact overlays.
// A Canvas is usually parented under a Camera so its screen-space rect
// matches that camera's viewport.
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// 1. Create an empty camera object
const cameraObj = scene.createSceneObject('CanvasCamera');
cameraObj.addComponent('Camera');

// 2. Create a Canvas under the camera
const canvasObj = scene.createSceneObject('CanvasUnitTypeDemo');
canvasObj.setParent(cameraObj);
const canvas = canvasObj.addComponent('Canvas') as Editor.Components.Canvas;

// 3. Configure the Canvas unit system
canvas.unitType = Editor.Components.UnitType.Points;
canvas.unitType = Editor.Components.UnitType.Pixels;

Enumeration Members

Pixels

Pixels: number

Pixel-based measurement units.


Points

Points: number

Point-based measurement units.


World

World: number

World coordinate system units.

See also

LensScripting.Canvas.