`ImagePlane`#

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

Bases: object

Defines a ImagePlane.

Overview#

Methods

`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.
`Import`	Sets the image which is rendered to this plane, specified by filePath. Upon success, ImageFilePath will return filePath. Upon failure, ImageFilePath will remain unchanged. Supported file formats include PNG, JPEG, BMP, and GIF. If this is the first time an image has been set to this image plane and if Width and Height were never modified, the image plane will be automatically sized based on the model’s bounding box, respecting the image’s aspect ratio.
`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.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Images`	Gets the list of associated images.
`ImageFilePath`	Gets the file path for the rendered image.
`CoordinateSystem`	Gets or sets the coordinate system object used for defining the plane’s location and orientation. This property is restricted to cartesian coordinate systems.
`CoordinateSystemVisible`	Gets or sets whether the annotation for the image’s coordinate system is rendered.
`PixelWidth`	Gets the pixel width of the plane’s image.
`PixelHeight`	Gets the pixel height of the plane’s image.
`Width`	Gets or sets the physical width of the image plane.
`Height`	Gets or sets the physical height of the image plane.
`FlipHorizontally`	Gets or sets whether the rendered image on the plane should be flipped horizontally.
`FlipVertically`	Gets or sets whether the rendered image on the plane should be flipped vertically.
`Translucency`	Gets or sets the translucency of the plane, as a percentage ranging from 0 to 100.
`ShowAlways`	Gets or sets whether the image plane will be shown independent of the active object in the tree.
`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 ImagePlane.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSAdvancedPostOutputAuto | None: Gets the internal object. For advanced usage only.

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

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

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

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

property ImagePlane.ImageFilePath: System.String | None: Gets the file path for the rendered image.

property ImagePlane.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the coordinate system object used for defining the plane’s location and orientation. This property is restricted to cartesian coordinate systems.

property ImagePlane.CoordinateSystemVisible: System.Boolean | None: Gets or sets whether the annotation for the image’s coordinate system is rendered.

property ImagePlane.PixelWidth: System.Int32 | None: Gets the pixel width of the plane’s image.

property ImagePlane.PixelHeight: System.Int32 | None: Gets the pixel height of the plane’s image.

property ImagePlane.Width: Ansys.Core.Units.Quantity | None: Gets or sets the physical width of the image plane.

property ImagePlane.Height: Ansys.Core.Units.Quantity | None: Gets or sets the physical height of the image plane.

property ImagePlane.FlipHorizontally: System.Boolean | None: Gets or sets whether the rendered image on the plane should be flipped horizontally.

property ImagePlane.FlipVertically: System.Boolean | None: Gets or sets whether the rendered image on the plane should be flipped vertically.

property ImagePlane.Translucency: System.Int32 | None: Gets or sets the translucency of the plane, as a percentage ranging from 0 to 100.

property ImagePlane.ShowAlways: System.Boolean | None: Gets or sets whether the image plane will be shown independent of the active object in the tree.

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

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

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

Method detail#

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

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

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

ImagePlane.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

ImagePlane.Import(filePath: System.String) → System.Void: Sets the image which is rendered to this plane, specified by filePath. Upon success, ImageFilePath will return filePath. Upon failure, ImageFilePath will remain unchanged. Supported file formats include PNG, JPEG, BMP, and GIF. If this is the first time an image has been set to this image plane and if Width and Height were never modified, the image plane will be automatically sized based on the model’s bounding box, respecting the image’s aspect ratio.

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

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

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

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

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

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

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

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

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

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