7.0 KiB
Planck.js API Doc › Globals › Rot
Class: Rot
Hierarchy
- Rot
Index
Constructors
Properties
Methods
- getAngle
- getXAxis
- getYAxis
- set
- setAngle
- setIdentity
- assert
- clone
- identity
- isValid
- mul
- mulRot
- mulSub
- mulT
- mulTRot
- mulTVec2
- mulVec2
Constructors
constructor
+ new Rot(angle?: number | Rot): Rot
Defined in src/common/Rot.ts:36
Initialize from an angle in radians.
Parameters:
| Name | Type |
|---|---|
angle? |
number | Rot |
Returns: Rot
Properties
c
• c: number
Defined in src/common/Rot.ts:36
s
• s: number
Defined in src/common/Rot.ts:35
Methods
getAngle
▸ getAngle(): number
Defined in src/common/Rot.ts:115
Get the angle in radians.
Returns: number
getXAxis
▸ getXAxis(): Vec2
Defined in src/common/Rot.ts:120
Get the x-axis.
Returns: Vec2
getYAxis
▸ getYAxis(): Vec2
Defined in src/common/Rot.ts:125
Get the u-axis.
Returns: Vec2
set
▸ set(angle: number | Rot): void
Defined in src/common/Rot.ts:92
Parameters:
| Name | Type |
|---|---|
angle |
number | Rot |
Returns: void
setAngle
▸ setAngle(angle: number): void
Defined in src/common/Rot.ts:107
Set using an angle in radians.
Parameters:
| Name | Type |
|---|---|
angle |
number |
Returns: void
setIdentity
▸ setIdentity(): void
Defined in src/common/Rot.ts:87
Set to the identity rotation.
Returns: void
Static assert
▸ assert(o: any): void
Defined in src/common/Rot.ts:78
Parameters:
| Name | Type |
|---|---|
o |
any |
Returns: void
Static clone
Defined in src/common/Rot.ts:59
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
Returns: Rot
Static identity
▸ identity(): Rot
Defined in src/common/Rot.ts:67
Returns: Rot
Static isValid
▸ isValid(o: any): boolean
Defined in src/common/Rot.ts:74
Parameters:
| Name | Type |
|---|---|
o |
any |
Returns: boolean
Static mul
Defined in src/common/Rot.ts:130
Multiply two rotations: q * r
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Rot |
Returns: Rot
▸ mul(rot: Rot, m: Vec2): Vec2
Defined in src/common/Rot.ts:132
Rotate a vector
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Vec2 |
Returns: Vec2
Static mulRot
▸ mulRot(rot: Rot, m: Rot): Rot
Defined in src/common/Rot.ts:153
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Rot |
Returns: Rot
Static mulSub
▸ mulSub(rot: Rot, v: Vec2, w: Vec2): Vec2
Defined in src/common/Rot.ts:172
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
v |
Vec2 |
w |
Vec2 |
Returns: Vec2
Static mulT
Defined in src/common/Rot.ts:179
Transpose multiply two rotations: qT * r
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Rot |
Returns: Rot
▸ mulT(rot: Rot, m: Vec2): Vec2
Defined in src/common/Rot.ts:181
Inverse rotate a vector
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Vec2 |
Returns: Vec2
Static mulTRot
▸ mulTRot(rot: Rot, m: Rot): Rot
Defined in src/common/Rot.ts:201
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Rot |
Returns: Rot
Static mulTVec2
▸ mulTVec2(rot: Rot, m: Vec2): Vec2
Defined in src/common/Rot.ts:213
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Vec2 |
Returns: Vec2
Static mulVec2
▸ mulVec2(rot: Rot, m: Vec2): Vec2
Defined in src/common/Rot.ts:166
Parameters:
| Name | Type |
|---|---|
rot |
Rot |
m |
Vec2 |
Returns: Vec2