Plane |
Represents a single precision plane in three-dimensional space.
Inheritance HierarchyNamespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)
SyntaxC#
public struct PlaneF
The PlaneF type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PlaneF(PlaneF) | Constructs a plane with another specified PlaneF object. |
| PlaneF(Vector4F) | Constructs a plane from the given Vector4F object. |
| PlaneF(Vector3F, Single) | Constructs a plane with the given normal and the distance along this normal from the origin. |
| PlaneF(Single, Single, Single, Single) | Constructs a plane with the given A, B, C and D components. |
Properties| Name | Description | |
|---|---|---|
 | Distance | The distance of the plane along its normal from the origin. |
| Item | Gets or sets the component at the specified index. |
| Normal | The normal vector of the plane. |
Methods| Name | Description | |
|---|---|---|
 | Add | Adds two planes. |
| Equals(Object) |
Determines whether the specified object is equal to the current instance of PlaneF.
(Overrides ValueTypeEquals(Object)) |
| Equals(PlaneF, Single) | Determines whether the specified plane is equal to the current instance of PlaneF with a given precision. |
| Equals(PlaneF, Single) | Determines whether the specified plane is equal to the current instance of PlaneF with a given precision. |
| Equals(PlaneF, Single, Single) | Determines whether the specified plane is equal to the current instance of PlaneF with the given normal and distance precisions. |
| Equals(PlaneF, Single, Single) | Determines whether the specified plane is equal to the current instance of PlaneF with the given normal and distance precisions. |
| FromPointAndNormal(Vector3F, Vector3F) | Creates an instance of PlaneF with the normal and the point. |
| FromPointAndNormal(Vector3F, Vector3F, PlaneF) | Creates an instance of PlaneF with the normal and the point. |
| FromPoints(Vector3F, Vector3F, Vector3F) | Creates an instance of PlaneF that contains the three given points. |
| FromPoints(Vector3F, Vector3F, Vector3F, PlaneF) | Creates an instance of PlaneF that contains the three given points. |
| FromVectors(Vector3F, Vector3F, Vector3F) | Creates an instance of PlaneF with point and two direction vectors. |
| FromVectors(Vector3F, Vector3F, Vector3F, PlaneF) | Creates an instance of PlaneF with point and two direction vectors. |
| GetDistance(Vector3F) | Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. |
| GetDistance(Vector3F) | Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane. |
| GetHashCode |
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode) |
| GetNormalize | Converts a normal vector of the current instance of PlaneF into a unit vector and returns the resulting plane. |
| GetSide(BoundsF) | Returns side of the plane that the given box lies on. The box is defined as bounds. |
| GetSide(BoundsF) | Returns side of the plane that the given box lies on. The box is defined as bounds. |
| GetSide(Vector3F) | Determines from which side of the plane the point is on. |
| GetSide(Vector3F) | Determines from which side of the plane the point is on. |
| GetSide(Vector3F, Vector3F) | Returns side of the plane that the given box lies on. The box is defined as centre/half-size pairs for effectively. |
| GetSide(Vector3F, Single) | Determines from which side of the plane the point is on (with the given precision). |
| GetSide(Vector3F, Vector3F) | Returns side of the plane that the given box lies on. The box is defined as centre/half-size pairs for effectively. |
| GetSide(Vector3F, Single) | Determines from which side of the plane the point is on (with the given precision). |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Intersects(Line3F) | |
| Intersects(Line3F, Single) | Determines whether the given line intersects the current instance of PlaneF. |
| Intersects(Line3F, Single) | Determines whether the given line intersects the current instance of PlaneF. |
| Intersects(RayF, Vector3F) | Determines whether the given ray intersects the current instance of PlaneF. |
| Intersects(RayF, Single) | Determines whether the given ray intersects the current instance of PlaneF. |
| Intersects(RayF, Vector3F) | Determines whether the given ray intersects the current instance of PlaneF. |
| Intersects(RayF, Single) | Determines whether the given ray intersects the current instance of PlaneF. |
| Negate | Reverses the direction of a given plane. |
| Normalize | Converts a normal vector of the current instance of PlaneF into a unit vector. |
| Parse | Converts a string representation of a plane into the equivalent PlaneF structure. |
| Subtract | Subtracts two planes. |
| ToPlane | Converts the current instance of PlaneF to the plane of Plane format. |
| ToString |
Returns a String that represents the current instance of PlaneF.
(Overrides ValueTypeToString) |
| ToString(Int32) | Returns a String that represents the current instance of PlaneF with a given precision. |
| ToVector4F | Converts the current instance of PlaneF into an instance of Vector4F. |
Operators| Name | Description | |
|---|---|---|
 | Addition(PlaneF, PlaneF) | Adds two planes. |
| Equality(PlaneF, PlaneF) | Determines whether two given planes are equal. |
| (PlaneF to Plane) | Implicit conversion from PlaneF type to Plane type for the given value. |
| Inequality(PlaneF, PlaneF) | Determines whether two given planes are unequal. |
| Subtraction(PlaneF, PlaneF) | Subtracts two planes. |
| UnaryNegation(PlaneF) | Reverses the direction of a given plane. |
Fields| Name | Description | |
|---|---|---|
 | A | The A component of the plane. |
| B | The B component of the plane. |
| C | The C component of the plane. |
| D | The D component of the plane. |
| Zero | Returns the plane with all of its components set to zero. |
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx) |
| PropertyGet |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertyGetT |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx) |
See Also