PlanarFace

Public Class

A bounded face of a 3d solid or open shell.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.APIObject
Autodesk.Revit.DB.GeometryObject
Autodesk.Revit.DB.Face
Autodesk.Revit.DB.PlanarFace

Namespace: Autodesk.Revit.DB

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

Syntax

public class PlanarFace : Face

The PlanarFace type exposes the following members.

Properties

Name

Description

---

Public Property
Area

The area of this face.
(Inherited from Face)

---

Public Property

EdgeLoops

A collection of edge loops. Each edge loop represents one of the closed boundaries of the face.
(Inherited from Face)

---

Public Property
FaceNormal

Normal of the planar face.

---

Public Property
Code Example
GraphicsStyleId

The ElementId of the GeometryObject’s GraphicsStyle
(Inherited from GeometryObject)

---

Public Property
HasRegions

Identifies if the face contains regions (which can be created, for example, by the Split Face command).
(Inherited from Face)

---

Public Property
Id

A unique integer identifying the GeometryObject in its associated non view-specific GeometryElement.
(Inherited from GeometryObject)

---

Public Property

IsCyclic

Indicates whether the underlying surface is periodic in the specified parametric direction.
(Inherited from Face)

---

Public Property

IsElementGeometry

Indicates whether this geometry is obtained directly from an Element.
(Inherited from GeometryObject)

---

Public Property
Code Example

IsReadOnly

Identifies if the object is read-only or modifiable.
(Inherited from APIObject)

---

Public Property

IsTwoSided

Determines if a face is two-sided (degenerate).
(Inherited from Face)

---

Public Property

MaterialElementId

The element ID of the material from which this face is composed.
(Inherited from Face)

---

Public Property
OrientationMatchesSurfaceOrientation

Returns true if this face’s orientation matches the orientation of the face’s surface, false if they have opposite orientations.
(Inherited from Face)

---

Public Property

Origin

Origin of the surface.

---

Public Property

Period

The period of the underlying surface in the specified parametric direction.
(Inherited from Face)

---

Public Property

Reference

Returns a stable reference to the face.
(Inherited from Face)

---

Public Property
Visibility

The visibility.
(Inherited from GeometryObject)

---

Public Property
XVector

The X-vector of the planar face.

---

Public Property
YVector

The Y-vector of the planar face.

---

Methods

Name

Description

---

Public Method
ComputeDerivatives

Returns the first partial derivatives of the underlying surface at the specified point.
(Inherited from Face)

---

Public Method
ComputeNormal

Returns the normal vector for the face at the given point.
(Inherited from Face)

---

Public Method
ComputeSecondDerivatives

Returns the second partial derivatives of the face at the specified point.
(Inherited from Face)

---

Public Method
Dispose

Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject)

---

Public Method
Equals

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

---

Public Method
Evaluate

Evaluates and returns the XYZ coordinates of a point at the indicated UV parameterization of the face.
(Inherited from Face)

---

Public Method

GetBoundingBox

Returns the UV bounding box of the face.
(Inherited from Face)

---

Public Method
GetEdgesAsCurveLoops

Returns a list of closed curve loops that correspond to the edge loops of the face. Curves in each curve loop correspond to individual edges.
(Inherited from Face)

---

Public Method

GetHashCode

Gets the integer value of the geometry object as hash code
(Inherited from GeometryObject)

---

Public Method
GetRegions

Gets the face regions (created, for example, by the Split Face command) of the face.
(Inherited from Face)

---

Public Method

GetSurface

Returns a copy of this face’s surface.
(Inherited from Face)

---

Public Method

GetType

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

---

Public Method

Intersect(Curve)

Calculates the intersection of the specified curve with this face.
(Inherited from Face)

---

Public Method
Intersect(Face)

Calculates the intersection of the specified face with this face and returns the intersection results.
(Inherited from Face)

---

Public Method
Intersect(Curve, IntersectionResultArray.)

Calculates the intersection of the specified curve with this face and returns the intersection results.
(Inherited from Face)

---

Public Method
Intersect(Face, Curve.)

Calculates the intersection of the specified face with this face and returns the intersection results.
(Inherited from Face)

---

Public Method

IsInside(UV)

Indicates whether the specified point is within this face.
(Inherited from Face)

---

Public Method
IsInside(UV, IntersectionResult.)

Indicates whether the specified point is within this face and outputs additional information about the point location.
(Inherited from Face)

---

Public Method
Project

Projects the specified point on the face.
(Inherited from Face)

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Public Method
Code Example
Triangulate.

Returns a triangular mesh approximation to the face.
(Inherited from Face)

---

Public Method

Triangulate(Double)

Returns a triangular mesh approximation to the face.
(Inherited from Face)

---

Remarks

Planar faces are defined by planes bounded by edge loops. The planes provide natural UV parameterization to the faces. S(u, v) = Origin + u*Vector[0] + v*Vector[1]

Example

private void GetPlanarFaceInfo(Face face)
{
    PlanarFace planarFace = face as PlanarFace;
    if (null != planarFace)
    {
       XYZ origin = planarFace.Origin;
        XYZ normal = planarFace.FaceNormal;
        XYZ vector = planarFace.XVector;
    }
}