Interface IOrigins
Gives access to origins.
Namespace: TopSolid.Cam.NC.Kernel.Automating
Assembly: TopSolid.Cam.NC.Kernel.Automating.dll
Syntax
public interface IOriginsMethods
CreateOrigin(DocumentId, SmartText, ElementId, SmartBoolean, ElementId, ElementId, SmartText)
Creates an origin entity in a document.
Declaration
ElementId CreateOrigin(DocumentId inDocumentId, SmartText inDescription, ElementId inFrameId, SmartBoolean inAutoPos, ElementId inRigidGroupId, ElementId inPartId, SmartText inType)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartText | inDescription | Description. |
| ElementId | inFrameId | Base frame. |
| SmartBoolean | inAutoPos | Automatic positionning flag. |
| ElementId | inRigidGroupId | Machine element associated with this origin. |
| ElementId | inPartId | Part owner of the new origin. |
| SmartText | inType | Type of the origin. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created origin entity. |
GetOriginFrameGeometry(ElementId)
Gets the origin frame geometry.
Declaration
Frame3D GetOriginFrameGeometry(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the origin to analyze. |
Returns
| Type | Description |
|---|---|
| Frame3D | The frame geometry. |
GetOriginPart(ElementId)
Gets the origin part.
Declaration
ElementId GetOriginPart(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the origin to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | The part. |
GetOriginRigidGroup(ElementId)
Gets the origin rigid group.
Declaration
ElementId GetOriginRigidGroup(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the origin to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | The rigid group. |
GetOrigins(DocumentId)
Gets the origins in a document.
Declaration
List<ElementId> GetOrigins(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | The origin entities of the document. |
IsOrigin(ElementId)
Tells whether an element is an origin.
Declaration
bool IsOrigin(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the element is an origin. |
UpdateOrigin(ElementId, ElementId, ElementId, SmartText)
Updates an existing Origin entity.
Declaration
void UpdateOrigin(ElementId inOrigninId, ElementId inPointId, ElementId inFrameId, SmartText inType)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inOrigninId | Identifier of the origin to analyze, or null. |
| ElementId | inPointId | Identifier of the origin's point, or ElementId.empty. |
| ElementId | inFrameId | Identifier of the origin's frame, or ElementId.empty. |
| SmartText | inType | Type text description, or null. |