MorphingRegion#

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

Bases: object

Defines a MorphingRegion.

Overview#

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.

Delete

Run the Delete action.

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.

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.

AttachedRefs

AttachedRefs property.

BaseFrequency

Gets or sets the BaseFrequency.

Children

Gets the list of children.

ClsId

ClsId property.

Comments

Gets the list of associated comments.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayMesh

Gets or sets the DisplayMesh.

Figures

Gets the list of associated figures.

FixedLocation

“FixedLocation” property defines the fixed faces of the morphing region.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

MaximumFrequency

Gets or sets the MaximumFrequency.

MinimumFrequency

Gets or sets the MinimumFrequency.

MorphingFrequency

Gets or sets the MorphingFrequency.

MorphingIntervals

Gets or sets the MorphingIntervals.

MovingLocation

“MovingLocation” property defines the moving boundaries of the morphing region.

Name

Name property.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

Parent

Parent property.

Properties

Gets the list of properties for this object.

RegionLocation

“RegionLocation” property defines the morphing region bodies.

SlidingLocation

“SlidingLocation” property defines the sliding constraints scoping.

State

State property.

Suppressed

Gets or sets the Suppressed.

Thickness

Gets or sets the Thickness .

VisibleProperties

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

Property detail#

property MorphingRegion.AttachedRefs: List[int] | None#

AttachedRefs property.

property MorphingRegion.BaseFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the BaseFrequency.

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

Gets the list of children.

property MorphingRegion.ClsId: int | None#

ClsId property.

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

Gets the list of associated comments.

property MorphingRegion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property MorphingRegion.DisplayMesh: bool | None#

Gets or sets the DisplayMesh.

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

Gets the list of associated figures.

property MorphingRegion.FixedLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

“FixedLocation” property defines the fixed faces of the morphing region.

property MorphingRegion.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

GroupingFolder property.

property MorphingRegion.IconName: str | None#

IconName property.

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

Gets the list of associated images.

property MorphingRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMorphingRegionAuto | None#

Gets the internal object. For advanced usage only.

property MorphingRegion.MaximumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MaximumFrequency.

property MorphingRegion.MinimumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MinimumFrequency.

property MorphingRegion.MorphingFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MorphingFrequency.

property MorphingRegion.MorphingIntervals: int | None#

Gets or sets the MorphingIntervals.

property MorphingRegion.MovingLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

“MovingLocation” property defines the moving boundaries of the morphing region.

property MorphingRegion.Name: str | None#

Name property.

property MorphingRegion.ObjectId: int | None#

ObjectId property.

property MorphingRegion.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#

ObjectState property.

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

ObjectTags property.

property MorphingRegion.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

Parent property.

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

Gets the list of properties for this object.

property MorphingRegion.RegionLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

“RegionLocation” property defines the morphing region bodies.

property MorphingRegion.SlidingLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

“SlidingLocation” property defines the sliding constraints scoping.

property MorphingRegion.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#

State property.

property MorphingRegion.Suppressed: bool | None#

Gets or sets the Suppressed.

property MorphingRegion.Thickness: Ansys.Core.Units.Quantity | None#

Gets or sets the Thickness .

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

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

Method detail#

MorphingRegion.Activate() None#

Activate the current object.

MorphingRegion.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

MorphingRegion.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

MorphingRegion.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.
MorphingRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

MorphingRegion.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

MorphingRegion.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

MorphingRegion.Delete() None#

Run the Delete action.

MorphingRegion.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

MorphingRegion.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

MorphingRegion.GetAPIName(dispId: int) str#

Property name bound to dispId.

MorphingRegion.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

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

Gets the list of children, filtered by type.

MorphingRegion.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

MorphingRegion.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

MorphingRegion.GetHashCode() int#

GetHashCode method.

MorphingRegion.GetIconFile() System.Byte#

GetIconFile method.

MorphingRegion.GetLifetimeService() Any#

GetLifetimeService method.

MorphingRegion.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

MorphingRegion.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

MorphingRegion.GetPath() str#

GetPath method.

MorphingRegion.GetPropertyName(dispId: int) str#

GetPropertyName method.

MorphingRegion.GetPropertyValue(name: str) Any#

GetPropertyValue method.

MorphingRegion.GetType() type#

GetType method.

MorphingRegion.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

MorphingRegion.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

MorphingRegion.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

MorphingRegion.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

MorphingRegion.InitializeLifetimeService() Any#

InitializeLifetimeService method.

MorphingRegion.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

MorphingRegion.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

MorphingRegion.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.
MorphingRegion.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

MorphingRegion.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

MorphingRegion.RemoveParameter(propName: str) None#

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

MorphingRegion.ToString() str#

ToString method.