Editor Scripting API
    Preparing search index...

    Class ScreenTransform

    Component for positioning and scaling UI elements relative to screen dimensions.

        const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
        const scene = model.project.scene;

        const obj = scene.createSceneObject('UIObj');
        const st = obj.addComponent('ScreenTransform') as Editor.Components.ScreenTransform;

        st.anchor = Editor.Rect.create(-1, 1, -1, 1);
        st.offset = Editor.Rect.create(0, 0, 0, 0);
        st.pivot = new vec2(0.5, 0.5);
        st.advanced = false;
        console.log(`ScreenTransform: pivot=${st.pivot}, advanced=${st.advanced}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    advanced anchor constraints enabled id meta name offset pivot sceneObject transform type

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    advanced: boolean

    Enable advanced constraint and offset options.

    anchor: Editor.Rect

    Screen-space anchor rectangle for positioning.

    constraints: ScreenTransformConstraints

    Constraints determining how the element responds to screen resizing.

    enabled: boolean

    Whether the component is active.

    id: Uuid

    The unique id of the entity.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    name: string

    Name of the component.

    offset: Editor.Rect

    Pixel offset from the anchor position.

    pivot: vec2

    Normalized pivot point for rotation and scaling.

    sceneObject: SceneObject

    Scene object this component is attached to.

    transform: Transform

    Local transform relative to the screen anchor.

    type: string

    The entity's type.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods