public sealed class SubDFace : SubDComponent
Single face of a SubD

Properties

ComponentDirection

True when this component is referenced with the reverse of its natural orientation. This is always false for vertices, and for edges and faces obtained directly from the parent SubD; it is only set on components reached through an oriented reference, such as the face on a given side of an oriented edge.
public bool ComponentDirection { get; set; }
inherited fromSubDComponent

ControlNetCenterFrame

#Since v8.0
The face's control net center frame is a plane with normal equal to ControlNetCenterNormal and origin equal to ControlNetCenterPoint. The x and y axes of the frame have no predictable relationship to the face or SubD control net topology.
public Plane ControlNetCenterFrame { get; }
A plane with unit normal equal to ControlNetCenterNormal and origin equal to ControlNetCenterPoint.

ControlNetCenterNormal

#Since v8.0
When the face's control net polygon is planar, the face's control net normal is a unit vector perpendicular to the plane that points outwards. If the control net polygon is not planar, the control net normal is control net normal is a unit vector that is the average of the control polygon's corner normals.
public Vector3d ControlNetCenterNormal { get; }
A unit vector that is normal to planar control net polygons and a good compromise for nonplanar control net polygons.

ControlNetCenterPoint

#Since v8.0
The face's control net center point is the average of the face's vertex control net points. This is the same point as the face's subdivision point.
public Point3d ControlNetCenterPoint { get; }
The average of the face's vertex control net points

EdgeCount

#Since v7.0
Number of edges for this face. Note that EdgeCount is always the same as VertexCount. Two properties are provided simply for clarity.
public int EdgeCount { get; }

Id

Unique id within the parent SubD for this item
[CLSCompliant(false)] public uint Id { get; }
inherited fromSubDComponent

IsDamaged

Returns true if the SubD component is damaged.
public bool IsDamaged { get; }
inherited fromSubDComponent

IsDeleted

Returns true if the SubD component is deleted.
public bool IsDeleted { get; }
inherited fromSubDComponent

IsHidden

Returns true if the SubD component is hidden.
public bool IsHidden { get; }
inherited fromSubDComponent

IsHighlighted

Returns true if the SubD component is highlighted.
public bool IsHighlighted { get; }
inherited fromSubDComponent

IsLocked

Returns true if the SubD component is locked.
public bool IsLocked { get; }
inherited fromSubDComponent

IsSelected

Returns true if the SubD component is selected.
public bool IsSelected { get; }
inherited fromSubDComponent

LimitSurfaceCenterPoint

#Since v7.0
Get the limit surface point location at the center of the face
public Point3d LimitSurfaceCenterPoint { get; }

ParentSubD

SubD that this component belongs to
public SubD ParentSubD { get; }
inherited fromSubDComponent

PerFaceColor

#Since v7.0
If per-face color is "Empty", then this face does not have a custom color
public Color PerFaceColor { get; set; }

SurfaceCenterFrame

#Since v8.0
Get the limit surface tangent plane at the center of the face. The plane's origin is the point on the limit surface at the center of the face. The plane's z axis is the limit surface normal vector at the center of the face.
public Plane SurfaceCenterFrame { get; }
Limit surface tanget plane at the face's center.

SurfaceCenterNormal

#Since v8.0
Get the limit surface normal vector at the center of the face.
public Vector3d SurfaceCenterNormal { get; }
Limit surface normal vector at the face's center.

VertexCount

#Since v7.0
Number of vertices for this face. Note that EdgeCount is always the same as VertexCount. Two properties are provided simply for clarity.
public int VertexCount { get; }

Methods

ClearSavedSubdivisionPoints

#Since v8.36
Discards the cached subdivision and surface points for this face, so they are recomputed on next use.
[ConstOperation] public void ClearSavedSubdivisionPoints(
clearNeighborhood
If true, the cached points of the neighboring components are discarded too. Moving a control net point changes the surface around it, not just at it, so pass true after an edit unless you know only this face is affected.
)

ComponentIndex

#Since v7.9
Gets the component index of this face.
[ConstOperation] public ComponentIndex ComponentIndex()
The component index.

EdgeAt

#Since v7.0
Get an edge at a given index
public SubDEdge EdgeAt(
index
)

EdgeDirectionMatchesFaceOrientation

#Since v7.0
Check if a given edge in this face has the same direction as the face orientation
public bool EdgeDirectionMatchesFaceOrientation(
index
)

Equals

Determines whether an object is a SubDComponent referring to the same component, with the same orientation, in the same SubD.
public override bool Equals(
obj
The object to compare with.
)
inherited fromSubDComponent
Object.Equals

Equals

Determines whether this component and another refer to the same component, with the same orientation, in the same SubD.
public bool Equals(
other
The component to compare with.
)
inherited fromSubDComponent

GetHashCode

Gets a hash code for this component.
public override int GetHashCode()
inherited fromSubDComponent

ReverseComponentDirection

Flips SubDComponent.ComponentDirection and returns this component, so it can be used inline where an oppositely oriented reference is wanted.
public SubDComponent ReverseComponentDirection()
inherited fromSubDComponent
This component.

ToString

Returns a string of the form "SubDEdge(+12)", naming the component type, the orientation it is referenced with, and its id.
public override string ToString()
inherited fromSubDComponent
Object.ToString

VertexAt

#Since v7.0
Get a vertex that this face uses by index
public SubDVertex VertexAt(
index
)