Plane Class |
A Planar surface.
Inheritance Hierarchy
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 27.0.4.0 (27.0.4.0)
Syntax
The Plane type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Surface ) |
|
|
Normal | Plane normal. |
|
|
OrientationMatchesParametricOrientation |
Indicates whether this Surface's orientation is the same as or opposite to its parametric orientation.
(Inherited from Surface ) |
|
|
Origin | Plane origin. |
|
|
XVec | Axis defining the first parametric direction of the plane. |
|
|
YVec | Axis defining the second parametric direction of the plane. |
Methods
| Name | Description | |
|---|---|---|
|
Create | Creates a Plane object defined by a local frame of reference. |
|
CreateByNormalAndOrigin | Constructs a Plane object from a normal and an origin represented as XYZ objects. Follows the standard conventions for a planar surface. The constructed Plane object will pass through origin and be perpendicular to normal. The X and Y axes of the plane will be defined arbitrarily. |
|
|
CreateByOriginAndBasis | Creates a Plane object defined by the two orthogonal unit vectors and passing through the origin point supplied as arguments. |
|
|
CreateByThreePoints | Creates a Plane object passing through three points supplied as arguments. |
|
|
Dispose |
(Inherited from Surface ) |
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from Object ) |
|
|
GetBoundingBoxUV |
Gets the UV bounding box of the surface.
(Inherited from Surface ) |
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from Object ) |
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from Object ) |
|
|
IsCoincidentWith |
Determine if two surfaces are coincident (ignoring Envelopes). For an affirmative answer,
the surfaces must have the same type (e.g., two planes).
(Inherited from Surface ) |
|
|
Project |
Project a 3D point orthogonally onto a surface (to find the nearest point).
Throws InvalidOperationException if the projection fails.
(Inherited from Surface ) |
|
|
ProjectWithGuessPoint |
Project a 3D point orthogonally onto a surface (to find the nearest point).
This method is meant to be used when a good approximate solution for the projection is available.
Throws InvalidOperationException if the projection fails.
(Inherited from Surface ) |
|
|
ToString |
Returns a string that represents the current object.
(Inherited from Object ) |
Remarks
The parametric equation of the plane is S(u, v) = origin + u*xVec + v*yVec.
Example
C#
public void GetPlaneInfo(Plane plane)
{
XYZ origin = plane.Origin;
XYZ normal = plane.Normal;
XYZ xVec = plane.XVec;
XYZ yVec = plane.YVec;
StringBuilder info = new StringBuilder();
info.AppendLine("Plane Data:");
info.AppendLine(string.Format(" Origin: ({0},{1},{2})", origin.X, origin.Y, origin.Z));
info.AppendLine(string.Format(" Normal: ({0},{1},{2})", normal.X, normal.Y, normal.Z));
info.AppendLine(string.Format(" XVec: ({0},{1},{2})", xVec.X, xVec.Y, xVec.Z));
info.AppendLine(string.Format(" YVec: ({0},{1},{2})", yVec.X, yVec.Y, yVec.Z));
TaskDialog.Show("Revit",info.ToString());
}