ElementOrientation#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.ElementOrientation#

Bases: object

Defines a ElementOrientation.

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.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

GenerateOrientations

Runs the GenerateOrientations acton.

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.

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.

AxisEdgeOrientation

Gets or sets the AxisEdgeOrientation.

AxisSurfaceOrientation

Gets or sets the AxisSurfaceOrientation.

BodyLocation

Gets or sets the BodyLocation.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the CoordinateSystem.

DataModelObjectCategory

Gets the current DataModelObject's category.

EdgeLocation

Gets or sets the EdgeLocation.

Figures

Gets the list of associated figures.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

OrientationGuideDefinedBy

Gets or sets the OrientationGuideDefinedBy.

Properties

Gets the list of properties for this object.

ReadOnly

Gets or sets the ReadOnly.

Suppressed

Gets or sets the Suppressed.

SurfaceLocation

Gets or sets the SurfaceLocation.

VisibleProperties

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

Property detail#

property ElementOrientation.AxisEdgeOrientation: Ansys.Mechanical.DataModel.Enums.ElementOrientationAxisType | None#

Gets or sets the AxisEdgeOrientation.

property ElementOrientation.AxisSurfaceOrientation: Ansys.Mechanical.DataModel.Enums.ElementOrientationAxisType | None#

Gets or sets the AxisSurfaceOrientation.

property ElementOrientation.BodyLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the BodyLocation.

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

Gets the list of children.

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

Gets the list of associated comments.

property ElementOrientation.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

property ElementOrientation.EdgeLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the EdgeLocation.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ElementOrientation.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSElementOrientationAuto | None#

Gets the internal object. For advanced usage only.

property ElementOrientation.OrientationGuideDefinedBy: Ansys.Mechanical.DataModel.Enums.ElementOrientationGuide | None#

Gets or sets the OrientationGuideDefinedBy.

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

Gets the list of properties for this object.

property ElementOrientation.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property ElementOrientation.Suppressed: bool | None#

Gets or sets the Suppressed.

property ElementOrientation.SurfaceLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the SurfaceLocation.

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

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

Method detail#

ElementOrientation.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

ElementOrientation.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

ElementOrientation.GenerateOrientations() None#

Runs the GenerateOrientations acton.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

ElementOrientation.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ElementOrientation.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.
ElementOrientation.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

ElementOrientation.RemoveParameter(propName: str) None#

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