Rect3

Category: Built-In Types

Brief Description

Axis-Aligned Bounding Box.

Member Functions

Rect3	Rect3 ( Vector3 pos, Vector3 size )
bool	encloses ( Rect3 with )
Rect3	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 )
Rect3	grow ( float by )
bool	has_no_area ( )
bool	has_no_surface ( )
bool	has_point ( Vector3 point )
Rect3	intersection ( Rect3 with )
bool	intersects ( Rect3 with )
bool	intersects_plane ( Plane plane )
bool	intersects_segment ( Vector3 from, Vector3 to )
Rect3	merge ( Rect3 with )

Member Variables

• Vector3 end - Ending corner.
• Vector3 position
• Vector3 size - Size from position to end.

Description

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

Member Function Description

• Rect3 Rect3 ( Vector3 pos, Vector3 size )

Optional constructor, accepts position and size.

• bool encloses ( Rect3 with )

Return true if this Rect3 completely encloses another one.

• Rect3 expand ( Vector3 to_point )

Return this Rect3 expanded to include a given point.

• float get_area ( )

Get the area of the Rect3.

• Vector3 get_endpoint ( int idx )

Get the position of the 8 endpoints of the Rect3 in space.

• Vector3 get_longest_axis ( )

Return the normalized longest axis of the Rect3.

• int get_longest_axis_index ( )

Return the index of the longest axis of the Rect3 (according to Vector3::AXIS* enum).

• float get_longest_axis_size ( )

Return the scalar length of the longest axis of the Rect3.

• Vector3 get_shortest_axis ( )

Return the normalized shortest axis of the Rect3.

• int get_shortest_axis_index ( )

Return the index of the shortest axis of the Rect3 (according to Vector3::AXIS* enum).

• float get_shortest_axis_size ( )

Return the scalar length of the shortest axis of the Rect3.

• Vector3 get_support ( Vector3 dir )

Return the support point in a given direction. This is useful for collision detection algorithms.

• Rect3 grow ( float by )

Return a copy of the Rect3 grown a given amount of units towards all the sides.

• bool has_no_area ( )

Return true if the Rect3 is flat or empty.

• bool has_no_surface ( )

Return true if the Rect3 is empty.

• bool has_point ( Vector3 point )

Return true if the Rect3 contains a point.

• Rect3 intersection ( Rect3 with )

Return the intersection between two Rect3. An empty Rect3 (size 0,0,0) is returned on failure.

• bool intersects ( Rect3 with )

Return true if the Rect3 overlaps with another.

• bool intersects_plane ( Plane plane )

Return true if the Rect3 is at both sides of a plane.

• bool intersects_segment ( Vector3 from, Vector3 to )

Return true if the Rect3 intersects the line segment between from and to

• Rect3 merge ( Rect3 with )

Combine this Rect3 with another, a larger one is returned that contains both.