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
poITrackingSystem Class
poITrackingSystem SetPlaneType
Sets the plane type for a tracking system.

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
      - 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
        poITrackingSystem GetClipTransparency
        Gets whether clipped geometry should be displayed as transparent.
        poITrackingSystem GetDoF
        Gets the tracking degree of freedom.
        poITrackingSystem GetID
        Gets the tracking system's ID.
        poITrackingSystem GetLabel
        Gets the tracking system label.
        poITrackingSystem GetNode
        Gets the IDs of the tracking node and the model ID of the tracking system.
        poITrackingSystem GetPlane
        Gets the IDs of the tracking plane's nodes and model IDs of the tracking system.
        poITrackingSystem GetPlaneNode
        Gets a node string for the given index of the current tracking plane.
        poITrackingSystem GetPlaneType
        Gets the plane type of a tracking system.
        poITrackingSystem GetPlaneTypeList
        Gets the list of valid plane types for a tracking system.
        poITrackingSystem GetType
        Gets the tracking system state.
        poITrackingSystem GetUseGlobalCoords
        Gets the value of the "Align with global" option.
        poITrackingSystem SetClipTransparency
        Sets whether the clipped geometry should be displayed as transparent.
        poITrackingSystem SetDoF
        Sets the tracking degree of freedom.
        poITrackingSystem SetIDVisibility
        Sets the system's ID visibility.
        poITrackingSystem SetLabel
        Sets the tracking system label.
        poITrackingSystem SetNode
        Sets the tracking node and model IDs.
        poITrackingSystem SetPlane
        Sets the tracking plane's nodes and model IDs.
        poITrackingSystem SetPlaneNode
        Sets the one of the tracking plane's node specified by the index.
        poITrackingSystem SetPlaneType
        Sets the plane type for a tracking system.
        poITrackingSystem SetUseGlobalCoords
        Sets the value of the "Align with global" option (On/Off).
      - 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.

poITrackingSystem SetPlaneType

Sets the plane type for a tracking system.

Syntax

tsys_handle SetPlaneType type_str

Application

HyperView Tcl Modify

Description

This command sets the plane type for a tracking system. This command should only be used for "plane" type tracking systems.

Inputs

type_str: Any of the following three values are valid for this argument: OXY/OYZ/OZX.

Example

To set the plane type of a tracking system whose ID is 2:

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 GetModelHandle model_handle 1;
model_handle GetTrackingSystemHandle tsys_handle 2
tsys_handle SetPlaneType OXY
hwi CloseStack

Errors

Returns a non-zero value if there is an error.