`STL`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.STL#

Bases: object

Defines a STL.

Overview#

Methods

`ExportStl`	Export STL data.
`ImportSTL`	Run the ImportSTL action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

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

Property detail#

property STL.TranslateX: System.Double | None: Gets or sets the TranslateX.

property STL.Color: System.Int32 | None: Gets or sets the Color.

property STL.TranslateY: System.Double | None: Gets or sets the TranslateY.

property STL.TranslateZ: System.Double | None: Gets or sets the TranslateZ.

property STL.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSGeometryFileContainerAuto | None: Gets the internal object. For advanced usage only.

property STL.FileName: System.String | None: Gets or sets the FileName.

property STL.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property STL.Statistics: System.Int32 | None: Gets the Statistics.

property STL.LengthUnits: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None: Gets or sets the LengthUnits.

property STL.ShowAlways: System.Boolean | None: Gets or sets the ShowAlways.

property STL.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property STL.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property STL.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property STL.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property STL.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property STL.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property STL.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property STL.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property STL.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

STL.ExportStl(filename: System.String, progress: Ansys.Mechanical.Application.Progress) → System.Void: Export STL data.

STL.ImportSTL() → System.Void: Run the ImportSTL action.

STL.Delete() → System.Void: Run the Delete action.

STL.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

STL.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

STL.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

STL.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

STL.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

STL.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

STL.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

STL.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

STL.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

STL.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.