ScreenTransform

Lens Studio v2.0.0+

Scripting Name: Component.ScreenTransform

Inherits from Component

Description

Used for positioning objects in 2d screen space. It overrides the regular Transform component on the SceneObject it’s attached to.

See the Screen Transform guide for more information.

Properties

---

anchors : Rect

The anchor rect positioning this ScreenTransform porportional to its parent’s bounds. For each field, a value of 0 equals the parent’s center point, and value of -1 or 1 (depending on the side) equals the parent’s full boundary.

For example, a top value of 1.0 means this ScreenTransform’s top edge will be exactly at the top edge of its parent.

A bottom value of -0.5 means this ScreenTransform’s bottom edge will be halfway between its parent’s bottom edge and center.

A right value of 0 means this ScreenTransform’s right edge will be exactly at its parent’s center.

A left value of -2 means this ScreenTransform’s left edge will be twice as far from its parent’s center as its parent’s left edge is.

---

offsets : Rect

This rect is applied after anchors to determine the final boundaries of the ScreenTransform. It adds an offset in world units (based on the parent Camera’s size property) to each edge of the ScreenTransform’s boundaries.

For example, a value of 0 for any side will have no effect on boundaries.

A value of 1.0 for any side will offset that edge by 1.0 world unit.

---

pivot : vec2

Normalized (x, y) position of the center point used in rotation. (-1, -1) being bottom left, (0, 0) being center, and (1, 1) being top right of the image.

---

position : vec3

Basic local position in world units relative to the parent’s center. Useful for animating screen elements with a simple offset.

---

rotation : quat

Basic local rotation applied to the SceneObject.

---

scale : vec3

Basic local scaling applied to the SceneObject.

Inherited Methods

---

destroy() : void

Destroys the component.

---

getSceneObject() : SceneObject

Returns the SceneObject the component is attached to.

---

getTransform() : Transform

Returns the Transform this component is attached to.

---

getTypeName() : String

Returns the name of this object’s type.

---

isSame(SerializableWithUID other) : Boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Inherited Properties

---

enabled : Boolean

If disabled, the Component will stop enacting its behavior.

Examples

// @input Component.ScreenTransform screenTransform

// Helper function to move a Rect's center point
function setRectCenter(rect, center) {
    var size = rect.getSize();
    rect.left = center.x - size.x * 0.5;
    rect.right = center.x + size.x * 0.5;
    rect.top = center.y + size.y * 0.5;
    rect.bottom = center.y - size.y * 0.5;
}

// Helper function to set a Rect's size
function setRectSize(rect, size) {
    var center = rect.getCenter();
    rect.left = center.x - size.x * 0.5;
    rect.right = center.x + size.x * 0.5;
    rect.top = center.y + size.y * 0.5;
    rect.bottom = center.y - size.y * 0.5;
}

// Move the ScreenTransform's anchor center
setRectCenter(script.screenTransform.anchors, new vec2(-0.25, 0.5));

// Change the ScreenTransform's anchor size
setRectSize(script.screenTransform.anchors, new vec2(0.25, 0.25));