Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
Tcl/Tk Commands
The application's 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 Altair HyperWorks applications.
HyperView
poIImagePlane Class
poIImagePlane GetSyncModeList
Gets a list of valid sync modes.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- 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.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, 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 Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet 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
      - poIPartSet 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
    - Postquery Commands
    - Context Commands
    - Framework Commands
- 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.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

poIImagePlane GetSyncModeList

Gets a list of valid sync modes.

Syntax

Imageplane_handle GetSyncModeList

Application

HyperView Tcl Query

Description

This command returns a list of valid sync modes: Manual, Length, or Framerate.

Example

To get a list of valid sync mode options:

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetImagePlaneCtrlHandle ipc_handle
ipc_handle GetImagePlaneHandle image_plane_handle 1
image_plane_handle GetSyncModeList
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.