Interface IGeometries2D

Gives access to 2D geometric entities.

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 6, 0, 0)]
public interface IGeometries2D

Remarks

This interface is available since v7.6.

Methods

CreateAxis(DocumentId, Axis2D)

Creates an axis entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateAxis(DocumentId inDocumentId, Axis2D inGeometry)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Axis2D	inGeometry	Axis geometry.

Returns

Type	Description
ElementId	Identifier of the created axis entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

CreateAxisWithExtent(DocumentId, Axis2D, Double, Double)

Creates an axis entity with specified extent in a document.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
ElementId CreateAxisWithExtent(DocumentId inDocumentId, Axis2D inGeometry, double inXMin, double inXMax)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Axis2D	inGeometry	Axis geometry.
Double	inXMin	Minimum X axis coordinate of extent.
Double	inXMax	Maximum X axis coordinate of extent.

Returns

Type	Description
ElementId	Identifier of the created axis entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.7.201.100.

CreateFrame(DocumentId, Frame2D)

Creates a frame entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateFrame(DocumentId inDocumentId, Frame2D inGeometry)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Frame2D	inGeometry	Frame geometry.

Returns

Type	Description
ElementId	Identifier of the created frame entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

CreatePoint(DocumentId, Point2D)

Creates a point entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreatePoint(DocumentId inDocumentId, Point2D inGeometry)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Point2D	inGeometry	Point geometry.

Returns

Type	Description
ElementId	Identifier of the created point entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

GetAbsoluteFrame(DocumentId)

