@relu-interactives/spatial-ecs
@relu-interactives/spatial-ecs / components / TransformComponent
Class: TransformComponent ​
Defined in: components/Transform.ts:50
Position, rotation, and scale of an entity in its parent's local space.
Remarks ​
Rotation is stored in radians (Euler XYZ). The editor inspector converts to/from degrees for display — do not store degrees in this component. Mutations should go through the setPosition / setRotation / setScale helpers so dependent systems pick up the change.
Extends ​
Constructors ​
Constructor ​
new TransformComponent(data?): TransformComponent;Defined in: components/Transform.ts:58
Parameters ​
| Parameter | Type |
|---|---|
data | TransformData |
Returns ​
TransformComponent
Overrides ​
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
position | Vec3 | Local position relative to the parent (or world if no parent). | components/Transform.ts:52 |
rotation | Vec3 | Local rotation as Euler XYZ in radians. | components/Transform.ts:54 |
scale | Vec3 | Local scale factors per axis (1 = identity). | components/Transform.ts:56 |
Methods ​
toPositionVector3() ​
toPositionVector3(target?): Vector3;Defined in: components/Transform.ts:84
Parameters ​
| Parameter | Type |
|---|---|
target | Vector3 |
Returns ​
Vector3
toRotationEuler() ​
toRotationEuler(target?, order?): Euler;Defined in: components/Transform.ts:88
Parameters ​
| Parameter | Type | Default value |
|---|---|---|
target | Euler | ... |
order | EulerOrder | "XYZ" |
Returns ​
Euler
toRotationQuaternion() ​
toRotationQuaternion(target?, order?): Quaternion;Defined in: components/Transform.ts:95
Parameters ​
| Parameter | Type | Default value |
|---|---|---|
target | Quaternion | ... |
order | EulerOrder | "XYZ" |
Returns ​
Quaternion
toScaleVector3() ​
toScaleVector3(target?): Vector3;Defined in: components/Transform.ts:108
Parameters ​
| Parameter | Type |
|---|---|
target | Vector3 |
Returns ​
Vector3
setPosition() ​
setPosition(input): this;Defined in: components/Transform.ts:112
Parameters ​
| Parameter | Type |
|---|---|
input | TransformInput |
Returns ​
this
setScale() ​
setScale(input): this;Defined in: components/Transform.ts:120
Parameters ​
| Parameter | Type |
|---|---|
input | TransformInput |
Returns ​
this
setRotation() ​
setRotation(input, order?): this;Defined in: components/Transform.ts:128
Parameters ​
| Parameter | Type | Default value |
|---|---|---|
input | TransformInput | undefined |
order | EulerOrder | "XYZ" |
Returns ​
this