ImagePlane

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

Bases: object

Defines a ImagePlane.

Overview

Methods

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

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
Height	Gets or sets the physical height of the image plane.
IconName	IconName property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property ImagePlane.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

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

Gets or sets the physical height of the image plane.

property ImagePlane.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property ImagePlane.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property ImagePlane.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

ImagePlane.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

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

Copies all visible properties from this object to another.

ImagePlane.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

ImagePlane.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

ImagePlane.Delete() → None

Run the Delete action.

ImagePlane.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

ImagePlane.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

ImagePlane.GetAPIName(dispId: int) → str

Property name bound to dispId.

ImagePlane.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

ImagePlane.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

ImagePlane.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

ImagePlane.GetHashCode() → int

GetHashCode method.

ImagePlane.GetIconFile() → System.Byte

GetIconFile method.

ImagePlane.GetLifetimeService() → Any

GetLifetimeService method.

ImagePlane.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

ImagePlane.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

ImagePlane.GetPath() → str

GetPath method.

ImagePlane.GetPropertyName(dispId: int) → str

GetPropertyName method.

ImagePlane.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ImagePlane.GetType() → type

GetType method.

ImagePlane.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

ImagePlane.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ImagePlane.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

ImagePlane.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

ImagePlane.Import(filePath: str) → None

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.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ImagePlane.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ImagePlane.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

ImagePlane.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

ImagePlane.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

ImagePlane.RemoveParameter(propName: str) → None

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

ImagePlane.ToString() → str

ToString method.