7.5 KiB
Planck.js API Doc › Globals › Transform
Class: Transform
A transform contains translation and rotation. It is used to represent the position and orientation of rigid frames. Initialize using a position vector and a rotation.
Hierarchy
- Transform
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Transform(position?: Vec2, rotation?: number): Transform
Defined in src/common/Transform.ts:44
Parameters:
| Name | Type |
|---|---|
position? |
Vec2 |
rotation? |
number |
Returns: Transform
Properties
p
• p: Vec2
Defined in src/common/Transform.ts:41
position
q
• q: Rot
Defined in src/common/Transform.ts:44
rotation
Methods
set
▸ set(position: Vec2, rotation: number): void
Defined in src/common/Transform.ts:90
Set this based on the position and angle.
Parameters:
| Name | Type |
|---|---|
position |
Vec2 |
rotation |
number |
Returns: void
▸ set(xf: Transform): void
Defined in src/common/Transform.ts:91
Set this based on the position and angle.
Parameters:
| Name | Type |
|---|---|
xf |
Transform |
Returns: void
setIdentity
▸ setIdentity(): void
Defined in src/common/Transform.ts:85
Set this to the identity transform.
Returns: void
Static assert
▸ assert(o: any): void
Defined in src/common/Transform.ts:110
Parameters:
| Name | Type |
|---|---|
o |
any |
Returns: void
Static clone
▸ clone(xf: Transform): Transform
Defined in src/common/Transform.ts:60
Parameters:
| Name | Type |
|---|---|
xf |
Transform |
Returns: Transform
Static identity
▸ identity(): Transform
Defined in src/common/Transform.ts:75
Returns: Transform
Static isValid
▸ isValid(o: any): boolean
Defined in src/common/Transform.ts:106
Parameters:
| Name | Type |
|---|---|
o |
any |
Returns: boolean
Static mul
▸ mul(a: Transform, b: Vec2): Vec2
Defined in src/common/Transform.ts:118
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Vec2 |
Returns: Vec2
▸ mul(a: Transform, b: Transform): Transform
Defined in src/common/Transform.ts:119
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Transform |
Returns: Transform
Static mulAll
▸ mulAll(a: Transform, b: Vec2[]): Vec2[]
Defined in src/common/Transform.ts:140
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Vec2[] |
Returns: Vec2[]
▸ mulAll(a: Transform, b: Transform[]): Transform[]
Defined in src/common/Transform.ts:141
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Transform[] |
Returns: Transform[]
Static mulT
▸ mulT(a: Transform, b: Vec2): Vec2
Defined in src/common/Transform.ts:180
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Vec2 |
Returns: Vec2
▸ mulT(a: Transform, b: Transform): Transform
Defined in src/common/Transform.ts:181
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Transform |
Returns: Transform
Static mulTVec2
▸ mulTVec2(a: Transform, b: Vec2): Vec2
Defined in src/common/Transform.ts:192
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Vec2 |
Returns: Vec2
Static mulTXf
▸ mulTXf(a: Transform, b: Transform): Transform
Defined in src/common/Transform.ts:202
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Transform |
Returns: Transform
Static mulVec2
▸ mulVec2(a: Transform, b: Vec2): Vec2
Defined in src/common/Transform.ts:161
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Vec2 |
Returns: Vec2
Static mulXf
▸ mulXf(a: Transform, b: Transform): Transform
Defined in src/common/Transform.ts:169
Parameters:
| Name | Type |
|---|---|
a |
Transform |
b |
Transform |
Returns: Transform