Click or drag to resize

PlaneF Structure

Represents a single precision plane in three-dimensional space.

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2022.1.1.0 (2022.1.1.0)
Syntax
C#
public struct PlaneF

The PlaneF type exposes the following members.

Constructors
  NameDescription
Public methodPlaneF(PlaneF)
Constructs a plane with another specified PlaneF object.
Public methodPlaneF(Vector4F)
Constructs a plane from the given Vector4F object.
Public methodPlaneF(Vector3F, Single)
Constructs a plane with the given normal and the distance along this normal from the origin.
Public methodPlaneF(Single, Single, Single, Single)
Constructs a plane with the given A, B, C and D components.
Top
Properties
  NameDescription
Public propertyDistance
The distance of the plane along its normal from the origin.
Public propertyItem
Gets or sets the component at the specified index.
Public propertyNormal
The normal vector of the plane.
Top
Methods
  NameDescription
Public methodStatic memberAdd
Adds two planes.
Public methodEquals(Object)
Determines whether the specified object is equal to the current instance of PlaneF.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(PlaneF, Single)
Determines whether the specified plane is equal to the current instance of PlaneF with a given precision.
Public methodEquals(PlaneF, Single)
Determines whether the specified plane is equal to the current instance of PlaneF with a given precision.
Public methodEquals(PlaneF, Single, Single)
Determines whether the specified plane is equal to the current instance of PlaneF with the given normal and distance precisions.
Public methodEquals(PlaneF, Single, Single)
Determines whether the specified plane is equal to the current instance of PlaneF with the given normal and distance precisions.
Public methodStatic memberFromPointAndNormal(Vector3F, Vector3F)
Creates an instance of PlaneF with the normal and the point.
Public methodStatic memberFromPointAndNormal(Vector3F, Vector3F, PlaneF)
Creates an instance of PlaneF with the normal and the point.
Public methodStatic memberFromPoints(Vector3F, Vector3F, Vector3F)
Creates an instance of PlaneF that contains the three given points.
Public methodStatic memberFromPoints(Vector3F, Vector3F, Vector3F, PlaneF)
Creates an instance of PlaneF that contains the three given points.
Public methodStatic memberFromVectors(Vector3F, Vector3F, Vector3F)
Creates an instance of PlaneF with point and two direction vectors.
Public methodStatic memberFromVectors(Vector3F, Vector3F, Vector3F, PlaneF)
Creates an instance of PlaneF with point and two direction vectors.
Public methodGetDistance(Vector3F)
Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane.
Public methodGetDistance(Vector3F)
Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane.
Public methodGetHashCode
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetNormalize
Converts a normal vector of the current instance of PlaneF into a unit vector and returns the resulting plane.
Public methodGetSide(BoundsF)
Returns side of the plane that the given box lies on. The box is defined as bounds.
Public methodGetSide(BoundsF)
Returns side of the plane that the given box lies on. The box is defined as bounds.
Public methodGetSide(Vector3F)
Determines from which side of the plane the point is on.
Public methodGetSide(Vector3F)
Determines from which side of the plane the point is on.
Public methodGetSide(Vector3F, Vector3F)
Returns side of the plane that the given box lies on. The box is defined as centre/half-size pairs for effectively.
Public methodGetSide(Vector3F, Single)
Determines from which side of the plane the point is on (with the given precision).
Public methodGetSide(Vector3F, Vector3F)
Returns side of the plane that the given box lies on. The box is defined as centre/half-size pairs for effectively.
Public methodGetSide(Vector3F, Single)
Determines from which side of the plane the point is on (with the given precision).
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIntersects(Line3F)
Public methodIntersects(Line3F, Single)
Determines whether the given line intersects the current instance of PlaneF.
Public methodIntersects(Line3F, Single)
Determines whether the given line intersects the current instance of PlaneF.
Public methodIntersects(RayF, Vector3F)
Determines whether the given ray intersects the current instance of PlaneF.
Public methodIntersects(RayF, Single)
Determines whether the given ray intersects the current instance of PlaneF.
Public methodIntersects(RayF, Vector3F)
Determines whether the given ray intersects the current instance of PlaneF.
Public methodIntersects(RayF, Single)
Determines whether the given ray intersects the current instance of PlaneF.
Public methodStatic memberNegate
Reverses the direction of a given plane.
Public methodNormalize
Converts a normal vector of the current instance of PlaneF into a unit vector.
Public methodStatic memberParse
Converts a string representation of a plane into the equivalent PlaneF structure.
Public methodStatic memberSubtract
Subtracts two planes.
Public methodToPlane
Converts the current instance of PlaneF to the plane of Plane format.
Public methodToString
Returns a String that represents the current instance of PlaneF.
(Overrides ValueTypeToString.)
Public methodToString(Int32)
Returns a String that represents the current instance of PlaneF with a given precision.
Public methodToVector4F
Converts the current instance of PlaneF into an instance of Vector4F.
Top
Operators
  NameDescription
Public operatorStatic memberAddition
Adds two planes.
Public operatorStatic memberEquality
Determines whether two given planes are equal.
Public operatorStatic member(PlaneF to Plane)
Implicit conversion from PlaneF type to Plane type for the given value.
Public operatorStatic memberInequality
Determines whether two given planes are unequal.
Public operatorStatic memberSubtraction
Subtracts two planes.
Public operatorStatic memberUnaryNegation
Reverses the direction of a given plane.
Top
Fields
  NameDescription
Public fieldA
The A component of the plane.
Public fieldB
The B component of the plane.
Public fieldC
The C component of the plane.
Public fieldD
The D component of the plane.
Public fieldStatic memberZero
Returns the plane with all of its components set to zero.
Top
Extension Methods
See Also