Click or drag to resize
DigitalRunePlane Structure
Defines a plane.

Namespace: DigitalRune.Geometry.Shapes
Assembly: DigitalRune.Geometry (in DigitalRune.Geometry.dll) Version: 1.18.0.0 (1.18.2.14427)
Syntax
[SerializableAttribute]
public struct Plane : IEquatable<Plane>

The Plane type exposes the following members.

Constructors
  NameDescription
Public methodPlane(PlaneShape)
Initializes a new instance of Plane from a PlaneShape.
Public methodPlane(Vector3F, Vector3F)
Initializes a new instance of Plane from normal vector and a point on the plane.
Public methodPlane(Vector3F, Single)
Initializes a new instance of Plane from normal vector and distance to the origin.
Public methodPlane(Vector3F, Vector3F, Vector3F)
Initializes a new instance of Plane from three points.
Top
Methods
  NameDescription
Public methodEquals(Object)
Determines whether the specified Object is equal to the current Object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Plane)
Determines whether the specified Plane is equal to the current Plane.
Public methodGetHashCode
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodNormalize
Normalizes the plane.
Public methodToString
Returns a String that represents the current Object.
(Overrides ValueTypeToString.)
Public methodTryNormalize
Tries to normalizes the plane.
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Tests if two Planes are equal.
Public operatorStatic memberInequality
Tests if two Planes are different.
Top
Fields
  NameDescription
Public fieldDistanceFromOrigin
The distance of the plane from the origin (also known as the "plane constant").
Public fieldNormal
The normalized, outward pointing normal vector.
Top
Remarks

This is a lightweight structure. To define a plane shape for IGeometricObject use PlaneShape.

A plane can be described by a plane equation: a * x + b * y + c * z = d, where (x, y, z) is a point on the plane and (a, b, c) is the Normal vector. d is the "plane constant", which is equal to the distance from the origin if the normal is normalized.

Two Planes are considered as equal if Normal and DistanceFromOrigin are equal.

See Also