Skip to main content

Editor.Components.ScreenTransform

Class

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

Index

Example

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

Extends

Properties

advanced

advanced: boolean

Enable advanced constraint and offset options.


anchor

anchor: Rect

Screen-space anchor rectangle for positioning.


constraints

constraints: ScreenTransformConstraints

Constraints determining how the element responds to screen resizing.


enabled

enabled: boolean

Whether the component is active.

Inherited from

Component.enabled


hasPrefabChanges

readonly hasPrefabChanges: 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

Component.hasPrefabChanges


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Component.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

Component.isPrefabInstanceRoot


meta

readonly meta: Meta

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

Inherited from

Component.meta


name

name: string

Name of the component.

Inherited from

Component.name


offset

offset: Rect

Pixel offset from the anchor position.


pivot

pivot: vec2

Normalized pivot point for rotation and scaling.


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Component.sceneObject


transform

transform: Transform

Local transform relative to the screen anchor.


type

readonly type: string

The entity's type.

Inherited from

Component.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Component.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Component.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Component.getOwnedEntities


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

Prefabable

Inherited from

Component.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Component.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Component.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Component.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Component.isSame