Mathf.Plane Struct Reference

Inherits IEquatable< Plane >.

Public Member Functions
	Plane (Vector4 value)
	Plane (Vector3 normal, float d)
	Plane (Vector3 a, Vector3 b, Vector3 c)
	Plane (float a, float b, float c, float d)
	Plane (Vector3 pointOnPlane, Vector3 normal)
	Create a Plane that contains the specified point and has the specified Normal vector.
float	Dot (Vector4 value)
void	Dot (ref Vector4 value, out float result)
float	DotCoordinate (Vector3 value)
void	DotCoordinate (ref Vector3 value, out float result)
float	DotNormal (Vector3 value)
void	DotNormal (ref Vector3 value, out float result)
void	Normalize ()
override bool	Equals (object other)
bool	Equals (Plane other)
override int	GetHashCode ()
PlaneIntersectionType	Intersects (BoundingBox box)
void	Intersects (ref BoundingBox box, out PlaneIntersectionType result)
PlaneIntersectionType	Intersects (BoundingFrustum frustum)
PlaneIntersectionType	Intersects (BoundingSphere sphere)
void	Intersects (ref BoundingSphere sphere, out PlaneIntersectionType result)
override string	ToString ()
void	Deconstruct (out Vector3 normal, out float d)
	Deconstruction method for Plane.

Static Public Member Functions
static Plane	Transform (Plane plane, Matrix matrix)
	Transforms a normalized plane by a matrix.
static void	Transform (ref Plane plane, ref Matrix matrix, out Plane result)
	Transforms a normalized plane by a matrix.
static Plane	Transform (Plane plane, Quaternion rotation)
	Transforms a normalized plane by a quaternion rotation.
static void	Transform (ref Plane plane, ref Quaternion rotation, out Plane result)
	Transforms a normalized plane by a quaternion rotation.
static Plane	Normalize (Plane value)
static void	Normalize (ref Plane value, out Plane result)
static bool	operator!= (Plane plane1, Plane plane2)
static bool	operator== (Plane plane1, Plane plane2)

Public Attributes
float	D
Vector3	Normal

Package Functions
PlaneIntersectionType	Intersects (ref Vector3 point)

Properties
string	DebugDisplayString [get]

Constructor & Destructor Documentation

Plane() [1/5]

Mathf.Plane.Plane ( Vector4 value )

inline

Plane() [2/5]

Mathf.Plane.Plane ( Vector3 normal, float d )

inline

Plane() [3/5]

Mathf.Plane.Plane ( Vector3 a, Vector3 b, Vector3 c )

inline

Plane() [4/5]

Mathf.Plane.Plane ( float a, float b, float c, float d )

inline

Plane() [5/5]

Mathf.Plane.Plane ( Vector3 pointOnPlane, Vector3 normal )

inline

Create a Plane that contains the specified point and has the specified Normal vector.

Parameters

pointOnPlane	A point the created Plane should contain.
normal	The normal of the plane.

Member Function Documentation

Deconstruct()

void Mathf.Plane.Deconstruct ( out Vector3 normal, out float d )

inline

Deconstruction method for Plane.

Parameters

normal
d

Dot() [1/2]

void Mathf.Plane.Dot ( ref Vector4 value, out float result )

inline

Dot() [2/2]

float Mathf.Plane.Dot ( Vector4 value )

inline

DotCoordinate() [1/2]

void Mathf.Plane.DotCoordinate ( ref Vector3 value, out float result )

inline

DotCoordinate() [2/2]

float Mathf.Plane.DotCoordinate ( Vector3 value )

inline

DotNormal() [1/2]

void Mathf.Plane.DotNormal ( ref Vector3 value, out float result )

inline

DotNormal() [2/2]

float Mathf.Plane.DotNormal ( Vector3 value )

inline

Equals() [1/2]

override bool Mathf.Plane.Equals ( object other )

inline

Equals() [2/2]

bool Mathf.Plane.Equals ( Plane other )

inline

GetHashCode()

override int Mathf.Plane.GetHashCode ( )

inline

Intersects() [1/6]

PlaneIntersectionType Mathf.Plane.Intersects ( BoundingBox box )

inline

Intersects() [2/6]

PlaneIntersectionType Mathf.Plane.Intersects ( BoundingFrustum frustum )

inline

Intersects() [3/6]

PlaneIntersectionType Mathf.Plane.Intersects ( BoundingSphere sphere )

inline

Intersects() [4/6]

void Mathf.Plane.Intersects ( ref BoundingBox box, out PlaneIntersectionType result )

inline

Intersects() [5/6]

void Mathf.Plane.Intersects ( ref BoundingSphere sphere, out PlaneIntersectionType result )

inline

Intersects() [6/6]

PlaneIntersectionType Mathf.Plane.Intersects ( ref Vector3 point )

inlinepackage

Normalize() [1/3]

void Mathf.Plane.Normalize ( )

inline

Normalize() [2/3]

static Plane Mathf.Plane.Normalize ( Plane value )

inlinestatic

Normalize() [3/3]

static void Mathf.Plane.Normalize ( ref Plane value, out Plane result )

inlinestatic

operator!=()

static bool Mathf.Plane.operator!= ( Plane plane1, Plane plane2 )

inlinestatic

operator==()

static bool Mathf.Plane.operator== ( Plane plane1, Plane plane2 )

inlinestatic

ToString()

override string Mathf.Plane.ToString ( )

inline

Transform() [1/4]

static Plane Mathf.Plane.Transform ( Plane plane, Matrix matrix )

inlinestatic

Transforms a normalized plane by a matrix.

Parameters

plane	The normalized plane to transform.
matrix	The transformation matrix.

Returns

The transformed plane.

Transform() [2/4]

static Plane Mathf.Plane.Transform ( Plane plane, Quaternion rotation )

inlinestatic

Transforms a normalized plane by a quaternion rotation.

Parameters

plane	The normalized plane to transform.
rotation	The quaternion rotation.

Returns

The transformed plane.

Transform() [3/4]

static void Mathf.Plane.Transform ( ref Plane plane, ref Matrix matrix, out Plane result )

inlinestatic

Transforms a normalized plane by a matrix.

Parameters

plane	The normalized plane to transform.
matrix	The transformation matrix.
result	The transformed plane.

Transform() [4/4]

static void Mathf.Plane.Transform ( ref Plane plane, ref Quaternion rotation, out Plane result )

inlinestatic

Transforms a normalized plane by a quaternion rotation.

Parameters

plane	The normalized plane to transform.
rotation	The quaternion rotation.
result	The transformed plane.

Member Data Documentation

D

float Mathf.Plane.D

Normal

Vector3 Mathf.Plane.Normal

Property Documentation

DebugDisplayString

string Mathf.Plane.DebugDisplayString

getpackage

---

The documentation for this struct was generated from the following file:

• /github/workspace/code/addons/nsharp/NebulaEngine/xna/Plane.cs