Class Transform

Hierarchy

Component
- Transform

Index

Constructors

constructor

Events

changed

Accessors

Methods

Constructors

constructor

new Transform(props?: ObjectProps<Transform>): Transform

- Defined in src/core/Transform.ts:140
Parameters
- Optional props: ObjectProps<Transform>
Returns Transform

Events

changed

changed: VoidSyncEvent = new VoidSyncEvent()

Accessors

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

eventsEnabled

set eventsEnabled(enabled: boolean): void

- Defined in src/core/Transform.ts:43
Parameters
- enabled: boolean
Returns void

forward

get forward(): Vector3

- Defined in src/core/Transform.ts:92
Returns Vector3

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

invWorldMatrix

get invWorldMatrix(): Matrix44

- Defined in src/core/Transform.ts:65
Returns Matrix44

localMatrix

get localMatrix(): Matrix44

- Defined in src/core/Transform.ts:45
Returns Matrix44

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

position

get position(): Vector3
set position(position: Vector3): void

- Defined in src/core/Transform.ts:37
Returns Vector3
- Defined in src/core/Transform.ts:40
Parameters
- position: Vector3
Returns void

right

get right(): Vector3

- Defined in src/core/Transform.ts:88
Returns Vector3

rotation

get rotation(): Quaternion
set rotation(rotation: Quaternion): void

- Defined in src/core/Transform.ts:38
Returns Quaternion
- Defined in src/core/Transform.ts:41
Parameters
- rotation: Quaternion
Returns void

scale

get scale(): Vector3
set scale(scale: Vector3): void

- Defined in src/core/Transform.ts:39
Returns Vector3
- Defined in src/core/Transform.ts:42
Parameters
- scale: Vector3
Returns void

up

get up(): Vector3

- Defined in src/core/Transform.ts:96
Returns Vector3

version

get version(): number

- Defined in src/core/Transform.ts:29
Returns number

worldForward

get worldForward(): Vector3

- Defined in src/core/Transform.ts:78
Returns Vector3

worldMatrix

get worldMatrix(): Matrix44

- Defined in src/core/Transform.ts:53
Returns Matrix44

worldPosition

get worldPosition(): Vector3
set worldPosition(worldPosition: Vector3): void

- Defined in src/core/Transform.ts:100
Returns Vector3
- Defined in src/core/Transform.ts:104
Parameters
- worldPosition: Vector3
Returns void

worldRight

get worldRight(): Vector3

- Defined in src/core/Transform.ts:73
Returns Vector3

worldRotation

get worldRotation(): Quaternion

- Defined in src/core/Transform.ts:113
Returns Quaternion

worldScale

get worldScale(): Vector3

- Defined in src/core/Transform.ts:117
Returns Vector3

worldUp

get worldUp(): Vector3

- Defined in src/core/Transform.ts:83
Returns Vector3

Methods

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Inherited from SerializableObject.destroy
- Defined in src/core/SerializableObject.ts:33
Returns void

dirtifyWorldMatrix

dirtifyWorldMatrix(): void

- Defined in src/core/Transform.ts:207
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Inherited from Component.isLoaded
- Defined in src/core/Component.ts:36
Returns boolean

localToWorld

localToWorld(localPos: Vector3, worldPosOut: Vector3): Vector3

- Defined in src/core/Transform.ts:192
Parameters
- localPos: Vector3
- worldPosOut: Vector3
Returns Vector3

onReplace

onReplace(previous: Transform): void

Overrides Component.onReplace
- Defined in src/core/Transform.ts:249
Parameters
- previous: Transform
Returns void

reset

reset(): void

Overrides Component.reset
- Defined in src/core/Transform.ts:240
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setEntity

setEntity(entity: Entity): void

Inherited from Component.setEntity
- Defined in src/core/Component.ts:32
Parameters
- entity: Entity
Returns void

setLocalMatrix

setLocalMatrix(matrix: Matrix44): void

- Defined in src/core/Transform.ts:233
Parameters
- matrix: Matrix44
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

translate

translate(translation: Vector3): void

- Defined in src/core/Transform.ts:170
Parameters
- translation: Vector3
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/core/Transform.ts:174
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject

worldToLocal

worldToLocal(worldPos: Vector3, localPosOut: Vector3): Vector3

- Defined in src/core/Transform.ts:188
Parameters
- worldPos: Vector3
- localPosOut: Vector3
Returns Vector3

worldToLocalDirection

worldToLocalDirection(worldDirection: Vector3, localDirOut: Vector3): Vector3

- Defined in src/core/Transform.ts:196
Parameters
- worldDirection: Vector3
- localDirOut: Vector3
Returns Vector3

worldToLocalRotation

worldToLocalRotation(worldRotation: Quaternion, localRotation: Quaternion): Quaternion

- Defined in src/core/Transform.ts:203
Parameters
- worldRotation: Quaternion
- localRotation: Quaternion
Returns Quaternion