Plane3 (Nu) | Nu

Plane3 Type

Namespace: System.Numerics
Assembly: Nu.Math.dll
Base Type: ValueType
All Interfaces: IEquatable<Plane3>
Kind: Struct

A plane in 3d space, represented by its normal away from the origin and its distance from the origin, D. Copied from - https://github.com/MonoGame/MonoGame/blob/v3.8/MonoGame.Framework/Ray.cs

Constructors

Constructor	Description
`Plane3(value)` Full Usage: `Plane3(value)` Parameters: value : `Vector4` - A vector holding the normal and distance to origin.	Create a Plane3 with the first three components of the specified Vector4 as the normal and the last component as the distance to the origin. value : `Vector4` A vector holding the normal and distance to origin.
`Plane3(normal, d)` Full Usage: `Plane3(normal, d)` Parameters: normal : `Vector3` - The normal of the plane. d : `float32` - The distance to the origin.	Create a Plane3 with the specified normal and distance to the origin. normal : `Vector3` The normal of the plane. d : `float32` The distance to the origin.
`Plane3(a, b, c)` Full Usage: `Plane3(a, b, c)` Parameters: a : `Vector3` - A point the created Plane3 should contain. b : `Vector3` - A point the created Plane3 should contain. c : `Vector3` - A point the created Plane3 should contain.	Create the Plane3 that contains the three specified points. a : `Vector3` A point the created Plane3 should contain. b : `Vector3` A point the created Plane3 should contain. c : `Vector3` A point the created Plane3 should contain.
`Plane3(a, b, c, d)` Full Usage: `Plane3(a, b, c, d)` Parameters: a : `float32` - The X component of the normal. b : `float32` - The Y component of the normal. c : `float32` - The Z component of the normal. d : `float32` - The distance to the origin.	Create a Plane3 with the first three values as the X, Y and Z components of the normal and the last value as the distance to the origin. a : `float32` The X component of the normal. b : `float32` The Y component of the normal. c : `float32` The Z component of the normal. d : `float32` The distance to the origin.
`Plane3(pointOnPlane, normal)` Full Usage: `Plane3(pointOnPlane, normal)` Parameters: pointOnPlane : `Vector3` - A point the created Plane3 should contain. normal : `Vector3` - The normal of the plane.	Create a Plane3 that contains the specified point and has the specified Plane3.Normal vector. pointOnPlane : `Vector3` A point the created Plane3 should contain. normal : `Vector3` The normal of the plane.

Instance members

