Skip to main content

Mechanical scripting interface

ConstructionGeometry

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ConstructionGeometry

Bases: object

Defines a ConstructionGeometry.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddConstructionLine Creates a new ConstructionLine
AddConstructionPoint Creates a new ConstructionPoint
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddPath Creates a new Path
AddSTL Creates a new STL
AddSolid Creates a new Solid
AddSurface Creates a new Surface
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
UpdateAllSolids Update all solid parts under the Construction Geometry folder.
UpdateSolids Update only the solids that are activated

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Properties Gets the list of properties for this object.
ShowMesh Gets or sets the ShowMesh.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property ConstructionGeometry.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property ConstructionGeometry.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property ConstructionGeometry.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property ConstructionGeometry.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property ConstructionGeometry.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property ConstructionGeometry.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSConstructionGeometryGroupAuto | None

Gets the internal object. For advanced usage only.

property ConstructionGeometry.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property ConstructionGeometry.ShowMesh : bool | None

Gets or sets the ShowMesh.

property ConstructionGeometry.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

ConstructionGeometry.Activate()

Activate the current object.

ConstructionGeometry.AddComment()

Creates a new child Comment.

ConstructionGeometry.AddConstructionLine()

Creates a new ConstructionLine

ConstructionGeometry.AddConstructionPoint()

Creates a new ConstructionPoint

ConstructionGeometry.AddFigure()

Creates a new child Figure.

ConstructionGeometry.AddImage(filePath: str)

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

ConstructionGeometry.AddPath()

Creates a new Path

ConstructionGeometry.AddSTL()

Creates a new STL

ConstructionGeometry.AddSolid()

Creates a new Solid

ConstructionGeometry.AddSurface()

Creates a new Surface

ConstructionGeometry.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ConstructionGeometry.CreateParameter(propName: str)

Creates a new parameter for a Property.

ConstructionGeometry.Delete()

Run the Delete action.

ConstructionGeometry.Duplicate()

Creates a copy of the current DataModelObject.

ConstructionGeometry.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

ConstructionGeometry.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ConstructionGeometry.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ConstructionGeometry.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ConstructionGeometry.PropertyByAPIName(name: str)

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

ConstructionGeometry.PropertyByName(name: str)

Get a property by its unique name.

ConstructionGeometry.RemoveParameter(propName: str)

Removes the parameter from the parameter set corresponding to the given property.

ConstructionGeometry.UpdateAllSolids()

Update all solid parts under the Construction Geometry folder.

ConstructionGeometry.UpdateSolids()

Update only the solids that are activated