Plane

####Category: Built-In Types

Brief Description

Plane in hessian form.

Member Functions

• Vector3 center ( )
• float distance_to ( Vector3 point )
• Vector3 get_any_point ( )
• bool has_point ( Vector3 point, float epsilon=0.00001 )
• Vector3 intersect_3 ( Plane b, Plane c )
• Vector3 intersects_ray ( Vector3 from, Vector3 dir )
• Vector3 intersects_segment ( Vector3 begin, Vector3 end )
• bool is_point_over ( Vector3 point )
• Plane normalized ( )
• Vector3 project ( Vector3 point )
• void Plane ( float a, float b, float c, float d )
• void Plane ( Vector3 v1, Vector3 v2, Vector3 v3 )
• void Plane ( Vector3 normal, float d )

Member Variables

• Vector3 normal
• float x
• float y
• float z
• float d

Description

Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.

Member Function Description

has_point

• bool has_point ( Vector3 point, float epsilon=0.00001 )

Returns true if "p" is inside the plane (by a very minimum treshold).

intersect_3

• Vector3 intersect_3 ( Plane b, Plane c )

Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r".

intersects_ray

• Vector3 intersects_ray ( Vector3 from, Vector3 dir )

Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r".

intersects_segment

• Vector3 intersects_segment ( Vector3 begin, Vector3 end )

Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r".

is_point_over

• bool is_point_over ( Vector3 point )

Returns true if "p" is located above the plane.

normalized

• Plane normalized ( )

Returns a copy of the plane, normalized.

project

• Vector3 project ( Vector3 point )

Returns the orthogonal projection of point "p" into a point in the plane.