Instance member	Description
`this.Dot` Full Usage: `this.Dot` Parameters: value : `Vector4` - The Vector4 to calculate the dot product with. Returns: `float32` The dot product of the specified Vector4 and this Plane3.	Get the dot product of a Vector4 with this Plane3. value : `Vector4` The Vector4 to calculate the dot product with. Returns: `float32` The dot product of the specified Vector4 and this Plane3.
`this.Dot` Full Usage: `this.Dot` Parameters: value : `byref<Vector4>` - The Vector4 to calculate the dot product with. result : `byref<float32>` - The dot product of the specified Vector4 and this Plane3.	Get the dot product of a Vector4 with this Plane3. value : `byref<Vector4>` The Vector4 to calculate the dot product with. result : `byref<float32>` The dot product of the specified Vector4 and this Plane3.
`this.DotCoordinate` Full Usage: `this.DotCoordinate` Parameters: value : `Vector3` - The Vector3 to calculate the dot product with. Returns: `float32` The dot product of the specified Vector3 and the normal of this Plane3 plus the Plane3.D value of this Plane3.	Get the dot product of a Vector3 with the Plane3.Normal vector of this Plane3 plus the Plane3.D value of this Plane3. value : `Vector3` The Vector3 to calculate the dot product with. Returns: `float32` The dot product of the specified Vector3 and the normal of this Plane3 plus the Plane3.D value of this Plane3.
`this.DotCoordinate` Full Usage: `this.DotCoordinate` Parameters: value : `byref<Vector3>` - The Vector3 to calculate the dot product with. result : `byref<float32>` - The dot product of the specified Vector3 and the normal of this Plane3 plus the Plane3.D value of this Plane3.	Get the dot product of a Vector3 with the Plane3.Normal vector of this Plane3 plus the Plane3.D value of this Plane3. value : `byref<Vector3>` The Vector3 to calculate the dot product with. result : `byref<float32>` The dot product of the specified Vector3 and the normal of this Plane3 plus the Plane3.D value of this Plane3.
`this.DotNormal` Full Usage: `this.DotNormal` Parameters: value : `Vector3` - The Vector3 to calculate the dot product with. Returns: `float32` The dot product of the specified Vector3 and the normal of this Plane3.	Get the dot product of a Vector3 with the Plane3.Normal vector of this Plane3. value : `Vector3` The Vector3 to calculate the dot product with. Returns: `float32` The dot product of the specified Vector3 and the normal of this Plane3.
`this.DotNormal` Full Usage: `this.DotNormal` Parameters: value : `byref<Vector3>` - The Vector3 to calculate the dot product with. result : `byref<float32>` - The dot product of the specified Vector3 and the normal of this Plane3.	Get the dot product of a Vector3 with the Plane3.Normal vector of this Plane3. value : `byref<Vector3>` The Vector3 to calculate the dot product with. result : `byref<float32>` The dot product of the specified Vector3 and the normal of this Plane3.
`this.Equals` Full Usage: `this.Equals` Parameters: other : `obj` - An Object to check for equality with this Plane3. Returns: `bool` `true` if the specified Object is equal to this Plane3, `false` if it is not. Modifiers: abstract	Check if this Plane3 is equal to another Plane3. other : `obj` An Object to check for equality with this Plane3. Returns: `bool` `true` if the specified Object is equal to this Plane3, `false` if it is not.
`this.Equals` Full Usage: `this.Equals` Parameters: other : `Plane3` - A Plane3 to check for equality with this Plane3. Returns: `bool` `true` if the specified Plane3 is equal to this one, `false` if it is not. Modifiers: abstract	Check if this Plane3 is equal to another Plane3. other : `Plane3` A Plane3 to check for equality with this Plane3. Returns: `bool` `true` if the specified Plane3 is equal to this one, `false` if it is not.
`this.GetHashCode` Full Usage: `this.GetHashCode` Returns: `int` A hash code for this Plane3. Modifiers: abstract	Get a hash code for this Plane3. Returns: `int` A hash code for this Plane3.
`this.Intersects` Full Usage: `this.Intersects` Parameters: box : `Box3` - The Box3 to test for intersection. Returns: `PlaneIntersectionType` The type of intersection of this Plane3 with the specified Box3.	Check if this Plane3 intersects a Box3. box : `Box3` The Box3 to test for intersection. Returns: `PlaneIntersectionType` The type of intersection of this Plane3 with the specified Box3.
`this.Intersects` Full Usage: `this.Intersects` Parameters: box : `inref<Box3>` - The Box3 to test for intersection. result : `byref<PlaneIntersectionType>` - The type of intersection of this Plane3 with the specified Box3.	Check if this Plane3 intersects a Box3. box : `inref<Box3>` The Box3 to test for intersection. result : `byref<PlaneIntersectionType>` The type of intersection of this Plane3 with the specified Box3.
`this.Intersects` Full Usage: `this.Intersects` Parameters: frustum : `Frustum` - The !:BoundingFrustum to test for intersection. Returns: `PlaneIntersectionType` The type of intersection of this Plane3 with the specified !:BoundingFrustum.	Check if this Plane3 intersects a !:BoundingFrustum. frustum : `Frustum` The !:BoundingFrustum to test for intersection. Returns: `PlaneIntersectionType` The type of intersection of this Plane3 with the specified !:BoundingFrustum.
`this.Intersects` Full Usage: `this.Intersects` Parameters: sphere : `Sphere` - The !:BoundingSphere to test for intersection. Returns: `PlaneIntersectionType` The type of intersection of this Plane3 with the specified !:BoundingSphere.	Check if this Plane3 intersects a !:BoundingSphere. sphere : `Sphere` The !:BoundingSphere to test for intersection. Returns: `PlaneIntersectionType` The type of intersection of this Plane3 with the specified !:BoundingSphere.
`this.Intersects` Full Usage: `this.Intersects` Parameters: sphere : `inref<Sphere>` - The !:BoundingSphere to test for intersection. result : `byref<PlaneIntersectionType>` - The type of intersection of this Plane3 with the specified !:BoundingSphere.	Check if this Plane3 intersects a !:BoundingSphere. sphere : `inref<Sphere>` The !:BoundingSphere to test for intersection. result : `byref<PlaneIntersectionType>` The type of intersection of this Plane3 with the specified !:BoundingSphere.
`this.Intersects` Full Usage: `this.Intersects` Parameters: ray : `Ray3` Returns: `Nullable<float32>`	Check for a ray intersection. ray : `Ray3` Returns: `Nullable<float32>`
`this.Intersects` Full Usage: `this.Intersects` Parameters: ray : `inref<Ray3>` result : `byref<Nullable<float32>>`	Check for a ray intersection. ray : `inref<Ray3>` result : `byref<Nullable<float32>>`
`this.Normalize` Full Usage: `this.Normalize`	Normalize the normal vector of this plane.
`this.ToString` Full Usage: `this.ToString` Returns: `string` A String representation of this Plane3. Modifiers: abstract	Get a String representation of this Plane3. Returns: `string` A String representation of this Plane3.

