Interface IWorldCoordinateSystems

Gives access to WCSs.

Namespace: TopSolid.Cam.NC.Kernel.Automating

Assembly: TopSolid.Cam.NC.Kernel.Automating.dll

Syntax

public interface IWorldCoordinateSystems

Methods

CreateWorldCoordinateSystem(DocumentId, ElementId, ElementId, ElementId, ElementId, SmartBoolean)

Creates a WCS entity in a document.

Declaration

ElementId CreateWorldCoordinateSystem(DocumentId inDocumentId, ElementId inFrameId, ElementId inPartId, ElementId inToolHolderId, ElementId inOriginId, SmartBoolean inInclinedPlanesMatrixUsed)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inFrameId	Base frame.
ElementId	inPartId
ElementId	inToolHolderId	Associated tool holder.
ElementId	inOriginId
SmartBoolean	inInclinedPlanesMatrixUsed

Returns

Type	Description
ElementId	Identifier of the created WCS entity.

GetParameters(ElementId)

Gets the parameters of the given WCS.

Declaration

List<ParameterId> GetParameters(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.

Returns

Type	Description
System.Collections.Generic.List<ParameterId>	WCS parameters found.

GetWcsFrameGeometry(ElementId)

Gets the WCS frame geometry.

Declaration

Frame3D GetWcsFrameGeometry(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.

Returns

Type	Description
Frame3D	The geometry of the frame.

GetWcsOrigin(ElementId)

Gets the WCS origin.

Declaration

ElementId GetWcsOrigin(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.

Returns

Type	Description
ElementId	The origin.

GetWcsPart(ElementId)

Gets the WCS part.

Declaration

ElementId GetWcsPart(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.

Returns

Type	Description
ElementId	The part.

GetWCSs(DocumentId)

Gets the wcs in a document.

Declaration

List<ElementId> GetWCSs(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	The WCS entities of the document.

GetWcsSolution(ElementId, Int32)

Gets the WCS solution.

Declaration

ElementId GetWcsSolution(ElementId inElementId, int inIndex)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.
System.Int32	inIndex	Index of the solution.

Returns

Type	Description
ElementId	The solution.

GetWcsSolutionFrameGeometry(ElementId)

Gets the WCS solution frame.

Declaration

Frame3D GetWcsSolutionFrameGeometry(ElementId inSolutionId)

Parameters

Type	Name	Description
ElementId	inSolutionId	Identifier of the solution to analyze.

Returns

Type	Description
Frame3D	The Wcs solution frame geometry.

GetWcsSolutionsCount(ElementId)

Gets the WCS solutions count.

Declaration

int GetWcsSolutionsCount(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.

Returns

Type	Description
System.Int32	The count of solutions.

GetWcsToolHolder(ElementId)

Gets the WCS tool holder.

Declaration

ElementId GetWcsToolHolder(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the WCS to analyze.

Returns

Type	Description
ElementId	The tool holder.

IsWorldCoordinateSystem(ElementId)

Tells whether an element is a WCS.

Declaration

bool IsWorldCoordinateSystem(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element to analyze.

Returns

Type	Description
System.Boolean	True if the element is a WCS.