Space Engineers
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
VRageMath.BoundingFrustumD Class Reference

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

Inheritance diagram for VRageMath.BoundingFrustumD:

Public Member Functions

 BoundingFrustumD ()
 
 BoundingFrustumD (MatrixD value)
 Creates a new instance of BoundingFrustumD. More...
 
Vector3D[] GetCorners ()
 Gets an array of points that make up the corners of the BoundingFrustumD. ALLOCATION! More...
 
void GetCorners (Vector3D[] corners)
 Gets an array of points that make up the corners of the BoundingFrustumD. More...
 
unsafe void GetCornersUnsafe (Vector3D *corners)
 Gets the array of points that make up the corners of the BoundingBox. More...
 
bool Equals (BoundingFrustumD other)
 Determines whether the specified BoundingFrustumD is equal to the current BoundingFrustumD. More...
 
override bool Equals (object obj)
 Determines whether the specified Object is equal to the BoundingFrustumD. More...
 
override int GetHashCode ()
 Gets the hash code for this instance. More...
 
override string ToString ()
 Returns a String that represents the current BoundingFrustumD. More...
 
bool Intersects (BoundingBoxD box)
 Checks whether the current BoundingFrustumD intersects the specified BoundingBoxD. More...
 
void Intersects (ref BoundingBoxD box, out bool result)
 Checks whether the current BoundingFrustumD intersects a BoundingBoxD. More...
 
bool Intersects (BoundingFrustumD frustum)
 Checks whether the current BoundingFrustumD intersects the specified BoundingFrustumD. More...
 
PlaneIntersectionType Intersects (PlaneD plane)
 Checks whether the current BoundingFrustumD intersects the specified Plane. More...
 
void Intersects (ref PlaneD plane, out PlaneIntersectionType result)
 Checks whether the current BoundingFrustumD intersects a Plane. More...
 
double Intersects (RayD ray)
 Checks whether the current BoundingFrustumD intersects the specified Ray. More...
 
void Intersects (ref RayD ray, out double?result)
 Checks whether the current BoundingFrustumD intersects a Ray. More...
 
bool Intersects (BoundingSphereD sphere)
 Checks whether the current BoundingFrustumD intersects the specified BoundingSphere. More...
 
void Intersects (ref BoundingSphereD sphere, out bool result)
 Checks whether the current BoundingFrustumD intersects a BoundingSphere. More...
 
ContainmentType Contains (BoundingBoxD box)
 Checks whether the current BoundingFrustumD contains the specified BoundingBoxD. More...
 
void Contains (ref BoundingBoxD box, out ContainmentType result)
 Checks whether the current BoundingFrustumD contains the specified BoundingBoxD. More...
 
ContainmentType Contains (BoundingFrustumD frustum)
 Checks whether the current BoundingFrustumD contains the specified BoundingFrustumD. More...
 
ContainmentType Contains (Vector3D point)
 Checks whether the current BoundingFrustumD contains the specified point. More...
 
void Contains (ref Vector3D point, out ContainmentType result)
 Checks whether the current BoundingFrustumD contains the specified point. More...
 
ContainmentType Contains (BoundingSphereD sphere)
 Checks whether the current BoundingFrustumD contains the specified BoundingSphere. More...
 
void Contains (ref BoundingSphereD sphere, out ContainmentType result)
 Checks whether the current BoundingFrustumD contains the specified BoundingSphere. More...
 

Static Public Member Functions

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

Public Attributes

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

Properties

PlaneD this[int index] [get]
 
PlaneD Near [get]
 Gets the near plane of the BoundingFrustumD. More...
 
PlaneD Far [get]
 Gets the far plane of the BoundingFrustumD. More...
 
PlaneD Left [get]
 Gets the left plane of the BoundingFrustumD. More...
 
PlaneD Right [get]
 Gets the right plane of the BoundingFrustumD. More...
 
PlaneD Top [get]
 Gets the top plane of the BoundingFrustumD. More...
 
PlaneD Bottom [get]
 Gets the bottom plane of the BoundingFrustumD. More...
 
MatrixD 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 BoundingFrustumD.cs.

Constructor & Destructor Documentation

VRageMath.BoundingFrustumD.BoundingFrustumD ( )
inline

