BoundingFrustum

class BoundingFrustum : System.Object, System.IEquatable<BoundingFrustum>

Defines a viewing frustum for intersection operations.

int PlaneCount

The number of planes in the frustum.

int CornerCount

The number of corner points in the frustum.

Matrix Matrix

Gets or sets the P:Microsoft.Xna.Framework.BoundingFrustum.Matrix of the frustum.

readonly Plane Near

Gets the near plane of the frustum.

readonly Plane Far

Gets the far plane of the frustum.

readonly Plane Left

Gets the left plane of the frustum.

readonly Plane Right

Gets the right plane of the frustum.

readonly Plane Top

Gets the top plane of the frustum.

readonly Plane Bottom

Gets the bottom plane of the frustum.

string get_DebugDisplayString()
public bool op_Equality(BoundingFrustum a, BoundingFrustum b)

Compares whether two T:Microsoft.Xna.Framework.BoundingFrustum instances are equal.

Parameters:
  • a (Microsoft.Xna.Framework.BoundingFrustum) – T:Microsoft.Xna.Framework.BoundingFrustum instance on the left of the equal sign.
  • b (Microsoft.Xna.Framework.BoundingFrustum) – T:Microsoft.Xna.Framework.BoundingFrustum instance on the right of the equal sign.
Returns:

true if the instances are equal; false otherwise.
public bool op_Inequality(BoundingFrustum a, BoundingFrustum b)

Compares whether two T:Microsoft.Xna.Framework.BoundingFrustum instances are not equal.

Parameters:
  • a (Microsoft.Xna.Framework.BoundingFrustum) – T:Microsoft.Xna.Framework.BoundingFrustum instance on the left of the not equal sign.
  • b (Microsoft.Xna.Framework.BoundingFrustum) – T:Microsoft.Xna.Framework.BoundingFrustum instance on the right of the not equal sign.
Returns:

true if the instances are not equal; false otherwise.
public ContainmentType Contains(BoundingBox box)

Containment test between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.BoundingBox.

Parameters:
  • box (Microsoft.Xna.Framework.BoundingBox) – A T:Microsoft.Xna.Framework.BoundingBox for testing.
Returns:

Result of testing for containment between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.BoundingBox.
public void Contains(ref BoundingBox box, ref ContainmentType result)
Parameters:
  • (ref) box (Microsoft.Xna.Framework.BoundingBox) –
  • (ref) result (Microsoft.Xna.Framework.ContainmentType) –
public ContainmentType Contains(BoundingFrustum frustum)

Containment test between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • frustum (Microsoft.Xna.Framework.BoundingFrustum) – A T:Microsoft.Xna.Framework.BoundingFrustum for testing.
Returns:

Result of testing for containment between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.BoundingFrustum.
public ContainmentType Contains(BoundingSphere sphere)

Containment test between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.BoundingSphere.

Parameters:
  • sphere (Microsoft.Xna.Framework.BoundingSphere) – A T:Microsoft.Xna.Framework.BoundingSphere for testing.
Returns:

Result of testing for containment between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.BoundingSphere.
public void Contains(ref BoundingSphere sphere, ref ContainmentType result)
Parameters:
  • (ref) sphere (Microsoft.Xna.Framework.BoundingSphere) –
  • (ref) result (Microsoft.Xna.Framework.ContainmentType) –
public ContainmentType Contains(Vector3 point)

Containment test between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.Vector3.

Parameters:
  • point (Microsoft.Xna.Framework.Vector3) – A T:Microsoft.Xna.Framework.Vector3 for testing.
Returns:

Result of testing for containment between this T:Microsoft.Xna.Framework.BoundingFrustum and specified T:Microsoft.Xna.Framework.Vector3.
public void Contains(ref Vector3 point, ref ContainmentType result)
Parameters:
  • (ref) point (Microsoft.Xna.Framework.Vector3) –
  • (ref) result (Microsoft.Xna.Framework.ContainmentType) –
public bool Equals(BoundingFrustum other)

Compares whether current instance is equal to specified T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • other (Microsoft.Xna.Framework.BoundingFrustum) – The T:Microsoft.Xna.Framework.BoundingFrustum to compare.
Returns:

true if the instances are equal; false otherwise.
public bool Equals(System.Object obj)

