Frustum (Nu)

Frustum Type

Namespace: System.Numerics
Assembly: Nu.Math.dll
Base Type: obj
All Interfaces: IEquatable<Frustum>

Defines a viewing frustum for intersection operations. Copied from - https://github.com/MonoGame/MonoGame/blob/v3.8/MonoGame.Framework/BoundingFrustum.cs

Constructors

Constructor	Description
`Frustum(value)` Full Usage: `Frustum(value)` Parameters: value : `Matrix4x4` - Combined matrix which usually is (View * Projection).	Constructs the frustum by extracting the view planes from a matrix. value : `Matrix4x4` Combined matrix which usually is (View * Projection).

Instance members

Instance member	Description
`this.Bottom` Full Usage: `this.Bottom` Returns: `Plane3`	Gets the bottom plane of the frustum. Returns: `Plane3`
`this.Bounds` Full Usage: `this.Bounds` Returns: `Box3`	The axis-aligned bounding box enclosing the frustum. Returns: `Box3`
`this.Contains` Full Usage: `this.Contains` Parameters: box : `Box3` - A Box3 for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Box3.	Containment test between this Frustum and specified Box3. box : `Box3` A Box3 for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Box3.
`this.Contains` Full Usage: `this.Contains` Parameters: box : `inref<Box3>` - A Box3 for testing. result : `byref<ContainmentType>` - Result of testing for containment between this Frustum and specified Box3 as an output parameter.	Containment test between this Frustum and specified Box3. box : `inref<Box3>` A Box3 for testing. result : `byref<ContainmentType>` Result of testing for containment between this Frustum and specified Box3 as an output parameter.
`this.Contains` Full Usage: `this.Contains` Parameters: frustum : `Frustum` - A Frustum for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Frustum.	Containment test between this Frustum and specified Frustum. frustum : `Frustum` A Frustum for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Frustum.
`this.Contains` Full Usage: `this.Contains` Parameters: sphere : `Sphere` - A Sphere for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Sphere.	Containment test between this Frustum and specified Sphere. sphere : `Sphere` A Sphere for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Sphere.
`this.Contains` Full Usage: `this.Contains` Parameters: sphere : `inref<Sphere>` - A Sphere for testing. result : `byref<ContainmentType>` - Result of testing for containment between this Frustum and specified Sphere as an output parameter.	Containment test between this Frustum and specified Sphere. sphere : `inref<Sphere>` A Sphere for testing. result : `byref<ContainmentType>` Result of testing for containment between this Frustum and specified Sphere as an output parameter.
`this.Contains` Full Usage: `this.Contains` Parameters: point : `Vector3` - A Vector3 for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Vector3.	Containment test between this Frustum and specified Vector3. point : `Vector3` A Vector3 for testing. Returns: `ContainmentType` Result of testing for containment between this Frustum and specified Vector3.
`this.Contains` Full Usage: `this.Contains` Parameters: point : `inref<Vector3>` - A Vector3 for testing. result : `byref<ContainmentType>` - Result of testing for containment between this Frustum and specified Vector3 as an output parameter.	Containment test between this Frustum and specified Vector3. point : `inref<Vector3>` A Vector3 for testing. result : `byref<ContainmentType>` Result of testing for containment between this Frustum and specified Vector3 as an output parameter.
`this.Corners` Full Usage: `this.Corners` Returns: `Vector3[]` The array of corners.	Returns a copy of internal corners array. Returns: `Vector3[]` The array of corners.
`this.Equals` Full Usage: `this.Equals` Parameters: other : `Frustum` - The Frustum to compare. Returns: `bool` `true` if the instances are equal; `false` otherwise. Modifiers: abstract	Compares whether current instance is equal to specified Frustum. other : `Frustum` The Frustum to compare. Returns: `bool` `true` if the instances are equal; `false` otherwise.
`this.Equals` Full Usage: `this.Equals` Parameters: obj : `obj` - The Object to compare. Returns: `bool` `true` if the instances are equal; `false` otherwise. Modifiers: abstract	Compares whether current instance is equal to specified Frustum. obj : `obj` The Object to compare. Returns: `bool` `true` if the instances are equal; `false` otherwise.
`this.Far` Full Usage: `this.Far` Returns: `Plane3`	Gets the far plane of the frustum. Returns: `Plane3`
`this.GetCorners` Full Usage: `this.GetCorners` Parameters: corners : `Vector3[]` - The array which values will be replaced to corner values of this instance. It must have size of Frustum.CornerCount.	Returns a copy of internal corners array. corners : `Vector3[]` The array which values will be replaced to corner values of this instance. It must have size of Frustum.CornerCount.
`this.GetHashCode` Full Usage: `this.GetHashCode` Returns: `int` Hash code of this Frustum. Modifiers: abstract	Gets the hash code of this Frustum. Returns: `int` Hash code of this Frustum.
`this.Intersects` Full Usage: `this.Intersects` Parameters: box : `Box3` - A Box3 for intersection test. Returns: `bool` `true` if specified Box3 intersects with this Frustum; `false` otherwise.	Gets whether or not a specified Box3 intersects with this Frustum. box : `Box3` A Box3 for intersection test. Returns: `bool` `true` if specified Box3 intersects with this Frustum; `false` otherwise.
`this.Intersects` Full Usage: `this.Intersects` Parameters: box : `inref<Box3>` - A Box3 for intersection test. result : `byref<bool>` - `true` if specified Box3 intersects with this Frustum; `false` otherwise as an output parameter.	Gets whether or not a specified Box3 intersects with this Frustum. box : `inref<Box3>` A Box3 for intersection test. result : `byref<bool>` `true` if specified Box3 intersects with this Frustum; `false` otherwise as an output parameter.
`this.Intersects` Full Usage: `this.Intersects` Parameters: frustum : `Frustum` - An other Frustum for intersection test. Returns: `bool` `true` if other Frustum intersects with this Frustum; `false` otherwise.	Gets whether or not a specified Frustum intersects with this Frustum. frustum : `Frustum` An other Frustum for intersection test. Returns: `bool` `true` if other Frustum intersects with this Frustum; `false` otherwise.
`this.Intersects` Full Usage: `this.Intersects` Parameters: sphere : `Sphere` - A Sphere for intersection test. Returns: `bool` `true` if specified Sphere intersects with this Frustum; `false` otherwise.	Gets whether or not a specified Sphere intersects with this Frustum. sphere : `Sphere` A Sphere for intersection test. Returns: `bool` `true` if specified Sphere intersects with this Frustum; `false` otherwise.
`this.Intersects` Full Usage: `this.Intersects` Parameters: sphere : `inref<Sphere>` - A Sphere for intersection test. result : `byref<bool>` - `true` if specified Sphere intersects with this Frustum; `false` otherwise as an output parameter.	Gets whether or not a specified Sphere intersects with this Frustum. sphere : `inref<Sphere>` A Sphere for intersection test. result : `byref<bool>` `true` if specified Sphere intersects with this Frustum; `false` otherwise as an output parameter.
`this.Intersects` Full Usage: `this.Intersects` Parameters: plane : `Plane3` - A Plane3 for intersection test. Returns: `PlaneIntersectionType` A plane intersection type.	Gets type of intersection between specified Plane3 and this Frustum. plane : `Plane3` A Plane3 for intersection test. Returns: `PlaneIntersectionType` A plane intersection type.
`this.Intersects` Full Usage: `this.Intersects` Parameters: plane : `inref<Plane3>` - A Plane3 for intersection test. result : `byref<PlaneIntersectionType>` - A plane intersection type as an output parameter.	Gets type of intersection between specified Plane3 and this Frustum. plane : `inref<Plane3>` A Plane3 for intersection test. result : `byref<PlaneIntersectionType>` A plane intersection type as an output parameter.
`this.Intersects` Full Usage: `this.Intersects` Parameters: ray : `Ray3` - A Ray3 for intersection test. Returns: `Nullable<float32>` Distance at which ray intersects with this Frustum or null if no intersection happens.	Gets the distance of intersection of Ray3 and this Frustum or null if no intersection happens. ray : `Ray3` A Ray3 for intersection test. Returns: `Nullable<float32>` Distance at which ray intersects with this Frustum or null if no intersection happens.
`this.Intersects` Full Usage: `this.Intersects` Parameters: ray : `inref<Ray3>` - A Ray3 for intersection test. result : `byref<Nullable<float32>>` - Distance at which ray intersects with this Frustum or null if no intersection happens as an output parameter.	Gets the distance of intersection of Ray3 and this Frustum or null if no intersection happens. ray : `inref<Ray3>` A Ray3 for intersection test. result : `byref<Nullable<float32>>` Distance at which ray intersects with this Frustum or null if no intersection happens as an output parameter.
`this.Left` Full Usage: `this.Left` Returns: `Plane3`	Gets the left plane of the frustum. Returns: `Plane3`
`this.Matrix` Full Usage: `this.Matrix`	Gets or sets the Matrix4x4 of the frustum.
`this.Near` Full Usage: `this.Near` Returns: `Plane3`	Gets the near plane of the frustum. Returns: `Plane3`
`this.Right` Full Usage: `this.Right` Returns: `Plane3`	Gets the right plane of the frustum. Returns: `Plane3`
`this.Segments` Full Usage: `this.Segments` Returns: `Segment3[]`	Returns: `Segment3[]`
`this.ToString` Full Usage: `this.ToString` Returns: `string` String representation of this Frustum. Modifiers: abstract	Returns a String representation of this Frustum in the format: {Near:[nearPlane] Far:[farPlane] Left:[leftPlane] Right:[rightPlane] Top:[topPlane] Bottom:[bottomPlane]} Returns: `string` String representation of this Frustum.
`this.Top` Full Usage: `this.Top` Returns: `Plane3`	Gets the top plane of the frustum. Returns: `Plane3`

Static members

Static member	Description
`a <> b` Full Usage: `a <> b` Parameters: a : `Frustum` - Frustum instance on the left of the not equal sign. b : `Frustum` - Frustum instance on the right of the not equal sign. Returns: `bool` `true` if the instances are not equal; `false` otherwise.	Compares whether two Frustum instances are not equal. a : `Frustum` Frustum instance on the left of the not equal sign. b : `Frustum` Frustum instance on the right of the not equal sign. Returns: `bool` `true` if the instances are not equal; `false` otherwise.
`a = b` Full Usage: `a = b` Parameters: a : `Frustum` - Frustum instance on the left of the equal sign. b : `Frustum` - Frustum instance on the right of the equal sign. Returns: `bool` `true` if the instances are equal; `false` otherwise.	Compares whether two Frustum instances are equal. a : `Frustum` Frustum instance on the left of the equal sign. b : `Frustum` Frustum instance on the right of the equal sign. Returns: `bool` `true` if the instances are equal; `false` otherwise.