Skip to main content

Mechanical scripting interface

ImagePlane

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ImagePlane

Bases: object

Defines a ImagePlane.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
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.
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.
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.
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.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
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.
DataModelObjectCategory Gets the current DataModelObject’s category.
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.
Height Gets or sets the physical height of the image plane.
ImageFilePath Gets the file path for the rendered image.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
PixelHeight Gets the pixel height of the plane’s image.
PixelWidth Gets the pixel width of the plane’s image.
Properties Gets the list of properties for this object.
ShowAlways Gets or sets whether the image plane will be shown independent of the active object in the tree.
Translucency Gets or sets the translucency of the plane, as a percentage ranging from 0 to 100.
VisibleProperties Gets the list of properties that are visible for this object.
Width Gets or sets the physical width of the image plane.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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 : bool | None

Gets or sets whether the annotation for the image’s coordinate system is rendered.

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

Gets the current DataModelObject’s category.

property ImagePlane.FlipHorizontally : bool | None

Gets or sets whether the rendered image on the plane should be flipped horizontally.

property ImagePlane.FlipVertically : bool | None

Gets or sets whether the rendered image on the plane should be flipped vertically.

property ImagePlane.Height : Ansys.Core.Units.Quantity | None

Gets or sets the physical height of the image plane.

property ImagePlane.ImageFilePath : str | None

Gets the file path for the rendered image.

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

Gets the list of associated images.

property ImagePlane.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAdvancedPostOutputAuto | None

Gets the internal object. For advanced usage only.

property ImagePlane.PixelHeight : int | None

Gets the pixel height of the plane’s image.

property ImagePlane.PixelWidth : int | None

Gets the pixel width of the plane’s image.

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

Gets the list of properties for this object.

property ImagePlane.ShowAlways : bool | None

Gets or sets whether the image plane will be shown independent of the active object in the tree.

property ImagePlane.Translucency : int | None

Gets or sets the translucency of the plane, as a percentage ranging from 0 to 100.

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

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

property ImagePlane.Width : Ansys.Core.Units.Quantity | None

Gets or sets the physical width of the image plane.

Method detail

ImagePlane.Activate()

Activate the current object.

ImagePlane.AddComment()

Creates a new child Comment.

ImagePlane.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ImagePlane.CreateParameter(propName: str)

Creates a new parameter for a Property.

ImagePlane.Delete()

Run the Delete action.

ImagePlane.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ImagePlane.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ImagePlane.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ImagePlane.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ImagePlane.Import(filePath: str)

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.PropertyByAPIName(name: str)

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.PropertyByName(name: str)

Get a property by its unique name.

ImagePlane.RemoveParameter(propName: str)

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