Compares whether current instance is equal to specified T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • obj (System.Object) – The T:System.Object to compare.
Returns:

true if the instances are equal; false otherwise.
public Microsoft.Xna.Framework.Vector3[] GetCorners()

Returns a copy of internal corners array.

Returns:The array of corners.
public void GetCorners(Microsoft.Xna.Framework.Vector3[] corners)

Returns a copy of internal corners array.

Parameters:
  • corners (Microsoft.Xna.Framework.Vector3[]) – The array which values will be replaced to corner values of this instance. It must have size of F:Microsoft.Xna.Framework.BoundingFrustum.CornerCount.
public int GetHashCode()

Gets the hash code of this T:Microsoft.Xna.Framework.BoundingFrustum.

Returns:Hash code of this T:Microsoft.Xna.Framework.BoundingFrustum.
public bool Intersects(BoundingBox box)

Gets whether or not a specified T:Microsoft.Xna.Framework.BoundingBox intersects with this T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • box (Microsoft.Xna.Framework.BoundingBox) – A T:Microsoft.Xna.Framework.BoundingBox for intersection test.
Returns:

true if specified T:Microsoft.Xna.Framework.BoundingBox intersects with this T:Microsoft.Xna.Framework.BoundingFrustum; false otherwise.
public void Intersects(ref BoundingBox box, ref bool result)
Parameters:
  • (ref) box (Microsoft.Xna.Framework.BoundingBox) –
  • (ref) result (bool) –
public bool Intersects(BoundingFrustum frustum)

Gets whether or not a specified T:Microsoft.Xna.Framework.BoundingFrustum intersects with this T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • frustum (Microsoft.Xna.Framework.BoundingFrustum) – An other T:Microsoft.Xna.Framework.BoundingFrustum for intersection test.
Returns:

true if other T:Microsoft.Xna.Framework.BoundingFrustum intersects with this T:Microsoft.Xna.Framework.BoundingFrustum; false otherwise.
public bool Intersects(BoundingSphere sphere)

Gets whether or not a specified T:Microsoft.Xna.Framework.BoundingSphere intersects with this T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • sphere (Microsoft.Xna.Framework.BoundingSphere) – A T:Microsoft.Xna.Framework.BoundingSphere for intersection test.
Returns:

true if specified T:Microsoft.Xna.Framework.BoundingSphere intersects with this T:Microsoft.Xna.Framework.BoundingFrustum; false otherwise.
public void Intersects(ref BoundingSphere sphere, ref bool result)
Parameters:
  • (ref) sphere (Microsoft.Xna.Framework.BoundingSphere) –
  • (ref) result (bool) –
public PlaneIntersectionType Intersects(Plane plane)

Gets type of intersection between specified T:Microsoft.Xna.Framework.Plane and this T:Microsoft.Xna.Framework.BoundingFrustum.

Parameters:
  • plane (Microsoft.Xna.Framework.Plane) – A T:Microsoft.Xna.Framework.Plane for intersection test.
Returns:

A plane intersection type.
public void Intersects(ref Plane plane, ref PlaneIntersectionType result)
Parameters:
  • (ref) plane (Microsoft.Xna.Framework.Plane) –
  • (ref) result (Microsoft.Xna.Framework.PlaneIntersectionType) –
public System.Nullable<Single> Intersects(Ray ray)

Gets the distance of intersection of T:Microsoft.Xna.Framework.Ray and this T:Microsoft.Xna.Framework.BoundingFrustum or null if no intersection happens.

Parameters:
  • ray (Microsoft.Xna.Framework.Ray) – A T:Microsoft.Xna.Framework.Ray for intersection test.
Returns:

Distance at which ray intersects with this T:Microsoft.Xna.Framework.BoundingFrustum or null if no intersection happens.
public void Intersects(ref Ray ray, ref System.Nullable<Single> result)
Parameters:
  • (ref) ray (Microsoft.Xna.Framework.Ray) –
  • (ref) result (System.Nullable<Single>) –
public string ToString()

Returns a T:System.String representation of this T:Microsoft.Xna.Framework.BoundingFrustum in the format: {Near:[nearPlane] Far:[farPlane] Left:[leftPlane] Right:[rightPlane] Top:[topPlane] Bottom:[bottomPlane]}

Returns:T:System.String representation of this T:Microsoft.Xna.Framework.BoundingFrustum.