Interface ISketches2D
Gives access to 2D sketch entities.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 6, 0, 0)]
public interface ISketches2DRemarks
This interface is available since v7.6.
Properties
ModifiedSketch
Gets the sketch being modified.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementId ModifiedSketch { get; }Property Value
| Type | Description |
|---|---|
| ElementId |
Remarks
If there is no sketch being modified, Empty is returned.
This property is available since v7.7.201.80.
Methods
CreateArcSegment(ElementItemId, ElementItemId, Point2D, Boolean)
Creates a new circular arc segment into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId CreateArcSegment(ElementItemId inStartVertexId, ElementItemId inEndVertexId, Point2D inCenter, bool inTurnsClockwise)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inStartVertexId | Identifier of the start vertex. |
| ElementItemId | inEndVertexId | Identifier of the end vertex. |
| Point2D | inCenter | Circle center. |
| System.Boolean | inTurnsClockwise | Turns clockwise around the center when going form start to end if |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created segment. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
CreateBSplineSegment(List<ElementItemId>, Boolean)
Creates a new uniform cubic B-spline segment into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
ElementItemId CreateBSplineSegment(List<ElementItemId> inVertexIds, bool inIsPeriodic)Parameters
| Type | Name | Description |
|---|---|---|
| List<ElementItemId> | inVertexIds | Identifiers of the vertices defining the B-spline control points. |
| System.Boolean | inIsPeriodic | Whether the B-spline is periodic. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created segment. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.8.
CreateBuildingOperation(ElementId)
Creates the building operation of a sketch entity.
Declaration
[AvailableSinceVersion(7, 11, 0, 0)]
ElementId CreateBuildingOperation(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created building operation. |
Remarks
If the sketch entity has already got a building operation, this method does nothing and returns the identifier of the existing building operation.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.11.
CreateCircleSegment(ElementItemId, Double)
Creates a new circle segment into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId CreateCircleSegment(ElementItemId inCenterVertexId, double inRadius)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inCenterVertexId | Identifier of the center vertex. |
| System.Double | inRadius | Circle radius. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created segment. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
CreateLineSegment(ElementItemId, ElementItemId)
Creates a new line segment into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId CreateLineSegment(ElementItemId inStartVertexId, ElementItemId inEndVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inStartVertexId | Identifier of the start vertex. |
| ElementItemId | inEndVertexId | Identifier of the end vertex. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created segment. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
CreateProfile(List<ElementItemId>)
Creates a new profile into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId CreateProfile(List<ElementItemId> inSegmentIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<ElementItemId> | inSegmentIds | Identifiers of the segments of the profile. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created profile. |
Remarks
The end vertex of each segment must be the same than the start vertex of the following one.
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
CreateRevolvedSilhouette(SmartShape, SmartAxis3D, Boolean)
Creates the revolved silhouette of a shape.
Declaration
[AvailableSinceVersion(7, 15, 400, 100)]
ElementId CreateRevolvedSilhouette(SmartShape inShape, SmartAxis3D inAxis, bool inMerge)Parameters
| Type | Name | Description |
|---|---|---|
| SmartShape | inShape | Identifier of the shape to analyze. |
| SmartAxis3D | inAxis | Identifier of the revolution axis. |
| System.Boolean | inMerge | Tells whether the silhouette must be merged. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the revolved silhouette operation. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method must be called inside a Building Operation.
This method is available since v7.15.400.100.
CreateSection(List<ElementItemId>)
Creates a new section into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId CreateSection(List<ElementItemId> inProfileIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<ElementItemId> | inProfileIds | Identifiers of the profiles of the section. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created section. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
CreateSketchIn2D(DocumentId, SmartPoint2D, Boolean, SmartDirection2D)
Creates a sketch in a 2D document.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementId CreateSketchIn2D(DocumentId inDocumentId, SmartPoint2D inOrigin, bool inDefinesXDirection, SmartDirection2D inDirection)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartPoint2D | inOrigin | Origin point. |
| System.Boolean | inDefinesXDirection | Defines the X direction if |
| SmartDirection2D | inDirection | Reference X or Y direction. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created sketch entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.80.
This method does not create a building operation anymore since v7.11.
CreateSketchIn3D(DocumentId, SmartPlane3D, SmartPoint3D, Boolean, SmartDirection3D)
Creates a sketch in a 3D document.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementId CreateSketchIn3D(DocumentId inDocumentId, SmartPlane3D inPlane, SmartPoint3D inOrigin, bool inDefinesXDirection, SmartDirection3D inDirection)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartPlane3D | inPlane | Support plane. |
| SmartPoint3D | inOrigin | Origin point. |
| System.Boolean | inDefinesXDirection | Defines the X direction if |
| SmartDirection3D | inDirection | Reference X or Y direction. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created sketch entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.80.
This method does not create a building operation anymore since v7.11.
CreateVertex(Point2D)
Creates a new vertex into the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId CreateVertex(Point2D inPoint)Parameters
| Type | Name | Description |
|---|---|---|
| Point2D | inPoint | Vertex point. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the created vertex. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
DeleteItem(ElementItemId)
Deletes an item of the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void DeleteItem(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the item to delete. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
DeleteItems(List<ElementItemId>)
Deletes items of the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void DeleteItems(List<ElementItemId> inItemIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<ElementItemId> | inItemIds | Identifiers of the items to delete. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
EndModification()
Ends performing modifications on a sketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void EndModification()Remarks
This method must be called after the StartModification(ElementId) method has been called.
This method is available since v7.7.201.80.
FixItem(ElementItemId)
Fix a segment or a vertex in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void FixItem(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the segment or the vertex to fix. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
GetBuildingOperation(ElementId)
Gets the building operation of a sketch entity.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementId GetBuildingOperation(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the building operation, or Empty if the sketch does not have a building operation. |
Remarks
This method is available since v7.7.201.80.
GetFrame(ElementId)
Gets the definition frame of a sketch in a 2D document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
Frame2D GetFrame(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| Frame2D | Definition frame of the sketch. |
Remarks
This method is available since v7.6.
GetPlane(ElementId)
Gets the definition plane of a sketch in a 3D document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
Plane3D GetPlane(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| Plane3D | Definition plane of the sketch. |
Remarks
This method is available since v7.6.
GetProfileCount(ElementId)
Gets the number of profiles of a sketch.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
int GetProfileCount(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of profiles of the sketch. |
Remarks
This method is available since v7.6.
GetProfiles(ElementId)
Gets the profiles of a sketch.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementItemId> GetProfiles(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementItemId> | Identifiers of the profiles of the sketch. |
Remarks
This method is available since v7.7.
GetProfileSegments(ElementItemId)
Gets the segments of a profile.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementItemId> GetProfileSegments(ElementItemId inProfileId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inProfileId | Identifier of the profile to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementItemId> | Identifiers of the segments of the profile. |
Remarks
This method is available since v7.7.
GetSectionCount(ElementId)
Gets the number of sections of a sketch.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
int GetSectionCount(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of sections of the sketch. |
Remarks
This method is available since v7.6.
GetSectionProfiles(ElementItemId)
Gets the profiles of a section.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementItemId> GetSectionProfiles(ElementItemId inSectionId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSectionId | Identifier of the section to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementItemId> | Identifiers of the profiles of the section. |
Remarks
This method is available since v7.7.
GetSections(ElementId)
Gets the sections of a sketch.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementItemId> GetSections(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementItemId> | Identifiers of the sections of the sketch. |
Remarks
This method is available since v7.7.
GetSegmentCenter(ElementItemId)
Gets the center of a segment.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId GetSegmentCenter(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the vertex defined as being the center of the segment, or Empty if none. |
Remarks
A center may only be defined when the segment curve is a circle or an ellipse.
This method is available since v7.7.201.80.
GetSegmentCircleCurve(ElementItemId, out Frame2D, out Double)
Gets the circle curve attached to a segment.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetSegmentCircleCurve(ElementItemId inSegmentId, out Frame2D outFrame, out double outRadius)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| Frame2D | outFrame | Circle frame. |
| System.Double | outRadius | Circle radius. |
Remarks
This method is available since v7.7.
GetSegmentCount(ElementId)
Gets the number of segments of a sketch.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
int GetSegmentCount(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of segments of the sketch. |
Remarks
This method is available since v7.6.
GetSegmentCurveRange(ElementItemId, out Double, out Double)
Gets the parametric range of the curve attached to a segment.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetSegmentCurveRange(ElementItemId inSegmentId, out double outTs, out double outTe)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| System.Double | outTs | Start parameter value. |
| System.Double | outTe | End parameter value. |
Remarks
This method is available since v7.7.
GetSegmentCurveType(ElementItemId)
Gets the type of the curve attached to a segment.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
CurveType GetSegmentCurveType(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
Returns
| Type | Description |
|---|---|
| CurveType | Type of the curve attached to the segment. |
Remarks
This method is available since v7.7.
GetSegmentEllipseCurve(ElementItemId, out Frame2D, out Double, out Double)
Gets the ellipse curve attached to a segment.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void GetSegmentEllipseCurve(ElementItemId inSegmentId, out Frame2D outFrame, out double outRadiusX, out double outRadiusY)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| Frame2D | outFrame | Ellipse frame. |
| System.Double | outRadiusX | Ellipse radius along frame X axis. |
| System.Double | outRadiusY | Ellipse radius along frame Y axis. |
Remarks
This method is available since v7.7.201.80.
GetSegmentLineCurve(ElementItemId, out Axis2D)
Gets the line curve attached to a segment.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetSegmentLineCurve(ElementItemId inSegmentId, out Axis2D outAxis)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| Axis2D | outAxis | Line axis. |
Remarks
This method is available since v7.7.
GetSegmentMiddle(ElementItemId)
Gets the middle of a segment.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
ElementItemId GetSegmentMiddle(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
Returns
| Type | Description |
|---|---|
| ElementItemId | Identifier of the vertex defined as being the middle of the segment, or Empty if none. |
Remarks
A middle may only be defined when the segment curve is a line.
This method is available since v7.7.201.80.
GetSegmentPoint(ElementItemId, Double)
Gets a point on a segment at a specified parametric value.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
Point2D GetSegmentPoint(ElementItemId inSegmentId, double inT)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| System.Double | inT | Parameter within segment parametric range. |
Returns
| Type | Description |
|---|---|
| Point2D | Point on the segment at the specified parametric value. |
Remarks
This method is available since v7.7.
GetSegmentRange(ElementItemId, out Double, out Double)
Gets the parametric range of a segment.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetSegmentRange(ElementItemId inSegmentId, out double outTMin, out double outTMax)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| System.Double | outTMin | Minimum parametric value. |
| System.Double | outTMax | Maximum parametric value. |
Remarks
This method is available since v7.7.
GetSegments(ElementId)
Gets the segments of a sketch.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementItemId> GetSegments(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementItemId> | Identifiers of the segments of the sketch. |
Remarks
This method is available since v7.7.
GetSegmentTangent(ElementItemId, Double)
Gets the tangent of a segment at a specified parametric value.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
Direction2D GetSegmentTangent(ElementItemId inSegmentId, double inT)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| System.Double | inT | Parameter within segment parametric range. |
Returns
| Type | Description |
|---|---|
| Direction2D | Tangent to the segment at the specified parametric value. |
Remarks
If the segment is reversed, the orientation of the tangent is the opposite to the parametric first derivative.
This method is available since v7.7.
GetSegmentVertices(ElementItemId, out ElementItemId, out ElementItemId)
Gets the vertices of a segment.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetSegmentVertices(ElementItemId inSegmentId, out ElementItemId outStartVertexId, out ElementItemId outEndVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
| ElementItemId | outStartVertexId | Identifier of the start vertex, or Empty if none. |
| ElementItemId | outEndVertexId | Identifier of the end vertex, or Empty if none. |
Remarks
This method is available since v7.7.
GetSketches(DocumentId)
Gets the sketches entities that are in the sketches folder of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetSketches(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Sketch entities found. |
Remarks
This method is available since v7.6.
GetSketchesFolder(DocumentId)
Gets the sketches folder entity of a document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetSketchesFolder(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the sketches folder entity found. |
Remarks
This method is available since v7.10.
GetVertexCount(ElementId)
Gets the number of vertices of a sketch.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
int GetVertexCount(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of vertices of the sketch. |
Remarks
This method is available since v7.6.
GetVertexPoint(ElementItemId)
Gets the point attached to a vertex.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
Point2D GetVertexPoint(ElementItemId inVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inVertexId | Identifier of the vertex to analyze. |
Returns
| Type | Description |
|---|---|
| Point2D | Vertex point. |
Remarks
This method is available since v7.7.
GetVertices(ElementId)
Gets the vertices of a sketch.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementItemId> GetVertices(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementItemId> | Identifiers of the vertices of the sketch. |
Remarks
This method is available since v7.7.
IsItemFixed(ElementItemId)
Tells whether a segment or a vertex is fixed.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
bool IsItemFixed(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the segment or the vertex to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the segment or the vertex is fixed. |
Remarks
This method is available since v7.7.201.80.
IsItemInternal(ElementItemId)
Tells whether a segment or a vertex is internal.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
bool IsItemInternal(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the segment or the vertex to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the segment or the vertex is internal. |
Remarks
This method is available since v7.7.201.80.
IsProfileClosed(ElementItemId)
Tells whether a profile is closed.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
bool IsProfileClosed(ElementItemId inProfileId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inProfileId | Identifier of the profile to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the profile is closed. |
Remarks
This method is available since v7.7.
IsSegmentConstruction(ElementItemId)
Tells whether a segment is construction.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
bool IsSegmentConstruction(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the segment is construction. |
Remarks
This method is available since v7.7.201.80.
IsSegmentReversed(ElementItemId)
Tells whether a segment is reversed.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
bool IsSegmentReversed(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the orientation of the segment is the opposite to the parametric orientation of its attached curve. |
Remarks
This method is available since v7.7.
IsSketch(ElementId)
Tells whether an element is a sketch entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
bool IsSketch(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element a sketch entity. |
Remarks
This method is available since v7.6.
IsVertexTemporary(ElementItemId)
Tells whether a vertex is temporary.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
bool IsVertexTemporary(ElementItemId inVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inVertexId | Identifier of the vertex to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the vertex is temporary. |
Remarks
This method is available since v7.7.201.80.
MakeItemInternal(ElementItemId)
Makes a segment or a vertex internal in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void MakeItemInternal(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the segment or the vertex to modify. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
MakeItemNotInternal(ElementItemId)
Makes a segment or a vertex not internal in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void MakeItemNotInternal(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the segment or the vertex to modify. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
MakeSegmentConstruction(ElementItemId)
Makes a segment construction in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void MakeSegmentConstruction(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to modify. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
MakeSegmentNotConstruction(ElementItemId)
Makes a segment not construction in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void MakeSegmentNotConstruction(ElementItemId inSegmentId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to modify. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
MakeVertexNotTemporary(ElementItemId)
Makes a vertex not temporary in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void MakeVertexNotTemporary(ElementItemId inVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inVertexId | Identifier of the vertex to modify. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
MakeVertexTemporary(ElementItemId)
Makes a vertex temporary in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void MakeVertexTemporary(ElementItemId inVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inVertexId | Identifier of the vertex to modify. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
SetSegmentCenter(ElementItemId, ElementItemId)
Sets the center of a segment in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void SetSegmentCenter(ElementItemId inSegmentId, ElementItemId inVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to modify. |
| ElementItemId | inVertexId | Identifier of the vertex defined as being the center of the segment, or Empty if none. |
Remarks
A center may only be defined when the segment curve is a circle or an ellipse.
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
SetSegmentMiddle(ElementItemId, ElementItemId)
Sets the middle of a segment in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void SetSegmentMiddle(ElementItemId inSegmentId, ElementItemId inVertexId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inSegmentId | Identifier of the segment to modify. |
| ElementItemId | inVertexId | Identifier of the vertex defined as being the middle of the segment, or Empty if none. |
Remarks
A middle may only be defined when the segment curve is a line.
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.
StartModification(ElementId)
Starts performing modifications on a sketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void StartModification(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the sketch entity to modify. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.80.
UnfixItem(ElementItemId)
Unfix a segment or a vertex in the ModifiedSketch.
Declaration
[AvailableSinceVersion(7, 7, 201, 80)]
void UnfixItem(ElementItemId inItemId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementItemId | inItemId | Identifier of the segment or the vertex to unfix. |
Remarks
StartModification(ElementId) must be called before calling this method.
This method is available since v7.7.201.80.