C# Class Axiom.Math.Plane

Show file Open project: WolfgangSt/axiom Class Usage Examples

Public Properties

Property Type Description
D Real
Normal Axiom.Math.Vector3

Public Methods

Method Description
Equals ( object obj ) : bool

Object method for testing equality.
GetDistance ( Axiom.Math.Vector3 point ) : Real

This is a pseudodistance. The sign of the return value is positive if the point is on the positive side of the plane, negative if the point is on the negative side, and zero if the point is on the plane. The absolute value of the return value is the true distance only when the plane normal is a unit length vector.
GetHashCode ( ) : int

Gets the hashcode for this Plane.
GetSide ( AxisAlignedBox box ) : PlaneSide

Returns the side where the aligneBox is. the flag Both indicates an intersecting box. one corner ON the plane is sufficient to consider the box and the plane intersecting.
GetSide ( Axiom.Math.Vector3 point ) : PlaneSide

GetSide ( Axiom.Math.Vector3 centre, Axiom.Math.Vector3 halfSize ) : PlaneSide

Returns which side of the plane that the given box lies on. The box is defined as centre/half-size pairs for effectively.
Plane ( Plane plane ) : System.Runtime.InteropServices
Plane ( Axiom.Math.Vector3 normal, Real constant ) : System.Runtime.InteropServices

Construct a plane through a normal, and a distance to move the plane along the normal.
Plane ( Axiom.Math.Vector3 normal, Axiom.Math.Vector3 point ) : System.Runtime.InteropServices
Plane ( Axiom.Math.Vector3 point0, Axiom.Math.Vector3 point1, Axiom.Math.Vector3 point2 ) : System.Runtime.InteropServices

Construct a plane from 3 coplanar points.
ProjectVector ( Axiom.Math.Vector3 point ) : Axiom.Math.Vector3

Project a point onto the plane.
Redefine ( Axiom.Math.Vector3 rkNormal, Axiom.Math.Vector3 rkPoint ) : void

Redefine this plane based on a normal and a point.
Redefine ( Axiom.Math.Vector3 point0, Axiom.Math.Vector3 point1, Axiom.Math.Vector3 point2 ) : void

Construct a plane from 3 coplanar points.
ToString ( ) : string

Returns a string representation of this Plane.
operator ( ) : bool

Compares 2 Planes for equality.

Method Details

Equals() public method

Object method for testing equality.
public Equals ( object obj ) : bool
obj object Object to test.
return bool

GetDistance() public method

This is a pseudodistance. The sign of the return value is positive if the point is on the positive side of the plane, negative if the point is on the negative side, and zero if the point is on the plane. The absolute value of the return value is the true distance only when the plane normal is a unit length vector.
public GetDistance ( Axiom.Math.Vector3 point ) : Real
point Axiom.Math.Vector3
return Real

GetHashCode() public method

Gets the hashcode for this Plane.
public GetHashCode ( ) : int
return int

GetSide() public method

Returns the side where the aligneBox is. the flag Both indicates an intersecting box. one corner ON the plane is sufficient to consider the box and the plane intersecting.
public GetSide ( AxisAlignedBox box ) : PlaneSide
box AxisAlignedBox
return PlaneSide

GetSide() public method

public GetSide ( Axiom.Math.Vector3 point ) : PlaneSide
point Axiom.Math.Vector3
return PlaneSide

GetSide() public method

Returns which side of the plane that the given box lies on. The box is defined as centre/half-size pairs for effectively.
public GetSide ( Axiom.Math.Vector3 centre, Axiom.Math.Vector3 halfSize ) : PlaneSide
centre Axiom.Math.Vector3 The centre of the box.
halfSize Axiom.Math.Vector3 The half-size of the box.
return PlaneSide

Plane() public method

public Plane ( Plane plane ) : System.Runtime.InteropServices
plane Plane
return System.Runtime.InteropServices

Plane() public method

Construct a plane through a normal, and a distance to move the plane along the normal.
public Plane ( Axiom.Math.Vector3 normal, Real constant ) : System.Runtime.InteropServices
normal Axiom.Math.Vector3
constant Real
return System.Runtime.InteropServices

Plane() public method

public Plane ( Axiom.Math.Vector3 normal, Axiom.Math.Vector3 point ) : System.Runtime.InteropServices
normal Axiom.Math.Vector3
point Axiom.Math.Vector3
return System.Runtime.InteropServices

Plane() public method

Construct a plane from 3 coplanar points.
public Plane ( Axiom.Math.Vector3 point0, Axiom.Math.Vector3 point1, Axiom.Math.Vector3 point2 ) : System.Runtime.InteropServices
point0 Axiom.Math.Vector3 First point.
point1 Axiom.Math.Vector3 Second point.
point2 Axiom.Math.Vector3 Third point.
return System.Runtime.InteropServices

ProjectVector() public method

Project a point onto the plane.
public ProjectVector ( Axiom.Math.Vector3 point ) : Axiom.Math.Vector3
point Axiom.Math.Vector3
return Axiom.Math.Vector3

Redefine() public method

Redefine this plane based on a normal and a point.
public Redefine ( Axiom.Math.Vector3 rkNormal, Axiom.Math.Vector3 rkPoint ) : void
rkNormal Axiom.Math.Vector3 Normal vector
rkPoint Axiom.Math.Vector3 Point vector
return void

Redefine() public method

Construct a plane from 3 coplanar points.
public Redefine ( Axiom.Math.Vector3 point0, Axiom.Math.Vector3 point1, Axiom.Math.Vector3 point2 ) : void
point0 Axiom.Math.Vector3 First point.
point1 Axiom.Math.Vector3 Second point.
point2 Axiom.Math.Vector3 Third point.
return void

ToString() public method

Returns a string representation of this Plane.
public ToString ( ) : string
return string

operator() public static method

Compares 2 Planes for equality.
public static operator ( ) : bool
return bool

Property Details

D public property

Distance from the origin.
public Real D
return Real

Normal public property

Direction the plane is facing.
public Vector3,Axiom.Math Normal
return Axiom.Math.Vector3