 | PlaneShape Class |
Represents a plane.
Inheritance HierarchyNamespace: DigitalRune.Geometry.Shapes
Assembly: DigitalRune.Geometry (in DigitalRune.Geometry.dll) Version: 1.18.0.0 (1.18.2.14427)
SyntaxThe PlaneShape type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PlaneShape |
Initializes a new instance of the PlaneShape class.
|
| PlaneShape(Plane) |
Initializes a new instance of the PlaneShape class.
|
| PlaneShape(Vector3F, Vector3F) |
Initializes a new instance of the PlaneShape class.
|
| PlaneShape(Vector3F, Single) |
Initializes a new instance of the PlaneShape class from a normal vector and
the distance from the origin.
|
| PlaneShape(Vector3F, Vector3F, Vector3F) |
Initializes a new instance of the PlaneShape class from three points.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a new Shape that is a clone (deep copy) of the current instance.
(Inherited from Shape.) |
 | CloneCore |
Makes the instance a clone (deep copy) of the specified Shape.
(Overrides ShapeCloneCore(Shape).) |
| CreateInstanceCore |
When implemented in a derived class, creates a new instance of the Shape
derived class.
(Overrides ShapeCreateInstanceCore.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAabb |
Computes the axis-aligned bounding box (AABB) for this shape in local space.
(Inherited from Shape.) |
| GetAabb(Pose) |
Computes the axis-aligned bounding box (AABB) for this shape positioned in world space using
the given Pose.
(Inherited from Shape.) |
| GetAabb(Vector3F, Pose) |
Computes the axis-aligned bounding box (AABB) for this shape positioned in world space using
the given scale and Pose.
(Overrides ShapeGetAabb(Vector3F, Pose).) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetMesh |
Gets a mesh that represents this shape.
(Inherited from Shape.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVolume |
Gets the volume of this plane.
(Overrides ShapeGetVolume(Single, Int32).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnChanged |
Raises the Changed event.
(Inherited from Shape.) |
| OnGetMesh |
Called when a mesh should be generated for the shape.
(Overrides ShapeOnGetMesh(Single, Int32).) |
| ToString | (Overrides ObjectToString.) |
Properties| Name | Description | |
|---|---|---|
 | DistanceFromOrigin |
Gets or sets the distance of the plane from the origin (also known as the "plane constant").
|
| InnerPoint |
Gets an inner point.
(Overrides ShapeInnerPoint.) |
 | MeshSize |
Gets or sets the size of the mesh that represents a PlaneShape.
|
| Normal |
Gets or sets the outward pointing normal vector.
|
Events
RemarksThis class can be used if an IGeometricObject with a plane shape is needed. Use the Plane structure instead if you need a lightweight representation of a plane (avoids allocating memory on the heap).
A plane shape divides the world into two half-spaces. The negative half-space is the solid volume of this shape. The plane Normal is stored normalized and points into the positive half-space (which is not part of the shape).
See Also