Mechanical scripting interface 2025

`STL`

Last update: 09.03.2026

class Ansys.ACT.Automation.Mechanical.STL

Bases: object

Defines a STL.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
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.
ExportStl Export STL data.
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.
ImportSTL Run the ImportSTL 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.

Properties

Name Description
Children Gets the list of children.
Color Gets or sets the Color.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
FileName Gets or sets the FileName.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LengthUnits Gets or sets the LengthUnits.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ShowAlways Gets or sets the ShowAlways.
Statistics Gets the Statistics.
Suppressed Gets or sets the Suppressed.
TranslateX Gets or sets the TranslateX.
TranslateY Gets or sets the TranslateY.
TranslateZ Gets or sets the TranslateZ.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

property STL.Color : int | None

Gets or sets the Color.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property STL.FileName : str | None

Gets or sets the FileName.

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

Gets the list of associated images.

property STL.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSGeometryFileContainerAuto | None

Gets the internal object. For advanced usage only.

property STL.LengthUnits : Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None

Gets or sets the LengthUnits.

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

Gets the list of properties for this object.

property STL.ReadOnly : bool | None

Gets or sets the ReadOnly.

property STL.ShowAlways : bool | None

Gets or sets the ShowAlways.

property STL.Statistics : int | None

Gets the Statistics.

property STL.Suppressed : bool | None

Gets or sets the Suppressed.

property STL.TranslateX : float | None

Gets or sets the TranslateX.

property STL.TranslateY : float | None

Gets or sets the TranslateY.

property STL.TranslateZ : float | None

Gets or sets the TranslateZ.

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

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

Method detail

STL.Activate() → None

Activate the current object.

STL.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

STL.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

STL.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

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.

STL.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

STL.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

STL.Delete() → None

Run the Delete action.

STL.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

STL.ExportStl(filename: str, progress: Ansys.Mechanical.Application.Progress) → None

Export STL data.

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

Gets the list of children, filtered by type.

STL.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

STL.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

STL.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

STL.ImportSTL() → None

Run the ImportSTL action.

STL.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

STL.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

STL.RemoveParameter(propName: str) → None

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

Connect with Ansys