Definition at line 117 of file BoundingFrustumD.cs.

VRageMath.BoundingFrustumD.BoundingFrustumD ( MatrixD  value)
inline

Creates a new instance of BoundingFrustumD.

Parameters
valueCombined matrix that usually takes view × projection matrix.

Definition at line 125 of file BoundingFrustumD.cs.

Member Function Documentation

ContainmentType VRageMath.BoundingFrustumD.Contains ( BoundingBoxD  box)
inline

Checks whether the current BoundingFrustumD contains the specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to check against the current BoundingFrustumD.

Definition at line 550 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Contains ( ref BoundingBoxD  box,
out ContainmentType  result 
)
inline

Checks whether the current BoundingFrustumD contains the specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to test for overlap.
result[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 571 of file BoundingFrustumD.cs.

ContainmentType VRageMath.BoundingFrustumD.Contains ( BoundingFrustumD  frustum)
inline

Checks whether the current BoundingFrustumD contains the specified BoundingFrustumD.

Parameters
frustumThe BoundingFrustumD to check against the current BoundingFrustumD.

Definition at line 593 of file BoundingFrustumD.cs.

ContainmentType VRageMath.BoundingFrustumD.Contains ( Vector3D  point)
inline

Checks whether the current BoundingFrustumD contains the specified point.

Parameters
pointThe point to check against the current BoundingFrustumD.

Definition at line 617 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Contains ( ref Vector3D  point,
out ContainmentType  result 
)
inline

Checks whether the current BoundingFrustumD contains the specified point.

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

Definition at line 631 of file BoundingFrustumD.cs.

ContainmentType VRageMath.BoundingFrustumD.Contains ( BoundingSphereD  sphere)
inline

Checks whether the current BoundingFrustumD contains the specified BoundingSphere.

Parameters
sphereThe BoundingSphere to check against the current BoundingFrustumD.

Definition at line 648 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Contains ( ref BoundingSphereD  sphere,
out ContainmentType  result 
)
inline

Checks whether the current BoundingFrustumD contains the specified BoundingSphere.

Parameters
sphereThe BoundingSphere to test for overlap.
result[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 668 of file BoundingFrustumD.cs.

bool VRageMath.BoundingFrustumD.Equals ( BoundingFrustumD  other)
inline

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

Parameters
otherThe BoundingFrustumD to compare with the current BoundingFrustumD.

Definition at line 186 of file BoundingFrustumD.cs.

override bool VRageMath.BoundingFrustumD.Equals ( object  obj)
inline

Determines whether the specified Object is equal to the BoundingFrustumD.

Parameters
objThe Object to compare with the current BoundingFrustumD.

Definition at line 198 of file BoundingFrustumD.cs.

Vector3D [] VRageMath.BoundingFrustumD.GetCorners ( )
inline

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

Definition at line 151 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.GetCorners ( Vector3D[]  corners)
inline

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

Parameters
cornersAn existing array of at least 8 Vector3D points where the corners of the BoundingFrustumD are written.

Definition at line 160 of file BoundingFrustumD.cs.

unsafe void VRageMath.BoundingFrustumD.GetCornersUnsafe ( Vector3D corners)
inline

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

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

Definition at line 170 of file BoundingFrustumD.cs.

override int VRageMath.BoundingFrustumD.GetHashCode ( )
inline

Gets the hash code for this instance.

Definition at line 210 of file BoundingFrustumD.cs.

bool VRageMath.BoundingFrustumD.Intersects ( BoundingBoxD  box)
inline

Checks whether the current BoundingFrustumD intersects the specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to check for intersection.

Definition at line 289 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Intersects ( ref BoundingBoxD  box,
out bool  result 
)
inline

Checks whether the current BoundingFrustumD intersects a BoundingBoxD.

Parameters
boxThe BoundingBoxD to check for intersection with.
result[OutAttribute] true if the BoundingFrustumD and BoundingBoxD intersect; false otherwise.

Definition at line 300 of file BoundingFrustumD.cs.

bool VRageMath.BoundingFrustumD.Intersects ( BoundingFrustumD  frustum)
inline

Checks whether the current BoundingFrustumD intersects the specified BoundingFrustumD.

Parameters
frustumThe BoundingFrustumD to check for intersection.

Definition at line 342 of file BoundingFrustumD.cs.

PlaneIntersectionType VRageMath.BoundingFrustumD.Intersects ( PlaneD  plane)
inline

Checks whether the current BoundingFrustumD intersects the specified Plane.

Parameters
planeThe Plane to check for intersection.

Definition at line 385 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Intersects ( ref PlaneD  plane,
out PlaneIntersectionType  result 
)
inline

Checks whether the current BoundingFrustumD intersects a Plane.

Parameters
planeThe Plane to check for intersection with.
result[OutAttribute] An enumeration indicating whether the BoundingFrustumD intersects the Plane.

Definition at line 406 of file BoundingFrustumD.cs.

double VRageMath.BoundingFrustumD.Intersects ( RayD  ray)
inline

Checks whether the current BoundingFrustumD intersects the specified Ray.

Parameters
rayThe Ray to check for intersection.

Definition at line 430 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Intersects ( ref RayD  ray,
out double?  result 
)
inline

Checks whether the current BoundingFrustumD intersects a Ray.

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

Definition at line 441 of file BoundingFrustumD.cs.

bool VRageMath.BoundingFrustumD.Intersects ( BoundingSphereD  sphere)
inline

Checks whether the current BoundingFrustumD intersects the specified BoundingSphere.

Parameters
sphereThe BoundingSphere to check for intersection.

Definition at line 497 of file BoundingFrustumD.cs.

void VRageMath.BoundingFrustumD.Intersects ( ref BoundingSphereD  sphere,
out bool  result 
)
inline

Checks whether the current BoundingFrustumD intersects a BoundingSphere.

Parameters
sphereThe BoundingSphere to check for intersection with.
result[OutAttribute] true if the BoundingFrustumD and BoundingSphere intersect; false otherwise.

Definition at line 508 of file BoundingFrustumD.cs.

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

Determines whether two instances of BoundingFrustumD are not equal.

Parameters
aThe BoundingFrustumD to the left of the inequality operator.
bThe BoundingFrustumD to the right of the inequality operator.

Definition at line 143 of file BoundingFrustumD.cs.

static bool VRageMath.BoundingFrustumD.operator== ( BoundingFrustumD  a,
BoundingFrustumD  b 
)
inlinestatic

Determines whether two instances of BoundingFrustumD are equal.

Parameters
aThe BoundingFrustumD to the left of the equality operator.
bThe BoundingFrustumD to the right of the equality operator.

Definition at line 134 of file BoundingFrustumD.cs.

override string VRageMath.BoundingFrustumD.ToString ( )
inline

Returns a String that represents the current BoundingFrustumD.

Definition at line 218 of file BoundingFrustumD.cs.

Member Data Documentation

const int VRageMath.BoundingFrustumD.CornerCount = 8

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

Definition at line 17 of file BoundingFrustumD.cs.

Property Documentation

PlaneD VRageMath.BoundingFrustumD.Bottom
get

Gets the bottom plane of the BoundingFrustumD.

Definition at line 95 of file BoundingFrustumD.cs.

PlaneD VRageMath.BoundingFrustumD.Far
get

Gets the far plane of the BoundingFrustumD.

Definition at line 51 of file BoundingFrustumD.cs.

PlaneD VRageMath.BoundingFrustumD.Left
get

Gets the left plane of the BoundingFrustumD.

Definition at line 62 of file BoundingFrustumD.cs.

MatrixD VRageMath.BoundingFrustumD.Matrix
getset

Gets or sets the Matrix that describes this bounding frustum.

Definition at line 106 of file BoundingFrustumD.cs.

PlaneD VRageMath.BoundingFrustumD.Near
get

Gets the near plane of the BoundingFrustumD.

Definition at line 40 of file BoundingFrustumD.cs.

PlaneD VRageMath.BoundingFrustumD.Right
get

Gets the right plane of the BoundingFrustumD.

Definition at line 73 of file BoundingFrustumD.cs.

PlaneD VRageMath.BoundingFrustumD.this[int index]
get

Definition at line 29 of file BoundingFrustumD.cs.

PlaneD VRageMath.BoundingFrustumD.Top
get

Gets the top plane of the BoundingFrustumD.

Definition at line 84 of file BoundingFrustumD.cs.


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