`ElementOrientation`#

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

Bases: object

Defines a ElementOrientation.

Overview#

Methods

`GenerateOrientations`	Runs the GenerateOrientations acton.
`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

`InternalObject`	Gets the internal object. For advanced usage only.
`AxisEdgeOrientation`	Gets or sets the AxisEdgeOrientation.
`AxisSurfaceOrientation`	Gets or sets the AxisSurfaceOrientation.
`OrientationGuideDefinedBy`	Gets or sets the OrientationGuideDefinedBy.
`Suppressed`	Gets or sets the Suppressed.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`BodyLocation`	Gets or sets the BodyLocation.
`EdgeLocation`	Gets or sets the EdgeLocation.
`SurfaceLocation`	Gets or sets the SurfaceLocation.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`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 ElementOrientation.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSElementOrientationAuto | None: Gets the internal object. For advanced usage only.

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.OrientationGuideDefinedBy: Ansys.Mechanical.DataModel.Enums.ElementOrientationGuide | None: Gets or sets the OrientationGuideDefinedBy.

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

property ElementOrientation.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

property ElementOrientation.BodyLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the BodyLocation.

property ElementOrientation.EdgeLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the EdgeLocation.

property ElementOrientation.SurfaceLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the SurfaceLocation.

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

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

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

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

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

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

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

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

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

Method detail#

ElementOrientation.GenerateOrientations() → System.Void: Runs the GenerateOrientations acton.

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

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

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

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

ElementOrientation.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

ElementOrientation.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

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