Class: ImagePlane

Defines a ImagePlane.

Methods

Name Description
Activate() Activate the current object.
AddComment() Creates a new child Comment.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
Duplicate() Creates a copy of the current DataModelObject.
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
Import(String) 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(String) 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.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.

Properties

Name Description
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 name of 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.
Name Gets the name of the object.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
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.