editor › Globals › IReadOnlyTransforms
Interface: IReadOnlyTransforms
Defines a read-only interface for a coordinate system. The coordinate system's origin is defined by the position and rotation in "global" coordinates, and you can use the provided methods to map positions, directions and rotations to "local" coordinates.
Hierarchy
- IReadOnlyTransforms
Implemented by
Index
Methods
- clone
- concat
- getGlobalToLocalMatrix
- getPosition
- getRotation
- isIdentityTransform
- mapGlobalDirectionToLocal
- mapGlobalPlaneToLocal
- mapGlobalPositionToLocal
- mapGlobalRotationToLocal
- mapLocalDirectionToGlobal
- mapLocalPlaneToGlobal
- mapLocalPosition2DToGlobal
- mapLocalPositionToGlobal
- mapLocalRotationToGlobal
Methods
clone
▸ clone(): Transforms
Defined in src/util/Transforms.ts:53
Returns: Transforms
concat
▸ concat(otherTransforms: IReadOnlyTransforms, target?: IReadOnlyTransforms): Transforms
Defined in src/util/Transforms.ts:36
Parameters:
| Name | Type |
|---|---|
otherTransforms |
IReadOnlyTransforms |
target? |
IReadOnlyTransforms |
Returns: Transforms
getGlobalToLocalMatrix
▸ getGlobalToLocalMatrix(): Matrix4
Defined in src/util/Transforms.ts:52
Returns: Matrix4
getPosition
▸ getPosition(target?: Vector3): Vector3
Defined in src/util/Transforms.ts:38
Parameters:
| Name | Type |
|---|---|
target? |
Vector3 |
Returns: Vector3
getRotation
▸ getRotation(target?: Quaternion): Quaternion
Defined in src/util/Transforms.ts:39
Parameters:
| Name | Type |
|---|---|
target? |
Quaternion |
Returns: Quaternion
isIdentityTransform
▸ isIdentityTransform(): boolean
Defined in src/util/Transforms.ts:55
Returns: boolean
mapGlobalDirectionToLocal
▸ mapGlobalDirectionToLocal(localDirection: Vector3, target?: Vector3): Vector3
Defined in src/util/Transforms.ts:48
Parameters:
| Name | Type |
|---|---|
localDirection |
Vector3 |
target? |
Vector3 |
Returns: Vector3
mapGlobalPlaneToLocal
▸ mapGlobalPlaneToLocal(plane: Plane, target?: Plane): Plane
Defined in src/util/Transforms.ts:50
Parameters:
| Name | Type |
|---|---|
plane |
Plane |
target? |
Plane |
Returns: Plane
mapGlobalPositionToLocal
▸ mapGlobalPositionToLocal(localPosition: ReadonlyVector3, target?: Vector3): Vector3
Defined in src/util/Transforms.ts:47
Parameters:
| Name | Type |
|---|---|
localPosition |
ReadonlyVector3 |
target? |
Vector3 |
Returns: Vector3
mapGlobalRotationToLocal
▸ mapGlobalRotationToLocal(localRotation: ReadonlyQuaternion, target?: Quaternion): Quaternion
Defined in src/util/Transforms.ts:49
Parameters:
| Name | Type |
|---|---|
localRotation |
ReadonlyQuaternion |
target? |
Quaternion |
Returns: Quaternion
mapLocalDirectionToGlobal
▸ mapLocalDirectionToGlobal(localDirection: ReadonlyVector3, target?: Vector3): Vector3
Defined in src/util/Transforms.ts:43
Parameters:
| Name | Type |
|---|---|
localDirection |
ReadonlyVector3 |
target? |
Vector3 |
Returns: Vector3
mapLocalPlaneToGlobal
▸ mapLocalPlaneToGlobal(plane: ReadonlyPlane, target?: Plane): Plane
Defined in src/util/Transforms.ts:45
Parameters:
| Name | Type |
|---|---|
plane |
ReadonlyPlane |
target? |
Plane |
Returns: Plane
mapLocalPosition2DToGlobal
▸ mapLocalPosition2DToGlobal(localPosition: ReadonlyVector2, target?: Vector3): Vector3
Defined in src/util/Transforms.ts:41
Parameters:
| Name | Type |
|---|---|
localPosition |
ReadonlyVector2 |
target? |
Vector3 |
Returns: Vector3
mapLocalPositionToGlobal
▸ mapLocalPositionToGlobal(localPosition: ReadonlyVector3, target?: Vector3): Vector3
Defined in src/util/Transforms.ts:42
Parameters:
| Name | Type |
|---|---|
localPosition |
ReadonlyVector3 |
target? |
Vector3 |
Returns: Vector3
mapLocalRotationToGlobal
▸ mapLocalRotationToGlobal(localRotation: ReadonlyQuaternion, target?: Quaternion): Quaternion
Defined in src/util/Transforms.ts:44
Parameters:
| Name | Type |
|---|---|
localRotation |
ReadonlyQuaternion |
target? |
Quaternion |
Returns: Quaternion