Plane

Public Class

A Planar surface.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Surface
Autodesk.Revit.DB.Plane

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Plane : Surface

The Plane type exposes the following members.

Properties

Name

Description

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Surface)

Public Property

Normal

Plane normal.

Public Property
OrientationMatchesParametricOrientation

Indicates whether this Surface’s orientation is the same as or opposite to its parametric orientation.
(Inherited from Surface)

Public Property

Origin

Plane origin.

Public Property

XVec

Axis defining the first parametric direction of the plane.

Public Property

YVec

Axis defining the second parametric direction of the plane.

Methods

Name

Description

Public Method
Static Member
Create

Creates a Plane object defined by a local frame of reference.

Public Method
Static Member
Code Example
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.

Public Method
Static Member
CreateByOriginAndBasis

Creates a Plane object defined by the two orthogonal unit vectors and passing through the origin point supplied as arguments.

Public Method
Static Member
CreateByThreePoints

Creates a Plane object passing through three points supplied as arguments.

Public Method

Dispose

(Inherited from Surface)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method
GetBoundingBoxUV

Gets the UV bounding box of the surface.
(Inherited from Surface)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

Project

Project a 3D point orthogonally onto a surface (to find the nearest point). Throws InvalidOperationException if the projection fails.
(Inherited from Surface)

Public Method

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)

Public Method

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

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());
}