HyperWorks Desktop

2020.1

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following HyperWorks Desktop applications.
HyperView
poIImagePlane Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

2020.1

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2020.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Learn how to create, open, import and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes with the Parameters Browser.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
- HyperWorks Desktop
  - External Readers and Altair Binary Format
    Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
  - Generic ASCII Reader
    A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
  - Batch Mode
    Batch mode allows you perform a series of operations outside the program interface.
  - External Resources
    External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
  - Tcl/Tk Commands
    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
    - Program with HyperWorks APIs for Beginners
      APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
    - Object Hierarchy
      Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, MotionView, MediaView and TextView.
    - Tcl/Tk Classes
      Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
    - Script Use Cases
      Examples of script uses cases.
    - Tcl/Tk Example
      Learn more about Tcl/Tk with this basic example.
    - Program with HyperWorks Tcl/Tk Command Tutorials
      Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
    - Tcl/Tk Commands
      Tcl/Tk classes for the following HyperWorks Desktop applications.
      - HyperWorks Desktop
      - MotionView
      - HyperView
        
        Hotspot Finder API Structure
        
        Upfront Data Loader APIs
        
        poI3DViewCtrl Class
        
        poIAdvancedQuery Class
        
        poIAssembly Class
        
        poIBestView Class
        
        poICFD Class
        
        poICFD_rake Class
        
        poICollisionCtrl Class
        
        poICollisionSet Class
        
        poIComplexCtrl Class
        
        poIComponent Class
        
        poIContourCtrl Class
        
        poIExplosion Class
        
        poIFBDCtrl Class
        
        poIFLDCtrl Class
        
        poIGraphicMaterial Class
        
        poIImagePlaneCtrl Class
        
        poIImagePlane Class
        
        poIImagePlane AddAlignmentPoint
        Adds an alignment point to the image plane object.
        
        poIImagePlane CalcVidTracking
        Calculates the data needed to track an image plane video.
        
        poIImagePlane ClearAlignmentPoints
        Clears all alignment points of the image plane.
        
        poIImagePlane GetAlignmentData
        Gets a specific point or the list of points that were used (or would be used) to achieve a multipoint alignment for a 2D image plane.
        
        poIImagePlane GetAlignmentMode
        Gets the mode used to align a 3D image plane with a model.
        
        poIImagePlane GetAlignmentPointList
        Gets information about an alignment point.
        
        poIImagePlane GetAlpha
        Gets the alpha transparency associated with the image plane.
        
        poIImagePlane GetBackFaceVisibility
        Gets the back face visibility setting for the image plane.
        
        poIImagePlane GetColorAlphaTarget
        Gets the color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
        
        poIImagePlane GetColorAlphaTolerance
        Gets the search tolerance for the target color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
        
        poIImagePlane GetCullAngle
        Gets the culling angle setting for the image plane.
        
        poIImagePlane GetEdgeColor
        Gets the color of the edges when the post-processing Edge detection filter is active on an image plane.
        
        poIImagePlane GetFileName
        Gets the file name of the image or video associated with the image plane.
        
        poIImagePlane GetFilterMode
        Gets the current image post-processing filter mode for the image plane.
        
        poIImagePlane GetFilterModeList
        Gets the current image post-processing filter mode for the image plane.
        
        poIImagePlane GetFilterType
        Gets the current image post-processing filter type for the image plane.
        
        poIImagePlane GetFilterTypeList
        Gets the types of image post-processing filters available for image planes.
        
        poIImagePlane GetFilterTypeList
        Gets the types of image post-processing filters available for image planes.
        
        poIImagePlane GetFit
        Gets the condition of the Fit display option form the current 2D image plane.
        
        poIImagePlane GetID
        Gets the unique ID for an image plane.
        
        poIImagePlane GetInvalidAlignmentPointList
        Gets a subset of the input point list which includes all points that do not belong to the active model.
        
        poIImagePlane GetLabel
        Gets the user assigned label for an image plane.
        
        poIImagePlane GetLastFrameTracked
        Gets the index of the last frame for which video tracking has been given.
        
        poIImagePlane GetMipMapMode
        Gets the current mipmap mode for an image plane.
        
        poIImagePlane GetMipMapModeList
        Gets the list of mipmap modes available for an image plane.
        
        poIImagePlane GetMode
        Gets the drawing mode for the image plane.
        
        poIImagePlane GetNumAlignmentPoints
        Gets the number of alignment points in an image plane.
        
        poIImagePlane GetShowTrackingMarker
        Gets the status of the video tracking marker.
        
        poIImagePlane GetSyncBlockID
        Gets the unique animation sync block for the image plane.
        
        poIImagePlane GetSyncMode
        Gets the mode used to synchronize an image plane video with a model animation.
        
        poIImagePlane GetSyncModeList
        Gets a list of valid sync modes.
        
        poIImagePlane GetSyncModel
        Gets the model being synchronized with the image plane video.
        
        poIImagePlane GetTrackerColor
        Gets the RGB values assigned to the video tracking marker.
        
        poIImagePlane GetTrackingMode
        Gets the current tracking mode for the image plane.
        
        poIImagePlane GetTrackingModeList
        Gets the list of tracking modes available for an image plane.
        
        poIImagePlane GetUserTransformList
        Gets the 2D or 3D user transform for the image plane.
        
        poIImagePlane GetVidTrackData
        Gets the video tracking data used to track a point.
        
        poIImagePlane GetVidTrackingWindowSize
        Gets the size of the window used for video tracking.
        
        poIImagePlane GetVisibility
        Gets the visibility setting for the image plane.
        
        poIImagePlane GetZoom
        Gets the condition of the Zoom display option from the current 2D image plane.
        
        poIImagePlane LocateBy2Points
        Aligns a 3D image plane with a model.
        
        poIImagePlane LocateBy3Points
        Aligns a 3D image plane with a model.
        
        poIImagePlane LocateByMultPoints
        Transforms the model based on a list of points to align it to a 2D image plane.
        
        poIImagePlane ManipIdentity
        Clears the 2D or 3D user transform for the image plane.
        
        poIImagePlane RemoveAlignmentPoint
        Removes an alignment point from an image plane.
        
        poIImagePlane ReprojectionError
        Calculate the reprojection error between the current multi-point alignment points.
        
        poIImagePlane SetAlignmentPoint
        Defines an alignment point with a model node and image x,y pixel location.
        
        poIImagePlane SetAlpha
        Sets the alpha transparency associated with the image plane.
        
        poIImagePlane SetAssociatedModelID
        Associates the image plane with the specified model.
        
        poIImagePlane SetBackFaceVisibility
        Sets the back face visibility setting for the image plane.
        
        poIImagePlane SetColorAlphaTarget
        Sets the post-processing filter mode.
        
        poIImagePlane SetColorAlphaTolerance
        Sets the search tolerance for the target color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
        
        poIImagePlane SetCrop
        Crops the image plane content.
        
        poIImagePlane SetCullAngle
        Sets the culling angle setting for the image plane.
        
        poIImagePlane SetEdgeColor
        Sets the color of the edges when the post-processing edge detection filter is active on an image plane.
        
        poIImagePlane SetFileName
        Sets the file name of the image or video associated with the image plane.
        
        poIImagePlane SetFilterMode
        Sets the image post-processing filter mode for the image plane.
        
        poIImagePlane SetFilterType
        Sets the current image post-processing filter type for the image plane.
        
        poIImagePlane SetFit
        Sets a 2D image plane to fit its window in the graphics area.
        
        poIImagePlane SetLabel
        Sets the user assigned label for an image plane.
        
        poIImagePlane SetMaintainAspectRatio
        Sets the value of the Maintain Aspect Ratio flag for the image plane.
        
        poIImagePlane SetMipMapMode
        Sets the current mipmap mode for an image plane.
        
        poIImagePlane SetMode
        Sets the drawing mode for the image plane.
        
        poIImagePlane SetPosition
        Sets an image plane in the background or foreground mode to a predefined window location.
        
        poIImagePlane SetShowTrackingMarker
        Enables/disables the video tracking marker.
        
        poIImagePlane SetStretchToFit
        Sets an image plane in the background or foreground mode to a predefined window location.
        
        poIImagePlane SetSyncMode
        Sets the mode used to synchronize an image plane video with a model animation.
        
        poIImagePlane SetSyncModel
        Sets the model being synchronized with the image plane video.
        
        poIImagePlane SetTrackerColor
        Sets the color of the video tracking marker.
        
        poIImagePlane SetTrackingMode
        Sets the current tracking mode for the image plane.
        
        poIImagePlane SetUserTransform
        Sets the 2D or 3D user transform for the image plane.
        
        poIImagePlane SetVidTrackData
        Explicitly sets the video tracking data.
        
        poIImagePlane SetVidTrackingWindowSize
        Sets the size of the window used for video tracking.
        
        poIImagePlane SetVisibility
        Sets the visibility setting for the image plane.
        
        poIImagePlane SetZoom
        Activate the Zoom function of a 2D image plane.
        
        poIImagePlane SyncScaleModified
        Checks to see if the sync scale has been modified.
        
        poIIsoValueCtrl Class
        
        poILayerFilter Class
        
        poILegend Class
        
        poIMeasure Class
        
        poIModel Class
        
        poINote Class
        
        poIPart Class
        
        poIPartAssembly Class
        
        poIPost Class
        
        poIPostManager Class
        
        poIQueryCtrl Class
        
        poIQueryDistanceRule Class
        
        poIQueryExpressionRule Class
        
        poIQueryExtremeRule Class
        
        poIQueryIgnoreElemTypeRule Class
        
        poIQueryIterator Class
        
        poIQueryRule Class
        
        poIQuerySetRule Class
        
        poIRenderOptions Class
        
        poIResultCtrl Class
        
        poIResultMathCtrl Class
        
        poIScalarDefine Class
        
        poIScaleCtrl Class
        
        poISCL Class
        
        poISection Class
        
        poISelectionSet Class
        
        poIStressLinearizationCtrl Class
        
        poISubcase Class
        
        poISweepCtrl Class
        
        poISymmetry Class
        
        poISystem Class
        
        poISystemCtrl Class
        
        poITensorCtrl Class
        
        poITensorDefine Class
        
        poITextAttribute Class
        
        poITracingCtrl Class
        
        poITrackingSystem Class
        
        poIVectorCtrl Class
        
        poIVectorDefine Class
      - HyperGraph 2D
      - HyperGraph 3D
      - MediaView
      - TextView
      - HgTrans
      - TableView
  - Translators
    Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
  - Result Math
    XML commands in the Result Math Module.
  - HyperWorks Record and Playback
    Record playback workflows in HyperView.