Static members

Static member	Description
`plane1 <> plane2` Full Usage: `plane1 <> plane2` Parameters: plane1 : `Plane3` - A Plane3 to check for inequality. plane2 : `Plane3` - A Plane3 to check for inequality. Returns: `bool` `true` if the two planes are not equal, `false` if they are.	Check if two planes are not equal. plane1 : `Plane3` A Plane3 to check for inequality. plane2 : `Plane3` A Plane3 to check for inequality. Returns: `bool` `true` if the two planes are not equal, `false` if they are.
`plane1 = plane2` Full Usage: `plane1 = plane2` Parameters: plane1 : `Plane3` - A Plane3 to check for equality. plane2 : `Plane3` - A Plane3 to check for equality. Returns: `bool` `true` if the two planes are equal, `false` if they are not.	Check if two planes are equal. plane1 : `Plane3` A Plane3 to check for equality. plane2 : `Plane3` A Plane3 to check for equality. Returns: `bool` `true` if the two planes are equal, `false` if they are not.
`Plane3.Normalize(value)` Full Usage: `Plane3.Normalize(value)` Parameters: value : `Plane3` - The Plane3 to normalize. Returns: `Plane3` A normalized version of the specified Plane3.	Get a normalized version of the specified plane. value : `Plane3` The Plane3 to normalize. Returns: `Plane3` A normalized version of the specified Plane3.
`Plane3.Normalize(value, result)` Full Usage: `Plane3.Normalize(value, result)` Parameters: value : `byref<Plane3>` - The Plane3 to normalize. result : `byref<Plane3>` - A normalized version of the specified Plane3.	Get a normalized version of the specified plane. value : `byref<Plane3>` The Plane3 to normalize. result : `byref<Plane3>` A normalized version of the specified Plane3.
`Plane3.Transform(plane, matrix)` Full Usage: `Plane3.Transform(plane, matrix)` Parameters: plane : `Plane3` - The normalized plane to transform. matrix : `Matrix4x4` - The transformation matrix. Returns: `Plane3` The transformed plane.	Transforms a normalized plane by a matrix. plane : `Plane3` The normalized plane to transform. matrix : `Matrix4x4` The transformation matrix. Returns: `Plane3` The transformed plane.
`Plane3.Transform(plane, matrix, result)` Full Usage: `Plane3.Transform(plane, matrix, result)` Parameters: plane : `byref<Plane3>` - The normalized plane to transform. matrix : `byref<Matrix4x4>` - The transformation matrix. result : `byref<Plane3>` - The transformed plane.	Transforms a normalized plane by a matrix. plane : `byref<Plane3>` The normalized plane to transform. matrix : `byref<Matrix4x4>` The transformation matrix. result : `byref<Plane3>` The transformed plane.
`Plane3.Transform(plane, rotation)` Full Usage: `Plane3.Transform(plane, rotation)` Parameters: plane : `Plane3` - The normalized plane to transform. rotation : `Quaternion` - The quaternion rotation. Returns: `Plane3` The transformed plane.	Transforms a normalized plane by a quaternion rotation. plane : `Plane3` The normalized plane to transform. rotation : `Quaternion` The quaternion rotation. Returns: `Plane3` The transformed plane.
`Plane3.Transform(plane, rotation, result)` Full Usage: `Plane3.Transform(plane, rotation, result)` Parameters: plane : `byref<Plane3>` - The normalized plane to transform. rotation : `byref<Quaternion>` - The quaternion rotation. result : `byref<Plane3>` - The transformed plane.	Transforms a normalized plane by a quaternion rotation. plane : `byref<Plane3>` The normalized plane to transform. rotation : `byref<Quaternion>` The quaternion rotation. result : `byref<Plane3>` The transformed plane.