Class TransformComponent

A core component that provides an entity with a 3D orientation, position and scale.

Remarks

All entities have a transform component. Transform components cannot be detached from entities.

Hierarchy (View Summary)

Component
- TransformComponent

Properties

`Readonly`entity

entity: Entity

The entity to which the component is attached.

Accessors

deleted

get deleted(): Subscribable<Component>
Notifies when the component is detached from the entity.

Returns Subscribable<Component>
Inherited from Component.deleted

initialized

get initialized(): boolean
Whether the component has been initialized.

Returns boolean
Inherited from Component.initialized

io

get io(): null | IO
The IO signals provided by the component.

Returns null | IO
Inherited from Component.io

name

get name(): string
The component name.

Returns string
Inherited from Component.name
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from Component.name

position

get position(): Vec3
The local position.

Returns Vec3
set position(value: IVec3): void
Parameters
- value: IVec3
Returns void

rotation

get rotation(): Quat
The local rotation.

Returns Quat
set rotation(value: IQuat): void
Parameters
- value: IQuat
Returns void

scale

get scale(): number
The local scale.

Returns number
set scale(value: number): void
Parameters
- value: number
Returns void

world

get world(): World
The virtual world to which the owning entity belongs.

Returns World
Inherited from Component.world

worldPosition

get worldPosition(): Vec3
The world position.

Returns Vec3
set worldPosition(value: IVec3): void
Parameters
- value: IVec3
Returns void

worldRotation

get worldRotation(): Quat
The world rotation.

Returns Quat
set worldRotation(value: IQuat): void
Parameters
- value: IQuat
Returns void

worldScale

get worldScale(): number
The world scale.

Returns number
set worldScale(value: number): void
Parameters
- value: number
Returns void

Methods

`Protected` `Optional`added

added(): void
Added function called immediately after the component is attached to an entity.

Returns void
Inherited from Component.added

`Protected`handle

handle<T extends ITrackable<any>>(
type: TrackableType<T>,
value?: null | T,
): Handle<T>
Creates a handle (weak reference) to a trackable object.
Type Parameters
- T extends ITrackable<any>
Parameters
- type: TrackableType<T>
  The type of object that is to be referenced.
- value: null | T = null
  The object that is initially referenced by the handle.
Returns Handle<T>
A handle to a trackable object.
Remarks
Handles created through this function are automatically cleared when the component is detached/removed.
Example: Creating a handle to an entity.
```
const handle = this.handle(Entity, this.world.find("Some Entity"));
```
Example: Creating a handle to a scripted component of a specific type.
```
const handle = this.handle(MyScriptComponent);
```
Inherited from Component.handle

`Protected` `Optional`initialize

initialize(): void
Initialization function called immediately before simulating when the model is initialized.

Returns void
Inherited from Component.initialize

`Protected` `Optional`initializeAsync

initializeAsync(): Promise<void>
Asynchronous initialization function called immediately before simulating when the model is initialized.

Returns Promise<void>
Inherited from Component.initializeAsync

localToWorldPoint

localToWorldPoint(localPoint: IVec3): Vec3
Transforms a point from local-space to world-space.
Parameters
- localPoint: IVec3
  The point in local-space.
Returns Vec3
The point in world-space.

`Protected` `Optional`postUpdate

postUpdate(dt: number): void
Post-update function called after physics has been updated.
Parameters
- dt: number
  The timestep (seconds).
Returns void
Inherited from Component.postUpdate

`Protected` `Optional`postUpdateAsync

postUpdateAsync(dt: number): Promise<void>
Asynchronous post-update function called after physics has been updated.
Parameters
- dt: number
  The timestep (seconds).
Returns Promise<void>
Inherited from Component.postUpdateAsync

`Protected`removed

removed(): void
Removed function called immediately after the component is detached from an entity.

Returns void
Inherited from Component.removed

requireAsyncInitialization

requireAsyncInitialization(): Promise<void>
Immediately triggers asynchronous initialization if the component hasn't already been initialized.

Returns Promise<void>
Remarks
This can be used in cases where one component references another in its asynchronous initialize function, but it is required that the referenced component has already been asynchronously initialized.

Inherited from Component.requireAsyncInitialization

requireInitialization

requireInitialization(): void
Immediately triggers initialization if the component hasn't already been initialized.

Returns void
Remarks
This can be used in cases where one component references another in its initialize function, but it is required that the referenced component has already been initialized.

Inherited from Component.requireInitialization

`Protected`subscribe

subscribe<T>(object: Subscribable<T>, subscriber: Subscriber<T>): void
Subscribes to a subscribable object.

Subscriptions created through this function are automatically unsubscribed when the component is detached/removed.
Type Parameters
- T
Parameters
- object: Subscribable<T>
  The subscribable object for which to subscribe.
- subscriber: Subscriber<T>
  The callback function that is triggered when the object's value is updated.
Returns void
Inherited from Component.subscribe

`Protected`unsubscribe

unsubscribe<T>(object: Subscribable<T>, subscriber: Subscriber<T>): boolean
Unsubscribes from a subscribable object.
Type Parameters
- T
Parameters
- object: Subscribable<T>
  The object from which to unsubscribe.
- subscriber: Subscriber<T>
  The callback function for the subscription.
Returns boolean
True if the subscription was canceled, false otherwise.

Inherited from Component.unsubscribe

`Protected` `Optional`update

update(dt: number): void
Update function called every timestep when simulating.
Parameters
- dt: number
  The timestep (seconds).
Returns void
Inherited from Component.update

`Protected` `Optional`updateAsync

updateAsync(dt: number): Promise<void>
Asynchronous update function called every timestep when simulating.
Parameters
- dt: number
  The timestep (seconds).
Returns Promise<void>
Inherited from Component.updateAsync

worldToLocalPoint

worldToLocalPoint(worldPoint: IVec3): Vec3
Transforms a point from world-space to local-space.
Parameters
- worldPoint: IVec3
  The point in world-space.
Returns Vec3
The point in local-space.

Class TransformComponent

Remarks

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Readonlyentity

Accessors

deleted

Returns Subscribable<Component>

initialized

Returns boolean

io

Returns null | IO

name

Returns string

Parameters

Returns void

position

Returns Vec3

Parameters

Returns void

rotation

Returns Quat

Parameters

Returns void

scale

Returns number

Parameters

Returns void

world

Returns World

worldPosition

Returns Vec3

Parameters

Returns void

worldRotation

Returns Quat

Parameters

Returns void

worldScale

Returns number

Parameters

Returns void

Methods

Protected Optionaladded

Returns void

Protectedhandle

Type Parameters

Parameters

Returns Handle<T>

Remarks

Example: Creating a handle to an entity.

Example: Creating a handle to a scripted component of a specific type.

Protected Optionalinitialize

Returns void

Protected OptionalinitializeAsync

Returns Promise<void>

localToWorldPoint

Parameters

Returns Vec3

Protected OptionalpostUpdate

Parameters

Returns void

Protected OptionalpostUpdateAsync

Parameters

Returns Promise<void>

Protectedremoved

Returns void

requireAsyncInitialization

Returns Promise<void>

Remarks

requireInitialization

Returns void

Remarks

Protectedsubscribe

Type Parameters

Parameters

`Readonly`entity

`Protected` `Optional`added

`Protected`handle

`Protected` `Optional`initialize

`Protected` `Optional`initializeAsync

`Protected` `Optional`postUpdate

`Protected` `Optional`postUpdateAsync

`Protected`removed

`Protected`subscribe

`Protected`unsubscribe

`Protected` `Optional`update

`Protected` `Optional`updateAsync