Defines a ImagePlane.
Declaration Syntax
public class ImagePlane : DataModelObject, IFolderDataModelObject
Table 237: Members
|
Property | Children |
Gets the list of children. |
|
Property | Comments |
Gets the list of associated comments. |
|
Property | 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. |
|
Property | CoordinateSystemVisible |
Gets or sets whether the annotation for the image’s coordinate system is rendered. |
|
Property | DataModelObjectCategory |
Gets the current DataModelObject's category. |
|
Property | FlipHorizontally |
Gets or sets whether the rendered image on the plane should be flipped horizontally. |
|
Property | FlipVertically |
Gets or sets whether the rendered image on the plane should be flipped vertically. |
|
Property | Height |
Gets or sets the physical height of the image plane. |
|
Property | ImageFilePath |
Gets the file path for the rendered image. |
|
Property | Images |
Gets the list of associated images. |
|
Property | InternalObject |
Gets the internal object. For advanced usage only. |
|
Property | PixelHeight |
Gets the pixel height of the plane's image. |
|
Property | PixelWidth |
Gets the pixel width of the plane's image. |
|
Property | ShowAlways |
Gets or sets whether the image plane will be shown independent of the active object in the tree. |
|
Property | Translucency |
Gets or sets the translucency of the plane, as a percentage ranging from 0 to 100. |
|
Property | Width |
Gets or sets the physical width of the image plane. |
|
Method | AddComment() |
Creates a new child Comment. |
|
Method | Delete() |
Run the Delete action. |
|
Method | GetChildren<ChildrenType>(bool, IList<ChildrenType>) |
Gets the list of children, filtered by type. |
|
Method | GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) |
Gets the list of children, filtered by type. |
|
Method | 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. |