- HyperWorks Report
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script Exchange
  The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.

View All Altair HyperWorks Help

HyperWorks Desktop

2020.1

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following HyperWorks Desktop applications.
HyperView
poIImagePlane Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

poIImagePlane Class

Note: See the Image Planes topic in the HyperView User's Guide for additional information.

poIImagePlane AddAlignmentPoint
Adds an alignment point to the image plane object.
poIImagePlane CalcVidTracking
Calculates the data needed to track an image plane video.
poIImagePlane ClearAlignmentPoints
Clears all alignment points of the image plane.
poIImagePlane GetAlignmentData
Gets a specific point or the list of points that were used (or would be used) to achieve a multipoint alignment for a 2D image plane.
poIImagePlane GetAlignmentMode
Gets the mode used to align a 3D image plane with a model.
poIImagePlane GetAlignmentPointList
Gets information about an alignment point.
poIImagePlane GetAlpha
Gets the alpha transparency associated with the image plane.
poIImagePlane GetBackFaceVisibility
Gets the back face visibility setting for the image plane.
poIImagePlane GetColorAlphaTarget
Gets the color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
poIImagePlane GetColorAlphaTolerance
Gets the search tolerance for the target color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
poIImagePlane GetCullAngle
Gets the culling angle setting for the image plane.
poIImagePlane GetEdgeColor
Gets the color of the edges when the post-processing Edge detection filter is active on an image plane.
poIImagePlane GetFileName
Gets the file name of the image or video associated with the image plane.
poIImagePlane GetFilterMode
Gets the current image post-processing filter mode for the image plane.
poIImagePlane GetFilterModeList
Gets the current image post-processing filter mode for the image plane.
poIImagePlane GetFilterType
Gets the current image post-processing filter type for the image plane.
poIImagePlane GetFilterTypeList
Gets the types of image post-processing filters available for image planes.
poIImagePlane GetFilterTypeList
Gets the types of image post-processing filters available for image planes.
poIImagePlane GetFit
Gets the condition of the Fit display option form the current 2D image plane.
poIImagePlane GetID
Gets the unique ID for an image plane.
poIImagePlane GetInvalidAlignmentPointList
Gets a subset of the input point list which includes all points that do not belong to the active model.
poIImagePlane GetLabel
Gets the user assigned label for an image plane.
poIImagePlane GetLastFrameTracked
Gets the index of the last frame for which video tracking has been given.
poIImagePlane GetMipMapMode
Gets the current mipmap mode for an image plane.
poIImagePlane GetMipMapModeList
Gets the list of mipmap modes available for an image plane.
poIImagePlane GetMode
Gets the drawing mode for the image plane.
poIImagePlane GetNumAlignmentPoints
Gets the number of alignment points in an image plane.
poIImagePlane GetShowTrackingMarker
Gets the status of the video tracking marker.
poIImagePlane GetSyncBlockID
Gets the unique animation sync block for the image plane.
poIImagePlane GetSyncMode
Gets the mode used to synchronize an image plane video with a model animation.
poIImagePlane GetSyncModeList
Gets a list of valid sync modes.
poIImagePlane GetSyncModel
Gets the model being synchronized with the image plane video.
poIImagePlane GetTrackerColor
Gets the RGB values assigned to the video tracking marker.
poIImagePlane GetTrackingMode
Gets the current tracking mode for the image plane.
poIImagePlane GetTrackingModeList
Gets the list of tracking modes available for an image plane.
poIImagePlane GetUserTransformList
Gets the 2D or 3D user transform for the image plane.
poIImagePlane GetVidTrackData
Gets the video tracking data used to track a point.
poIImagePlane GetVidTrackingWindowSize
Gets the size of the window used for video tracking.
poIImagePlane GetVisibility
Gets the visibility setting for the image plane.
poIImagePlane GetZoom
Gets the condition of the Zoom display option from the current 2D image plane.
poIImagePlane LocateBy2Points
Aligns a 3D image plane with a model.
poIImagePlane LocateBy3Points
Aligns a 3D image plane with a model.
poIImagePlane LocateByMultPoints
Transforms the model based on a list of points to align it to a 2D image plane.
poIImagePlane ManipIdentity
Clears the 2D or 3D user transform for the image plane.
poIImagePlane RemoveAlignmentPoint
Removes an alignment point from an image plane.
poIImagePlane ReprojectionError
Calculate the reprojection error between the current multi-point alignment points.
poIImagePlane SetAlignmentPoint
Defines an alignment point with a model node and image x,y pixel location.
poIImagePlane SetAlpha
Sets the alpha transparency associated with the image plane.
poIImagePlane SetAssociatedModelID
Associates the image plane with the specified model.
poIImagePlane SetBackFaceVisibility
Sets the back face visibility setting for the image plane.
poIImagePlane SetColorAlphaTarget
Sets the post-processing filter mode.
poIImagePlane SetColorAlphaTolerance
Sets the search tolerance for the target color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
poIImagePlane SetCrop
Crops the image plane content.
poIImagePlane SetCullAngle
Sets the culling angle setting for the image plane.
poIImagePlane SetEdgeColor
Sets the color of the edges when the post-processing edge detection filter is active on an image plane.
poIImagePlane SetFileName
Sets the file name of the image or video associated with the image plane.
poIImagePlane SetFilterMode
Sets the image post-processing filter mode for the image plane.
poIImagePlane SetFilterType
Sets the current image post-processing filter type for the image plane.
poIImagePlane SetFit
Sets a 2D image plane to fit its window in the graphics area.
poIImagePlane SetLabel
Sets the user assigned label for an image plane.
poIImagePlane SetMaintainAspectRatio
Sets the value of the Maintain Aspect Ratio flag for the image plane.
poIImagePlane SetMipMapMode
Sets the current mipmap mode for an image plane.
poIImagePlane SetMode
Sets the drawing mode for the image plane.
poIImagePlane SetPosition
Sets an image plane in the background or foreground mode to a predefined window location.
poIImagePlane SetShowTrackingMarker
Enables/disables the video tracking marker.
poIImagePlane SetStretchToFit
Sets an image plane in the background or foreground mode to a predefined window location.
poIImagePlane SetSyncMode
Sets the mode used to synchronize an image plane video with a model animation.
poIImagePlane SetSyncModel
Sets the model being synchronized with the image plane video.
poIImagePlane SetTrackerColor
Sets the color of the video tracking marker.
poIImagePlane SetTrackingMode
Sets the current tracking mode for the image plane.
poIImagePlane SetUserTransform
Sets the 2D or 3D user transform for the image plane.
poIImagePlane SetVidTrackData
Explicitly sets the video tracking data.
poIImagePlane SetVidTrackingWindowSize
Sets the size of the window used for video tracking.
poIImagePlane SetVisibility
Sets the visibility setting for the image plane.
poIImagePlane SetZoom
Activate the Zoom function of a 2D image plane.
poIImagePlane SyncScaleModified
Checks to see if the sync scale has been modified.

(c) 2020. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support