Class BoundingFrustum

Represents a bounding frustum.

Inheritance

object

BoundingFrustum

Implements

IEquatable<BoundingFrustum>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Evergine.Mathematics

Assembly: Evergine.Mathematics.dll

Syntax

public class BoundingFrustum : IEquatable<BoundingFrustum>

Constructors

BoundingFrustum(Matrix4x4)

Initializes a new instance of the BoundingFrustum class.

Declaration

public BoundingFrustum(Matrix4x4 value)

Parameters

Type	Name	Description
Matrix4x4	value	The value.

Fields

CornerCount

Number of corners.

Declaration

public const int CornerCount = 8

Field Value

Type	Description
int

Properties

Bottom

Gets the bottom.

Declaration

public Plane Bottom { get; }

Property Value

Type	Description
Plane

Far

Gets the far.

Declaration

public Plane Far { get; }

Property Value

Type	Description
Plane

Left

Gets the left.

Declaration

public Plane Left { get; }

Property Value

Type	Description
Plane

Matrix

Gets or sets the matrix.

Declaration

public Matrix4x4 Matrix { get; set; }

Property Value

Type	Description
Matrix4x4	The matrix.

Near

Gets the near.

Declaration

public Plane Near { get; }

Property Value

Type	Description
Plane

Right

Gets the right.

Declaration

public Plane Right { get; }

Property Value

Type	Description
Plane

Top

Gets the top.

Declaration

public Plane Top { get; }

Property Value

Type	Description
Plane

Methods

Contains(BoundingBox)

Determines whether [contains] [the specified box].

Declaration

public ContainmentType Contains(BoundingBox box)

Parameters

Type	Name	Description
BoundingBox	box	The box.

Returns

Type	Description
ContainmentType	The result.

Contains(ref BoundingBox, out ContainmentType)

Determines whether [contains] [the specified box].

Declaration

public void Contains(ref BoundingBox box, out ContainmentType result)

Parameters

Type	Name	Description
BoundingBox	box	The box.
ContainmentType	result	The result.

Contains(BoundingFrustum)

Determines whether [contains] [the specified frustum].

Declaration

public ContainmentType Contains(BoundingFrustum frustum)

Parameters

Type	Name	Description
BoundingFrustum	frustum	The frustum.

Returns

Type	Description
ContainmentType	The result.

Contains(BoundingSphere)

Determines whether [contains] [the specified sphere].

Declaration

public ContainmentType Contains(BoundingSphere sphere)

Parameters

Type	Name	Description
BoundingSphere	sphere	The sphere.

Returns

Type	Description
ContainmentType	The result.

Contains(ref BoundingSphere, out ContainmentType)

Determines whether [contains] [the specified sphere].

Declaration

public void Contains(ref BoundingSphere sphere, out ContainmentType result)

Parameters

Type	Name	Description
BoundingSphere	sphere	The sphere.
ContainmentType	result	The result.

Contains(Vector3)

Determines whether [contains] [the specified point].

Declaration

public ContainmentType Contains(Vector3 point)

Parameters

Type	Name	Description
Vector3	point	The point.

Returns

Type	Description
ContainmentType	The result.

Contains(ref Vector3, out ContainmentType)

Determines whether [contains] [the specified point].

Declaration

public void Contains(ref Vector3 point, out ContainmentType result)

Parameters

Type	Name	Description
Vector3	point	The point.
ContainmentType	result	The result.

Equals(BoundingFrustum)

Equalses the specified other.

Declaration

public bool Equals(BoundingFrustum other)

Parameters

Type	Name	Description
BoundingFrustum	other	The other.

Returns

Type	Description
bool	The result.

Equals(object)

Determines whether the specified object is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	`true` if the specified object is equal to this instance; otherwise, `false`.

Overrides

object.Equals(object)

GetCorners()

Gets the corners.

Declaration

public Vector3[] GetCorners()

Returns

Type	Description
Vector3[]	The result.

GetCorners(Vector3*)

Gets the corners.

Declaration

public void GetCorners(Vector3* result)

Parameters

Type	Name	Description
Vector3*	result	The result.

GetCorners(Vector3[])

Gets the corners.

Declaration

public void GetCorners(Vector3[] result)

Parameters

Type	Name	Description
Vector3[]	result	The result.

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

object.GetHashCode()

Intersects(BoundingBox, bool)

Intersects the specified box.

Declaration

public bool Intersects(BoundingBox box, bool disableNearPlane = false)

Parameters

Type	Name	Description
BoundingBox	box	The box.
bool	disableNearPlane	Bool indicates the near plane doesn't check the collision.

Returns

Type	Description
bool	The result.

Intersects(ref BoundingBox, out bool, bool)

Intersects the specified box.

Declaration

public void Intersects(ref BoundingBox box, out bool result, bool disableNearPlane = false)

Parameters

Type	Name	Description
BoundingBox	box	The box.
bool	result	if set to `true` [result].
bool	disableNearPlane	Bool indicates the near plane doesn't check the collision.

Intersects(BoundingFrustum)

Intersects the specified frustum.

Declaration

public bool Intersects(BoundingFrustum frustum)

Parameters

Type	Name	Description
BoundingFrustum	frustum	The frustum.

Returns

Type	Description
bool	The result.

Intersects(BoundingSphere)

Intersects the specified sphere.

Declaration

public bool Intersects(BoundingSphere sphere)

Parameters

Type	Name	Description
BoundingSphere	sphere	The sphere.

Returns

Type	Description
bool	The result.

Intersects(ref BoundingSphere, out bool)

Intersects the specified sphere.

Declaration

public void Intersects(ref BoundingSphere sphere, out bool result)

Parameters

Type	Name	Description
BoundingSphere	sphere	The sphere.
bool	result	if set to `true` [result].

Intersects(Plane)

Intersects the specified plane.

Declaration

public PlaneIntersectionType Intersects(Plane plane)

Parameters

Type	Name	Description
Plane	plane	The plane.

Returns

Type	Description
PlaneIntersectionType	The result.

Intersects(ref Plane, out PlaneIntersectionType)

Intersects the specified plane.

Declaration

public void Intersects(ref Plane plane, out PlaneIntersectionType result)

Parameters

Type	Name	Description
Plane	plane	The plane.
PlaneIntersectionType	result	The result.

Intersects(Ray)

Intersects the specified ray.

Declaration

public float? Intersects(Ray ray)

Parameters

Type	Name	Description
Ray	ray	The ray.

Returns

Type	Description
float?	The result.

Intersects(ref Ray, out float?)

Intersects the specified ray.

Declaration

public void Intersects(ref Ray ray, out float? result)

Parameters

Type	Name	Description
Ray	ray	The ray.
float?	result	The result.

SetMatrix(ref Matrix4x4)

Sets the matrix.

Declaration

public void SetMatrix(ref Matrix4x4 value)

Parameters

Type	Name	Description
Matrix4x4	value	The value.

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.