Interface IGeometries3D
Gives access to 3D geometric entities.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IGeometries3DRemarks
This interface is available since v7.6.
Methods
CreateAxis(DocumentId, Axis3D)
Creates an axis entity in a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateAxis(DocumentId inDocumentId, Axis3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Axis3D | 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, Axis3D, Double, Double)
Creates an axis entity with specified extent in a document.
Declaration
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId CreateAxisWithExtent(DocumentId inDocumentId, Axis3D inGeometry, double inXMin, double inXMax)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Axis3D | 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, Frame3D)
Creates a frame entity in a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateFrame(DocumentId inDocumentId, Frame3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Frame3D | 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.
CreateFrameByPointAndTwoDirections(DocumentId, SmartPoint3D, SmartDirection3D, SmartDirection3D, Boolean)
Creates a frame entity in a document by point and two directions.
Declaration
[AvailableSinceVersion(7, 18, 400, 6000)]
ElementId CreateFrameByPointAndTwoDirections(DocumentId inDocumentId, SmartPoint3D inOrigin, SmartDirection3D inFirstDirection, SmartDirection3D inSecondDirection, bool isSecondDirectionOY)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartPoint3D | inOrigin | Frame origin. |
| SmartDirection3D | inFirstDirection | First direction. |
| SmartDirection3D | inSecondDirection | Second direction. |
| Boolean | isSecondDirectionOY | whether second direction is OY. |
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.
CreateFrameWithOffset(DocumentId, SmartFrame3D, SmartDirection3D, SmartReal)
Creates a frame entity in a document by offset.
Declaration
[AvailableSinceVersion(7, 18, 400, 600)]
ElementId CreateFrameWithOffset(DocumentId inDocumentId, SmartFrame3D inFrame, SmartDirection3D inOffsetDirection, SmartReal inOffsetDistance)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartFrame3D | inFrame | Original Frame. |
| SmartDirection3D | inOffsetDirection | Offset direction. |
| SmartReal | inOffsetDistance | Offset value. |
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.
CreateOffsetPoint(DocumentId, SmartPoint3D, SmartDirection3D, SmartReal)
Creates an offset point creation operation in a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateOffsetPoint(DocumentId inDocumentId, SmartPoint3D inOrigin, SmartDirection3D inDirection, SmartReal inDistance)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartPoint3D | inOrigin | Origin point. |
| SmartDirection3D | inDirection | Offset direction. |
| SmartReal | inDistance | Offset distance. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created operation child point entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreatePlane(DocumentId, Plane3D)
Creates a plane entity in a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreatePlane(DocumentId inDocumentId, Plane3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Plane3D | inGeometry | Plane geometry. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created plane entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
CreatePlaneWithExtent(DocumentId, Plane3D, Double, Double, Double, Double)
Creates a plane entity with specified extent in a document.
Declaration
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId CreatePlaneWithExtent(DocumentId inDocumentId, Plane3D inGeometry, double inXMin, double inXMax, double inYMin, double inYMax)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Plane3D | inGeometry | Plane geometry. |
| Double | inXMin | Minimum X plane coordinate of extent. |
| Double | inXMax | Maximum X plane coordinate of extent. |
| Double | inYMin | Minimum Y plane coordinate of extent. |
| Double | inYMax | Maximum Y plane coordinate of extent. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created plane 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.
CreatePoint(DocumentId, Point3D)
Creates a point entity in a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreatePoint(DocumentId inDocumentId, Point3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Point3D | 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.
CreateSmartFrame(DocumentId, SmartFrame3D)
Creates a frame entity with a provided smart frame in a document.
Declaration
[AvailableSinceVersion(7, 15, 400, 120)]
ElementId CreateSmartFrame(DocumentId inDocumentId, SmartFrame3D inProvidedSmartFrame)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartFrame3D | inProvidedSmartFrame | The provided smart frame. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created frame entity. |
Remarks
This method allows to create a frame entity associated to an operation.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.15.400.120.
GetAbsoluteFrame(DocumentId)
Gets the absolute frame entity of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetAbsoluteOriginPoint(DocumentId)
Gets the absolute origin point entity of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetAbsoluteXAxis(DocumentId)
Gets the absolute X axis entity of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetAbsoluteXYPlane(DocumentId)
Gets the absolute XY plane entity of a document.
Declaration
ElementId GetAbsoluteXYPlane(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the absolute XY plane entity found. |
GetAbsoluteXZPlane(DocumentId)
Gets the absolute XZ plane entity of a document.
Declaration
ElementId GetAbsoluteXZPlane(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the absolute XZ plane entity found. |
GetAbsoluteYAxis(DocumentId)
Gets the absolute Y axis entity of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetAbsoluteYZPlane(DocumentId)
Gets the absolute YZ plane entity of a document.
Declaration
ElementId GetAbsoluteYZPlane(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the absolute YZ plane entity found. |
GetAbsoluteZAxis(DocumentId)
Gets the absolute Z axis entity of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetAbsoluteZAxis(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the absolute Z axis entity found. |
Remarks
This method is available since v7.6.
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)]
Axis3D GetAxisGeometry(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the axis entity to analyze. |
Returns
| Type | Description |
|---|---|
| Axis3D | 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, 6, 0, 0)]
Axis3D 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 |
|---|---|
| Axis3D | Axis geometry. |
Remarks
This method is available since v7.6.
GetAxisPublishingDefinition(ElementId)
Gets the definition of an axis publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
SmartAxis3D GetAxisPublishingDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to analyze. |
Returns
| Type | Description |
|---|---|
| SmartAxis3D |
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)]
Frame3D GetFrameGeometry(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the frame entity to analyze. |
Returns
| Type | Description |
|---|---|
| Frame3D | 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)]
SmartFrame3D GetFramePublishingDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to analyze. |
Returns
| Type | Description |
|---|---|
| SmartFrame3D |
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 3D 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)]
Transform3D GetOccurrenceDefinitionTransform(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| Transform3D | 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)]
Transform3D GetOccurrenceSourceTransform(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| Transform3D | Identifier of the source transform of the occurrence. |
Remarks
This method is available since v7.6.
GetOffsetPointCreation(ElementId, out SmartPoint3D, out SmartDirection3D, out SmartReal)
Gets an offset point creation operation.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void GetOffsetPointCreation(ElementId inElementId, out SmartPoint3D outOrigin, out SmartDirection3D outDirection, out SmartReal outDistance)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the offset point creation operation to analyze. |
| SmartPoint3D | outOrigin | Origin point. |
| SmartDirection3D | outDirection | Offset direction. |
| SmartReal | outDistance | Offset distance. |
Remarks
This method is available since v7.8.
GetPlaneGeometry(ElementId)
Gets the geometry of a plane entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
Plane3D GetPlaneGeometry(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the plane entity to analyze. |
Returns
| Type | Description |
|---|---|
| Plane3D | Plane geometry. |
Remarks
This method is available since v7.6.
GetPlaneGeometryWithExtent(ElementId, out Double, out Double, out Double, out Double)
Gets the geometry and the extent of a plane entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
Plane3D GetPlaneGeometryWithExtent(ElementId inElementId, out double outXMin, out double outXMax, out double outYMin, out double outYMax)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the plane entity to analyze. |
| Double | outXMin | Minimum X plane coordinate of extent. |
| Double | outXMax | Maximum X plane coordinate of extent. |
| Double | outYMin | Minimum Y plane coordinate of extent. |
| Double | outYMax | Maximum Y plane coordinate of extent. |
Returns
| Type | Description |
|---|---|
| Plane3D | Plane geometry. |
Remarks
This method is available since v7.6.
GetPlanePublishingDefinition(ElementId)
Gets the definition of a plane publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
SmartPlane3D GetPlanePublishingDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to analyze. |
Returns
| Type | Description |
|---|---|
| SmartPlane3D |
Remarks
The geometry of the publishing entity may be obtained with the GetPlaneGeometry(ElementId) method.
This method is available since v7.8.
GetPlanes(DocumentId)
Gets the planes entities that are in the planes folder of a document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetPlanes(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Planes entities found. |
Remarks
This method is available since v7.6.
GetPlanesFolder(DocumentId)
Gets the planes folder entity of a document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetPlanesFolder(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the planes folder entity found. |
Remarks
This method is available since v7.10.
GetPointGeometry(ElementId)
Gets the geometry of a point entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
Point3D GetPointGeometry(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the point entity to analyze. |
Returns
| Type | Description |
|---|---|
| Point3D | 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)]
SmartPoint3D GetPointPublishingDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to analyze. |
Returns
| Type | Description |
|---|---|
| SmartPoint3D |
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.
GetSectionPublishingDefinition(ElementId)
Gets the definition of a section publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 302, 80)]
SmartSection3D GetSectionPublishingDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to analyze. |
Returns
| Type | Description |
|---|---|
| SmartSection3D |
Remarks
This method is available since v7.8.302.80.
PublishAxis(DocumentId, String, SmartAxis3D)
Creates an axis publishing entity in a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishAxis(DocumentId inDocumentId, string inDescription, SmartAxis3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| String | inDescription | Publishing description. |
| SmartAxis3D | 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, SmartFrame3D)
Creates a frame publishing entity in a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishFrame(DocumentId inDocumentId, string inDescription, SmartFrame3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| String | inDescription | Publishing description. |
| SmartFrame3D | 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.
PublishPlane(DocumentId, String, SmartPlane3D)
Creates a plane publishing entity in a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishPlane(DocumentId inDocumentId, string inDescription, SmartPlane3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| String | inDescription | Publishing description. |
| SmartPlane3D | 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, SmartPoint3D)
Creates a point publishing entity in a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishPoint(DocumentId inDocumentId, string inDescription, SmartPoint3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| String | inDescription | Publishing description. |
| SmartPoint3D | 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.
PublishSection(DocumentId, String, SmartSection3D)
Creates a section publishing entity in a document.
Declaration
[AvailableSinceVersion(7, 8, 302, 80)]
ElementId PublishSection(DocumentId inDocumentId, string inDescription, SmartSection3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| String | inDescription | Publishing description. |
| SmartSection3D | 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.302.80.
SetAxisGeometry(ElementId, Axis3D)
Sets the geometry of an axis entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void SetAxisGeometry(ElementId inElementId, Axis3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the axis entity to modify. |
| Axis3D | 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, Axis3D, Double, Double)
Sets the geometry and the extent of an axis entity.
Declaration
[AvailableSinceVersion(7, 7, 201, 100)]
void SetAxisGeometryWithExtent(ElementId inElementId, Axis3D inGeometry, double inXMin, double inXMax)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the axis entity to modify. |
| Axis3D | 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, SmartAxis3D)
Sets the definition of an axis publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetAxisPublishingDefinition(ElementId inElementId, SmartAxis3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to modify. |
| SmartAxis3D | 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, Frame3D)
Sets the geometry of a frame entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void SetFrameGeometry(ElementId inElementId, Frame3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the frame entity to modify. |
| Frame3D | 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, SmartFrame3D)
Sets the definition of a frame publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetFramePublishingDefinition(ElementId inElementId, SmartFrame3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to modify. |
| SmartFrame3D | 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.
SetOffsetPointCreation(ElementId, SmartPoint3D, SmartDirection3D, SmartReal)
Sets an offset point creation operation.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetOffsetPointCreation(ElementId inElementId, SmartPoint3D inOrigin, SmartDirection3D inDirection, SmartReal inDistance)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the offset point creation operation to modify. |
| SmartPoint3D | inOrigin | Origin point. |
| SmartDirection3D | inDirection | Offset direction. |
| SmartReal | inDistance | Offset distance. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
SetPlaneGeometry(ElementId, Plane3D)
Sets the geometry of a plane entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void SetPlaneGeometry(ElementId inElementId, Plane3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the plane entity to modify. |
| Plane3D | inGeometry | New plane geometry. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.6.
SetPlaneGeometryWithExtent(ElementId, Plane3D, Double, Double, Double, Double)
Sets the geometry and the extent of a plane entity.
Declaration
[AvailableSinceVersion(7, 7, 201, 100)]
void SetPlaneGeometryWithExtent(ElementId inElementId, Plane3D inGeometry, double inXMin, double inXMax, double inYMin, double inYMax)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the plane entity to modify. |
| Plane3D | inGeometry | New plane geometry. |
| Double | inXMin | Minimum X plane coordinate of extent. |
| Double | inXMax | Maximum X plane coordinate of extent. |
| Double | inYMin | Minimum Y plane coordinate of extent. |
| Double | inYMax | Maximum Y plane 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.
SetPlanePublishingDefinition(ElementId, SmartPlane3D)
Sets the definition of a plane publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetPlanePublishingDefinition(ElementId inElementId, SmartPlane3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to modify. |
| SmartPlane3D | 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, Point3D)
Sets the geometry of a point entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void SetPointGeometry(ElementId inElementId, Point3D inGeometry)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the point entity to modify. |
| Point3D | 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, SmartPoint3D)
Sets the definition of a point publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetPointPublishingDefinition(ElementId inElementId, SmartPoint3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to modify. |
| SmartPoint3D | 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.
SetPointPublishingDefinitionList(ElementId, List<SmartPoint3D>)
Sets the definition of a point publishing list entity.
Declaration
[AvailableSinceVersion(7, 16, 400, 0)]
void SetPointPublishingDefinitionList(ElementId inElementId, List<SmartPoint3D> inDefinitions)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing list entity to modify. |
| List<SmartPoint3D> | inDefinitions | Publishing new definitions. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.16.400.
SetSectionPublishingDefinition(ElementId, SmartSection3D)
Sets the definition of a section publishing entity.
Declaration
[AvailableSinceVersion(7, 8, 302, 80)]
void SetSectionPublishingDefinition(ElementId inElementId, SmartSection3D inDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the publishing entity to modify. |
| SmartSection3D | 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.302.80.