Defines a frustum and helps determine whether forms intersect with it. More...

Inheritance diagram for VRageMath.BoundingFrustum:

Public Member Functions
	BoundingFrustum (Matrix value)
	Creates a new instance of BoundingFrustum. More...

Vector3[]	GetCorners ()
	Gets an array of points that make up the corners of the BoundingFrustum. ALLOCATION! More...

void	GetCorners (Vector3[] corners)
	Gets an array of points that make up the corners of the BoundingFrustum. More...

unsafe void	GetCornersUnsafe (Vector3 *corners)
	Gets the array of points that make up the corners of the BoundingBox. More...

bool	Equals (BoundingFrustum other)
	Determines whether the specified BoundingFrustum is equal to the current BoundingFrustum. More...

override bool	Equals (object obj)
	Determines whether the specified Object is equal to the BoundingFrustum. More...

override int	GetHashCode ()
	Gets the hash code for this instance. More...

override string	ToString ()
	Returns a String that represents the current BoundingFrustum. More...

bool	Intersects (BoundingBox box)
	Checks whether the current BoundingFrustum intersects the specified BoundingBox. More...

void	Intersects (ref BoundingBox box, out bool result)
	Checks whether the current BoundingFrustum intersects a BoundingBox. More...

bool	Intersects (BoundingFrustum frustum)
	Checks whether the current BoundingFrustum intersects the specified BoundingFrustum. More...

PlaneIntersectionType	Intersects (Plane plane)
	Checks whether the current BoundingFrustum intersects the specified Plane. More...

void	Intersects (ref Plane plane, out PlaneIntersectionType result)
	Checks whether the current BoundingFrustum intersects a Plane. More...

float	Intersects (Ray ray)
	Checks whether the current BoundingFrustum intersects the specified Ray. More...

void	Intersects (ref Ray ray, out float?result)
	Checks whether the current BoundingFrustum intersects a Ray. More...

bool	Intersects (BoundingSphere sphere)
	Checks whether the current BoundingFrustum intersects the specified BoundingSphere. More...

void	Intersects (ref BoundingSphere sphere, out bool result)
	Checks whether the current BoundingFrustum intersects a BoundingSphere. More...

ContainmentType	Contains (BoundingBox box)
	Checks whether the current BoundingFrustum contains the specified BoundingBox. More...

void	Contains (ref BoundingBox box, out ContainmentType result)
	Checks whether the current BoundingFrustum contains the specified BoundingBox. More...

ContainmentType	Contains (BoundingFrustum frustum)
	Checks whether the current BoundingFrustum contains the specified BoundingFrustum. More...

ContainmentType	Contains (Vector3 point)
	Checks whether the current BoundingFrustum contains the specified point. More...

void	Contains (ref Vector3 point, out ContainmentType result)
	Checks whether the current BoundingFrustum contains the specified point. More...

ContainmentType	Contains (BoundingSphere sphere)
	Checks whether the current BoundingFrustum contains the specified BoundingSphere. More...

void	Contains (ref BoundingSphere sphere, out ContainmentType result)
	Checks whether the current BoundingFrustum contains the specified BoundingSphere. More...

Static Public Member Functions
static bool	operator== (BoundingFrustum a, BoundingFrustum b)
	Determines whether two instances of BoundingFrustum are equal. More...

static bool	operator!= (BoundingFrustum a, BoundingFrustum b)
	Determines whether two instances of BoundingFrustum are not equal. More...

Public Attributes
const int	CornerCount = 8
	Specifies the total number of corners (8) in the BoundingFrustum. More...

Properties
Plane	this[int index] `[get]`

Plane	Near `[get]`
	Gets the near plane of the BoundingFrustum. More...

Plane	Far `[get]`
	Gets the far plane of the BoundingFrustum. More...

Plane	Left `[get]`
	Gets the left plane of the BoundingFrustum. More...

Plane	Right `[get]`
	Gets the right plane of the BoundingFrustum. More...

Plane	Top `[get]`
	Gets the top plane of the BoundingFrustum. More...

Plane	Bottom `[get]`
	Gets the bottom plane of the BoundingFrustum. More...

Matrix	Matrix `[get, set]`
	Gets or sets the Matrix that describes this bounding frustum. More...

Detailed Description

Defines a frustum and helps determine whether forms intersect with it.

Definition at line 10 of file BoundingFrustum.cs.

Constructor & Destructor Documentation

VRageMath.BoundingFrustum.BoundingFrustum ( Matrix value )

