AABB¶
Category: Built-In Types
Brief Description¶
Axis-Aligned Bounding Box.
Member Functions¶
AABB | AABB ( Vector3 position, Vector3 size ) |
bool | encloses ( AABB with ) |
AABB | expand ( Vector3 to_point ) |
float | get_area ( ) |
Vector3 | get_endpoint ( int idx ) |
Vector3 | get_longest_axis ( ) |
int | get_longest_axis_index ( ) |
float | get_longest_axis_size ( ) |
Vector3 | get_shortest_axis ( ) |
int | get_shortest_axis_index ( ) |
float | get_shortest_axis_size ( ) |
Vector3 | get_support ( Vector3 dir ) |
AABB | grow ( float by ) |
bool | has_no_area ( ) |
bool | has_no_surface ( ) |
bool | has_point ( Vector3 point ) |
AABB | intersection ( AABB with ) |
bool | intersects ( AABB with ) |
bool | intersects_plane ( Plane plane ) |
bool | intersects_segment ( Vector3 from, Vector3 to ) |
AABB | merge ( AABB with ) |
Member Variables¶
Description¶
AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
Member Function Description¶
Optional constructor, accepts position and size.
Returns true
if this AABB
completely encloses another one.
Returns this AABB
expanded to include a given point.
- float get_area ( )
Gets the area of the AABB
.
Gets the position of the 8 endpoints of the AABB
in space.
- Vector3 get_longest_axis ( )
Returns the normalized longest axis of the AABB
.
- int get_longest_axis_index ( )
Returns the index of the longest axis of the AABB
(according to Vector3::AXIS* enum).
- float get_longest_axis_size ( )
Returns the scalar length of the longest axis of the AABB
.
- Vector3 get_shortest_axis ( )
Returns the normalized shortest axis of the AABB
.
- int get_shortest_axis_index ( )
Returns the index of the shortest axis of the AABB
(according to Vector3::AXIS* enum).
- float get_shortest_axis_size ( )
Returns the scalar length of the shortest axis of the AABB
.
Returns the support point in a given direction. This is useful for collision detection algorithms.
Returns a copy of the AABB
grown a given amount of units towards all the sides.
- bool has_no_area ( )
Returns true
if the AABB
is flat or empty.
- bool has_no_surface ( )
Returns true
if the AABB
is empty.
Returns true
if the AABB
contains a point.
Returns the intersection between two AABB
. An empty AABB (size 0,0,0) is returned on failure.
Returns true
if the AABB
overlaps with another.
Returns true
if the AABB
is on both sides of a plane.
Returns true
if the AABB
intersects the line segment between from
and to
.
Returns a larger AABB that contains this AABB and with
.