Gets the absolute frame entity of a document.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetAbsoluteFrame(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the absolute frame entity found.

Remarks

This method is available since v7.7.201.100.

GetAbsoluteOriginPoint(DocumentId)

Gets the absolute origin point entity of a document.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetAbsoluteOriginPoint(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the absolute origin point entity found.

Remarks

This method is available since v7.7.201.100.

GetAbsoluteXAxis(DocumentId)

Gets the absolute X axis entity of a document.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetAbsoluteXAxis(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the absolute X axis entity found.

Remarks

This method is available since v7.7.201.100.

GetAbsoluteYAxis(DocumentId)

Gets the absolute Y axis entity of a document.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetAbsoluteYAxis(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the absolute Y axis entity found.

Remarks

This method is available since v7.7.201.100.

GetAxes(DocumentId)

Gets the axes entities that are in the axes folder of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetAxes(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
List<ElementId>	Axes entities found.

Remarks

This method is available since v7.6.

GetAxesFolder(DocumentId)

Gets the axes folder entity of a document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetAxesFolder(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the axes folder entity found.

Remarks

This method is available since v7.10.

GetAxisGeometry(ElementId)

Gets the geometry of an axis entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
Axis2D GetAxisGeometry(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the axis entity to analyze.

Returns

Type	Description
Axis2D	Axis geometry.

Remarks

This method is available since v7.6.

GetAxisGeometryWithExtent(ElementId, out Double, out Double)

Gets the geometry and the extent of an axis entity.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
Axis2D GetAxisGeometryWithExtent(ElementId inElementId, out double outXMin, out double outXMax)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the axis entity to analyze.
Double	outXMin	Minimum X axis coordinate of extent.
Double	outXMax	Maximum X axis coordinate of extent.

Returns

Type	Description
Axis2D	Axis geometry.

Remarks

This method is available since v7.7.201.100.

GetAxisPublishingDefinition(ElementId)

Gets the definition of an axis publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartAxis2D GetAxisPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartAxis2D

Remarks

The geometry of the publishing entity may be obtained with the GetAxisGeometry(ElementId) method.

This method is available since v7.8.

GetFrameGeometry(ElementId)

Gets the geometry of a frame entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
Frame2D GetFrameGeometry(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the frame entity to analyze.

Returns

Type	Description
Frame2D	Frame geometry.

Remarks

This method is available since v7.6.

GetFramePublishingDefinition(ElementId)

Gets the definition of a frame publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartFrame2D GetFramePublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartFrame2D

Remarks

The geometry of the publishing entity may be obtained with the GetFrameGeometry(ElementId) method.

This method is available since v7.8.

GetFrames(DocumentId)

Gets the frames entities that are in the frames folder of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetFrames(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
List<ElementId>	Frames entities found.

Remarks

This method is available since v7.6.

GetFramesFolder(DocumentId)

Gets the frames folder entity of a document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetFramesFolder(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the frames folder entity found.

Remarks

This method is available since v7.10.

GetGeometryType(ElementId)

Gets the type of a geometric entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
GeometryType GetGeometryType(ElementId inElementId)

Parameters

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

Returns

Type	Description
GeometryType	Type of the geometric entity, or None if the element is not a 2D geometric entity.

Remarks

This method is available since v7.6.

GetOccurrenceDefinitionTransform(ElementId)

Gets the definition transform of an occurrence entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
Transform2D GetOccurrenceDefinitionTransform(ElementId inElementId)

Parameters

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

Returns

Type	Description
Transform2D	Identifier of the definition transform of the occurrence.

Remarks

This method is available since v7.6.

GetOccurrenceSourceTransform(ElementId)

Gets the source transform of an occurrence entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
Transform2D GetOccurrenceSourceTransform(ElementId inElementId)

Parameters

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

Returns

Type	Description
Transform2D	Identifier of the source transform of the occurrence.

Remarks

This method is available since v7.6.

GetPointGeometry(ElementId)

Gets the geometry of a point entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
Point2D GetPointGeometry(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the point entity to analyze.

Returns

Type	Description
Point2D	Point geometry.

Remarks

This method is available since v7.6.

GetPointPublishingDefinition(ElementId)

Gets the definition of a point publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartPoint2D GetPointPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartPoint2D

Remarks

The geometry of the publishing entity may be obtained with the GetPointGeometry(ElementId) method.

This method is available since v7.8.

GetPoints(DocumentId)

Gets the points entities that are in the points folder of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetPoints(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
List<ElementId>	Points entities found.

Remarks

This method is available since v7.6.

GetPointsFolder(DocumentId)

Gets the points folder entity of a document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetPointsFolder(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the points folder entity found.

Remarks

This method is available since v7.10.

PublishAxis(DocumentId, String, SmartAxis2D)

Creates an axis publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishAxis(DocumentId inDocumentId, string inDescription, SmartAxis2D inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
String	inDescription	Publishing description.
SmartAxis2D	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishFrame(DocumentId, String, SmartFrame2D)

Creates a frame publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishFrame(DocumentId inDocumentId, string inDescription, SmartFrame2D inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
String	inDescription	Publishing description.
SmartFrame2D	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishPoint(DocumentId, String, SmartPoint2D)

Creates a point publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishPoint(DocumentId inDocumentId, string inDescription, SmartPoint2D inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
String	inDescription	Publishing description.
SmartPoint2D	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetAxisGeometry(ElementId, Axis2D)

Sets the geometry of an axis entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetAxisGeometry(ElementId inElementId, Axis2D inGeometry)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the axis entity to modify.
Axis2D	inGeometry	New axis geometry.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetAxisGeometryWithExtent(ElementId, Axis2D, Double, Double)

Sets the geometry and the extent of an axis entity.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
void SetAxisGeometryWithExtent(ElementId inElementId, Axis2D inGeometry, double inXMin, double inXMax)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the axis entity to modify.
Axis2D	inGeometry	New axis geometry.
Double	inXMin	Minimum X axis coordinate of extent.
Double	inXMax	Maximum X axis coordinate of extent.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.7.201.100.

SetAxisPublishingDefinition(ElementId, SmartAxis2D)

Sets the definition of an axis publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetAxisPublishingDefinition(ElementId inElementId, SmartAxis2D inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartAxis2D	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetFrameGeometry(ElementId, Frame2D)

Sets the geometry of a frame entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetFrameGeometry(ElementId inElementId, Frame2D inGeometry)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the frame entity to modify.
Frame2D	inGeometry	New frame geometry.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetFramePublishingDefinition(ElementId, SmartFrame2D)

Sets the definition of a frame publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetFramePublishingDefinition(ElementId inElementId, SmartFrame2D inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartFrame2D	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetPointGeometry(ElementId, Point2D)

Sets the geometry of a point entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetPointGeometry(ElementId inElementId, Point2D inGeometry)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the point entity to modify.
Point2D	inGeometry	New point geometry.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetPointPublishingDefinition(ElementId, SmartPoint2D)

Sets the definition of a point publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetPointPublishingDefinition(ElementId inElementId, SmartPoint2D inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartPoint2D	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.