Mechanical scripting interface 2026 R1

`AMSupportGroup`

Last update: 09.03.2026

class Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.AMSupportGroup

Bases: object

Defines a AMSupportGroup.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddGeneratedAMSupport Creates a new GeneratedAMSupport
AddImage Creates a new child Image.
AddPredefinedAMSupport Creates a new PredefinedAMSupport
AddSTLAMSupport Creates a new GeneratedAMSupport
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
DetectSupportFaces Runs the Detect Support Faces 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.
PromoteToNamedSelection Run the PromoteToNamedSelection 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.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject's category.
DetectAboveZLocation Gets or sets the DetectAboveZLocation.
Figures Gets the list of associated figures.
GenerateOnRemesh Gets or sets the GenerateOnRemesh.
HangAngle Gets or sets the HangAngle.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
OutputType Gets or sets the OutputType.
Properties Gets the list of properties for this object.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property AMSupportGroup.DetectAboveZLocation : Ansys.Core.Units.Quantity | None

Gets or sets the DetectAboveZLocation.

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

Gets the list of associated figures.

property AMSupportGroup.GenerateOnRemesh : bool | None

Gets or sets the GenerateOnRemesh.

property AMSupportGroup.HangAngle : Ansys.Core.Units.Quantity | None

Gets or sets the HangAngle.

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

Gets the list of associated images.

property AMSupportGroup.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAMSupportGroupAuto | None

Gets the internal object. For advanced usage only.

property AMSupportGroup.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property AMSupportGroup.OutputType : Ansys.Mechanical.DataModel.Enums.AMSupportGroupOutputType | None

Gets or sets the OutputType.

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

Gets the list of properties for this object.

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

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

Method detail

AMSupportGroup.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

AMSupportGroup.AddGeneratedAMSupport() → Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.GeneratedAMSupport

Creates a new GeneratedAMSupport

AMSupportGroup.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.

AMSupportGroup.AddPredefinedAMSupport() → Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.PredefinedAMSupport

Creates a new PredefinedAMSupport

AMSupportGroup.AddSTLAMSupport() → Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.STLAMSupport

Creates a new GeneratedAMSupport

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

AMSupportGroup.Delete() → None

Run the Delete action.

AMSupportGroup.DetectSupportFaces() → Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Runs the Detect Support Faces action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

AMSupportGroup.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

AMSupportGroup.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

AMSupportGroup.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.

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

Get a property by its unique name.

AMSupportGroup.RemoveParameter(propName: str) → None

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

Connect with Ansys