public sealed class SubDEdge : SubDComponent
Single edge 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

ControlNetLine

#Since v7.0
Line representing the control net end points.
public Line ControlNetLine { get; }

FaceCount

#Since v7.0
Number of faces for this edge.
public int FaceCount { 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

IsSharp

#Since v8.36
Gets true if this edge is smooth and has a nonzero sharpness. A crease edge is not a sharp edge.
public bool IsSharp { get; }

ParentSubD

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

RelativeFaceLeft

#Since v8.36
The face on the left of this edge, with respect to the direction this edge is referenced with. Null for a boundary edge with no face on that side, and for a nonmanifold edge.
public SubDFace RelativeFaceLeft { get; }

RelativeFaceRight

#Since v8.36
The face on the right of this edge, with respect to the direction this edge is referenced with.
public SubDFace RelativeFaceRight { get; }

RelativeVertexFrom

#Since v8.36
The vertex this edge starts at, taking SubDComponent.ComponentDirection into account. This is VertexFrom for an edge in its natural orientation and VertexTo for a reversed one.
public SubDVertex RelativeVertexFrom { get; }

RelativeVertexTo

#Since v8.36
The vertex this edge ends at, taking SubDComponent.ComponentDirection into account.
public SubDVertex RelativeVertexTo { get; }

Sharpness

#Since v8.36
Gets or sets the sharpness of this edge.

The getter reports SubDEdgeSharpness.Crease for a crease edge; use GetSharpness(false) to get SubDEdgeSharpness.Smooth for creases instead.

public SubDEdgeSharpness Sharpness { get; set; }
Remarks: Setting this goes through the parent SubD so that the neighboring edges and vertices are updated too. Assign SubDEdgeSharpness.Smooth to make the edge smooth again.

Tag

#Since v7.0
identifies the type of subdivision edge.
public SubDEdgeTag Tag { get; set; }

VertexFrom

#Since v7.0
Start vertex for this edge.
public SubDVertex VertexFrom { get; }

VertexTo

#Since v7.0
End vertex for this edge.
public SubDVertex VertexTo { get; }

Methods

ClearSavedSubdivisionPoints

#Since v8.36
Discards the cached subdivision and surface points for this edge, 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 edge is affected.
)

ComponentIndex

#Since v8.12
Gets the component index of this edge.
[ConstOperation] public ComponentIndex ComponentIndex()
The component index.

EndSharpness

#Since v8.36
Gets the sharpness of this edge at one of its ends.
[ConstOperation] public double EndSharpness(
endIndex,
0 for the VertexFrom end, 1 for the VertexTo end.
useCreaseSharpness
If this edge is a crease and useCreaseSharpness is true, then SubDEdgeSharpness.CreaseValue is returned.
)
The sharpness at that end, or 0.0 if this edge is not sharp.

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

FaceAt

#Since v7.0
Retrieve a SubDFace from this edge.
public SubDFace FaceAt(
index
)

GetHashCode

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

GetSharpness

#Since v8.36
Gets the sharpness of this edge, reporting SubDEdgeSharpness.Crease for a crease edge.
[ConstOperation] public SubDEdgeSharpness GetSharpness()
The sharpness of this edge.

GetSharpness

#Since v8.36
Gets the sharpness of this edge.
[ConstOperation] public SubDEdgeSharpness GetSharpness(
useCreaseSharpness
If this edge is a crease and useCreaseSharpness is true, then SubDEdgeSharpness.Crease is returned. If it is a crease and useCreaseSharpness is false, then SubDEdgeSharpness.Smooth is returned.
)
The sharpness of a smooth edge, SubDEdgeSharpness.Crease for a crease edge when useCreaseSharpness is true, and SubDEdgeSharpness.Smooth in every other case.

RelativeFaceAt

#Since v8.36
Gets the face on one side of this edge, relative to the direction this edge is referenced with.
[ConstOperation] public SubDFace RelativeFaceAt(
relativeFaceIndex
0 for the left side, 1 for the right side.
)
The face, with its SubDComponent.ComponentDirection set so its boundary runs the same way as this edge. Null if there is no such face, or if the edge is nonmanifold.

RelativeVertexAt

#Since v8.36
Gets one of this edge's two vertices, relative to the direction this edge is referenced with.
[ConstOperation] public SubDVertex RelativeVertexAt(
endIndex
0 for the start of the edge, 1 for the end.
)
The vertex, or null if endIndex is out of range.

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.

ToNurbsCurve

#Since v7.0
Get a cubic, uniform, non-rational, NURBS curve that is on the edge's limit curve.
public NurbsCurve ToNurbsCurve(
clampEnds
If true, the end knots are clamped. Otherwise the end knots are(-2,-1,0,...., k1, k1+1, k1+2).
)
Remarks: If some edges in your SubD are not able to be converted to NURBS, you might need to run SubD.UpdateSurfaceMeshCache(bool).
The Nurbs form of this edge.

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