6.5 KiB
Planck.js API Doc › Globals › AABB
Class: AABB
Hierarchy
- AABB
Index
Constructors
Properties
Methods
- combine
- combinePoints
- contains
- extend
- getCenter
- getExtents
- getPerimeter
- isValid
- rayCast
- set
- toString
- areEqual
- assert
- diff
- extend
- isValid
- testOverlap
Constructors
constructor
+ new AABB(lower?: Vec2, upper?: Vec2): AABB
Defined in src/collision/AABB.ts:56
Parameters:
| Name | Type |
|---|---|
lower? |
Vec2 |
upper? |
Vec2 |
Returns: AABB
Properties
lowerBound
• lowerBound: Vec2
Defined in src/collision/AABB.ts:55
upperBound
• upperBound: Vec2
Defined in src/collision/AABB.ts:56
Methods
combine
▸ combine(a: AABB, b?: AABB): void
Defined in src/collision/AABB.ts:121
Combine one or two AABB into this one.
Parameters:
| Name | Type |
|---|---|
a |
AABB |
b? |
AABB |
Returns: void
combinePoints
▸ combinePoints(a: Vec2, b: Vec2): void
Defined in src/collision/AABB.ts:138
Parameters:
| Name | Type |
|---|---|
a |
Vec2 |
b |
Vec2 |
Returns: void
contains
▸ contains(aabb: AABB): boolean
Defined in src/collision/AABB.ts:148
Parameters:
| Name | Type |
|---|---|
aabb |
AABB |
Returns: boolean
extend
▸ extend(value: number): AABB
Defined in src/collision/AABB.ts:157
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: AABB
getCenter
▸ getCenter(): Vec2
Defined in src/collision/AABB.ts:100
Get the center of the AABB.
Returns: Vec2
getExtents
▸ getExtents(): Vec2
Defined in src/collision/AABB.ts:107
Get the extents of the AABB (half-widths).
Returns: Vec2
getPerimeter
▸ getPerimeter(): number
Defined in src/collision/AABB.ts:114
Get the perimeter length.
Returns: number
isValid
▸ isValid(): boolean
Defined in src/collision/AABB.ts:79
Verify that the bounds are sorted.
Returns: boolean
rayCast
▸ rayCast(output: RayCastOutput, input: RayCastInput): boolean
Defined in src/collision/AABB.ts:199
Parameters:
| Name | Type |
|---|---|
output |
RayCastOutput |
input |
RayCastInput |
Returns: boolean
set
▸ set(aabb: AABB): void
Defined in src/collision/AABB.ts:143
Parameters:
| Name | Type |
|---|---|
aabb |
AABB |
Returns: void
toString
▸ toString(): string
Defined in src/collision/AABB.ts:260
Returns: string
Static areEqual
▸ areEqual(a: AABB, b: AABB): boolean
Defined in src/collision/AABB.ts:182
Parameters:
| Name | Type |
|---|---|
a |
AABB |
b |
AABB |
Returns: boolean
Static assert
▸ assert(o: any): void
Defined in src/collision/AABB.ts:89
Parameters:
| Name | Type |
|---|---|
o |
any |
Returns: void
Static diff
▸ diff(a: AABB, b: AABB): number
Defined in src/collision/AABB.ts:186
Parameters:
| Name | Type |
|---|---|
a |
AABB |
b |
AABB |
Returns: number
Static extend
▸ extend(aabb: AABB, value: number): void
Defined in src/collision/AABB.ts:162
Parameters:
| Name | Type |
|---|---|
aabb |
AABB |
value |
number |
Returns: void
Static isValid
▸ isValid(aabb: any): boolean
Defined in src/collision/AABB.ts:83
Parameters:
| Name | Type |
|---|---|
aabb |
any |
Returns: boolean
Static testOverlap
▸ testOverlap(a: AABB, b: AABB): boolean
Defined in src/collision/AABB.ts:169
Parameters:
| Name | Type |
|---|---|
a |
AABB |
b |
AABB |
Returns: boolean