inline

Creates a new instance of BoundingFrustum.

Parameters

value Combined matrix that usually takes view × projection matrix.

Definition at line 125 of file BoundingFrustum.cs.

Member Function Documentation

ContainmentType VRageMath.BoundingFrustum.Contains ( BoundingBox box )

inline

Checks whether the current BoundingFrustum contains the specified BoundingBox.

Parameters

box	The BoundingBox to check against the current BoundingFrustum.

Definition at line 550 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Contains	(	ref BoundingBox	box,
		out ContainmentType	result
	)

inline

Checks whether the current BoundingFrustum contains the specified BoundingBox.

Parameters

box	The BoundingBox to test for overlap.
result	[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 571 of file BoundingFrustum.cs.

ContainmentType VRageMath.BoundingFrustum.Contains ( BoundingFrustum frustum )

inline

Checks whether the current BoundingFrustum contains the specified BoundingFrustum.

Parameters

frustum The BoundingFrustum to check against the current BoundingFrustum.

Definition at line 593 of file BoundingFrustum.cs.

ContainmentType VRageMath.BoundingFrustum.Contains ( Vector3 point )

inline

Checks whether the current BoundingFrustum contains the specified point.

Parameters

point The point to check against the current BoundingFrustum.

Definition at line 617 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Contains	(	ref Vector3	point,
		out ContainmentType	result
	)

inline

Checks whether the current BoundingFrustum contains the specified point.

Parameters

point	The point to test for overlap.
result	[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 631 of file BoundingFrustum.cs.

ContainmentType VRageMath.BoundingFrustum.Contains ( BoundingSphere sphere )

inline

Checks whether the current BoundingFrustum contains the specified BoundingSphere.

Parameters

sphere The BoundingSphere to check against the current BoundingFrustum.

Definition at line 648 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Contains	(	ref BoundingSphere	sphere,
		out ContainmentType	result
	)

inline

Checks whether the current BoundingFrustum contains the specified BoundingSphere.

Parameters

sphere	The BoundingSphere to test for overlap.
result	[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 668 of file BoundingFrustum.cs.

bool VRageMath.BoundingFrustum.Equals ( BoundingFrustum other )

inline

Determines whether the specified BoundingFrustum is equal to the current BoundingFrustum.

Parameters

other The BoundingFrustum to compare with the current BoundingFrustum.

Definition at line 186 of file BoundingFrustum.cs.

override bool VRageMath.BoundingFrustum.Equals ( object obj )

inline

Determines whether the specified Object is equal to the BoundingFrustum.

Parameters

obj	The Object to compare with the current BoundingFrustum.

Definition at line 198 of file BoundingFrustum.cs.

Vector3 [] VRageMath.BoundingFrustum.GetCorners ( )

inline

Gets an array of points that make up the corners of the BoundingFrustum. ALLOCATION!

Definition at line 151 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.GetCorners ( Vector3[] corners )

inline

Gets an array of points that make up the corners of the BoundingFrustum.

Parameters

corners An existing array of at least 8 Vector3 points where the corners of the BoundingFrustum are written.

Definition at line 160 of file BoundingFrustum.cs.

unsafe void VRageMath.BoundingFrustum.GetCornersUnsafe ( Vector3 * corners )

inline

Gets the array of points that make up the corners of the BoundingBox.

Parameters

corners An existing array of at least 8 Vector3 points where the corners of the BoundingBox are written.

Definition at line 170 of file BoundingFrustum.cs.

override int VRageMath.BoundingFrustum.GetHashCode ( )

inline

Gets the hash code for this instance.

Definition at line 210 of file BoundingFrustum.cs.

bool VRageMath.BoundingFrustum.Intersects ( BoundingBox box )

inline

Checks whether the current BoundingFrustum intersects the specified BoundingBox.

Parameters

box	The BoundingBox to check for intersection.

Definition at line 289 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Intersects	(	ref BoundingBox	box,
		out bool	result
	)

inline

Checks whether the current BoundingFrustum intersects a BoundingBox.

Parameters

box	The BoundingBox to check for intersection with.
result	[OutAttribute] true if the BoundingFrustum and BoundingBox intersect; false otherwise.

Definition at line 300 of file BoundingFrustum.cs.

bool VRageMath.BoundingFrustum.Intersects ( BoundingFrustum frustum )

inline

Checks whether the current BoundingFrustum intersects the specified BoundingFrustum.

Parameters

frustum The BoundingFrustum to check for intersection.

Definition at line 342 of file BoundingFrustum.cs.

PlaneIntersectionType VRageMath.BoundingFrustum.Intersects ( Plane plane )

inline

Checks whether the current BoundingFrustum intersects the specified Plane.

Parameters

plane The Plane to check for intersection.

Definition at line 385 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Intersects	(	ref Plane	plane,
		out PlaneIntersectionType	result
	)

inline

Checks whether the current BoundingFrustum intersects a Plane.

Parameters

plane	The Plane to check for intersection with.
result	[OutAttribute] An enumeration indicating whether the BoundingFrustum intersects the Plane.

Definition at line 406 of file BoundingFrustum.cs.

float VRageMath.BoundingFrustum.Intersects ( Ray ray )

inline

Checks whether the current BoundingFrustum intersects the specified Ray.

Parameters

ray	The Ray to check for intersection.

Definition at line 430 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Intersects	(	ref Ray	ray,
		out float?	result
	)

inline

Checks whether the current BoundingFrustum intersects a Ray.

Parameters

ray	The Ray to check for intersection with.
result	[OutAttribute] Distance at which the ray intersects the BoundingFrustum or null if there is no intersection.

Definition at line 441 of file BoundingFrustum.cs.

bool VRageMath.BoundingFrustum.Intersects ( BoundingSphere sphere )

inline

Checks whether the current BoundingFrustum intersects the specified BoundingSphere.

Parameters

sphere The BoundingSphere to check for intersection.

Definition at line 497 of file BoundingFrustum.cs.

void VRageMath.BoundingFrustum.Intersects	(	ref BoundingSphere	sphere,
		out bool	result
	)

inline

Checks whether the current BoundingFrustum intersects a BoundingSphere.

Parameters

sphere	The BoundingSphere to check for intersection with.
result	[OutAttribute] true if the BoundingFrustum and BoundingSphere intersect; false otherwise.

Definition at line 508 of file BoundingFrustum.cs.

static bool VRageMath.BoundingFrustum.operator!=	(	BoundingFrustum	a,
		BoundingFrustum	b
	)

inlinestatic

Determines whether two instances of BoundingFrustum are not equal.

Parameters

a	The BoundingFrustum to the left of the inequality operator.
b	The BoundingFrustum to the right of the inequality operator.

Definition at line 143 of file BoundingFrustum.cs.

static bool VRageMath.BoundingFrustum.operator==	(	BoundingFrustum	a,
		BoundingFrustum	b
	)

inlinestatic

Determines whether two instances of BoundingFrustum are equal.

Parameters

a	The BoundingFrustum to the left of the equality operator.
b	The BoundingFrustum to the right of the equality operator.

Definition at line 134 of file BoundingFrustum.cs.

override string VRageMath.BoundingFrustum.ToString ( )

inline

Returns a String that represents the current BoundingFrustum.

Definition at line 218 of file BoundingFrustum.cs.

Member Data Documentation

const int VRageMath.BoundingFrustum.CornerCount = 8

Specifies the total number of corners (8) in the BoundingFrustum.

Definition at line 17 of file BoundingFrustum.cs.

Property Documentation

Plane VRageMath.BoundingFrustum.Bottom

get

Gets the bottom plane of the BoundingFrustum.

Definition at line 95 of file BoundingFrustum.cs.

Plane VRageMath.BoundingFrustum.Far

get

Gets the far plane of the BoundingFrustum.

Definition at line 51 of file BoundingFrustum.cs.

Plane VRageMath.BoundingFrustum.Left

get

Gets the left plane of the BoundingFrustum.

Definition at line 62 of file BoundingFrustum.cs.

Matrix VRageMath.BoundingFrustum.Matrix

getset

Gets or sets the Matrix that describes this bounding frustum.

Definition at line 106 of file BoundingFrustum.cs.

Plane VRageMath.BoundingFrustum.Near

get

Gets the near plane of the BoundingFrustum.

Definition at line 40 of file BoundingFrustum.cs.

Plane VRageMath.BoundingFrustum.Right

get

Gets the right plane of the BoundingFrustum.

Definition at line 73 of file BoundingFrustum.cs.

Plane VRageMath.BoundingFrustum.this[int index]

get

Definition at line 29 of file BoundingFrustum.cs.

Plane VRageMath.BoundingFrustum.Top

get

Gets the top plane of the BoundingFrustum.

Definition at line 84 of file BoundingFrustum.cs.

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

Sources/VRage.Math/BoundingFrustum.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation