BodyMerge

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BodyMerge(internalObject: Any)

Bases: object

Body Merge is used to combine multiple geometric bodies with shared faces into a single merged body.

Overview

Constructors

UndoAll

UndoAll method.

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
Operator	Operator method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
CanRemove	CanRemove property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
MergedBodies	Get collection of resultant bodies. Throws an exception if the BodyMerge operation hasn't been executed.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PreAction	PreAction property.
PreBodyMerge	PreBodyMerge property.
PreSuppressAction	PreSuppressAction property.
PreUnSuppressAction	PreUnSuppressAction property.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property BodyMerge.AttachedRefs: List[int] | None

AttachedRefs property.

property BodyMerge.CanRemove: bool | None

CanRemove property.

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

Gets the list of children.

property BodyMerge.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property BodyMerge.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property BodyMerge.IconName: str | None

IconName property.

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

Gets the list of associated images.

property BodyMerge.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSBodyMergeTreeNodeAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property BodyMerge.MergedBodies: Iterable[Ansys.ACT.Interfaces.Geometry.IGeoBody] | None

Get collection of resultant bodies. Throws an exception if the BodyMerge operation hasn't been executed.

property BodyMerge.Name: str | None

Name property.

property BodyMerge.ObjectId: int | None

ObjectId property.

property BodyMerge.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property BodyMerge.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property BodyMerge.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property BodyMerge.PreAction: System.Action | None

PreAction property.

property BodyMerge.PreBodyMerge: System.Action | None

PreBodyMerge property.

property BodyMerge.PreSuppressAction: System.Action | None

PreSuppressAction property.

property BodyMerge.PreUnSuppressAction: System.Action | None

PreUnSuppressAction property.

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

Gets the list of properties for this object.

property BodyMerge.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property BodyMerge.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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

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

Method detail

BodyMerge.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

BodyMerge.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

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

Creates a copy of the current DataModelObject.

BodyMerge.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

BodyMerge.GetAPIName(dispId: int) → str

Property name bound to dispId.

BodyMerge.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

BodyMerge.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

BodyMerge.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

BodyMerge.GetHashCode() → int

GetHashCode method.

BodyMerge.GetIconFile() → System.Byte

GetIconFile method.

BodyMerge.GetLifetimeService() → Any

GetLifetimeService method.

BodyMerge.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

BodyMerge.GetPath() → str

GetPath method.

BodyMerge.GetPropertyName(dispId: int) → str

GetPropertyName method.

BodyMerge.GetPropertyValue(name: str) → Any

GetPropertyValue method.

BodyMerge.GetType() → type

GetType method.

BodyMerge.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

BodyMerge.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

BodyMerge.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

BodyMerge.InitializeLifetimeService() → Any

InitializeLifetimeService method.

BodyMerge.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

BodyMerge.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

BodyMerge.Operator() → Ansys.Simulation.Mechanical.Engine.Interop.OperatorGraph.IAnsBodyMergeOperatorCOM

Operator method.

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

BodyMerge.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

BodyMerge.RemoveParameter(propName: str) → None

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

BodyMerge.ToString() → str

ToString method.

classmethod BodyMerge.UndoAll() → None

UndoAll method.