class_aabb

AABB

Category: Built-In Types\

Brief Description

Axis-Aligned Bounding Box.

Member Functions

• bool #encloses( AABB with )
• AABB #expand( Vector3 to_point )
• real #get_area(****)
• Vector3 #get_endpoint( int idx )
• Vector3 #get_longest_axis(****)
• int #get_longest_axis_index(****)
• real #get_longest_axis_size(****)
• Vector3 #get_shortest_axis(****)
• int #get_shortest_axis_index(****)
• real #get_shortest_axis_size(****)
• Vector3 #get_support( Vector3 dir )
• AABB #grow( real 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 )
• AABB #merge( AABB with )
• void #AABB( Vector3 pos, Vector3 size )

Member Variables

• Vector3 pos
• Vector3 size
• Vector3 end

Description

AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position and a size, and several utility functions. It is typically used for simple (fast) overlap tests.

Member Function Description

== encloses ==

• bool #encloses( AABB with ) \ Return true if this aabb completely encloses another one. == expand ==
• AABB #expand( Vector3 to_point ) \ Return this aabb expanded to include a given point. == get_area ==
• real #get_area(****) \ Get the area inside the aabb == get_endpoint ==
• Vector3 #get_endpoint( int idx ) \ Get the position of the 8 endpoints of the aabb in space. == get_longest_axis ==
• Vector3 #get_longest_axis(****) \ Return the normalized longest axis of the aabb == get_longest_axis_index ==
• int #get_longest_axis_index(****) \ Return the index of the longest axis of the aabb (according to vector3::AXIS* enum). == get_longest_axis_size ==
• real #get_longest_axis_size(****) \ Return the scalar length of the longest axis of the aabb. == get_shortest_axis ==
• Vector3 #get_shortest_axis(****) \ Return the normalized shortest axis of the aabb == get_shortest_axis_index ==
• int #get_shortest_axis_index(****) \ Return the index of the shortest axis of the aabb (according to vector3::AXIS* enum). == get_shortest_axis_size ==
• real #get_shortest_axis_size(****) \ Return the scalar length of the shortest axis of the aabb. == get_support ==
• Vector3 #get_support( Vector3 dir ) \ Return the support point in a given direction. This is useful for collision detection algorithms. == grow ==
• AABB #grow( real by ) \ Return a copy of the AABB grown a given a mount of units towards all the sides. == has_no_area ==
• bool #has_no_area(****) \ Return true if the aabb is flat or empty. == has_no_surface ==
• bool #has_no_surface(****) \ Return true if the aabb is empty. == has_point ==
• bool #has_point( Vector3 point ) \ Return true if the aabb contains a point. == intersection ==
• AABB #intersection( AABB with ) \ Return the intersection between two aabbs. An empty AABB (size 0,0,0) is returned on failure. == intersects ==
• bool #intersects( AABB with ) \ Return true if the aabb overlaps with another. == intersects_plane ==
• bool #intersects_plane( Plane plane ) \ Return true if the AABB is at both sides of a plane. == merge ==
• AABB #merge( AABB with ) \ Combine this aabb with another one, a larger one is returned that contains both. == AABB ==
• void #AABB( Vector3 pos, Vector3 size ) \ Optional constructor, accepts position and size.