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
poITracingCtrl Class
poITracingCtrl AddEntity
Adds an entity to the tracing control.

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
        poITracingCtrl AddDynamicCurveToPlot
        Adds a live link tracing curve for a single node over frames to the selected window.
        poITracingCtrl AddDynamicXYCurveToPlot
        Adds a live link single curve of all tracing nodes to the selected window.
        poITracingCtrl AddEntity
        Adds an entity to the tracing control.
        poITracingCtrl AddNode
        Adds a node to the tracing control.
        poITracingCtrl AddPart
        Adds a part to the tracing control.
        poITracingCtrl AddSimStepToList
        Adds a simulation step index to the list of simulation steps that are traced.
        poITracingCtrl AddStaticCurveToPlot
        Adds a static tracing curve for a single node over frames to the selected window.
        poITracingCtrl AddStaticCurveToWindow
        Adds a static tracing curve for a single node over frames to the preview window.
        poITracingCtrl AddStaticXYCurveToPlot
        Adds a single curve of all tracing nodes to the selected window.
        poITracingCtrl AddStaticXYCurveToWindow
        Adds a static single curve of all tracing nodes to the preview window.
        poITracingCtrl GetBaseTime
        Gets the base time of the line tracing.
        poITracingCtrl GetColor
        Gets the node trace line color.
        poITracingCtrl GetEntityColor
        Gets the entity color.
        poITracingCtrl GetEntityList
        Gets the list of node's that are being traced.
        poITracingCtrl GetEntityTypeList
        Gets the available entity types.
        poITracingCtrl GetLineColor
        Gets the node trace line color.
        poITracingCtrl GetLineNodeList
        Gets the list of nodes that are being used for line tracing.
        poITracingCtrl GetLineThickness
        Gets the node trace line thickness.
        poITracingCtrl GetMode
        Gets the node trace mode.
        poITracingCtrl GetModeList
        Gets the valid list node/component trace modes.
        poITracingCtrl GetNodeList
        Gets the list of nodes that are being traced.
        poITracingCtrl GetNumberOfEntities
        Gets the number of entities of the given type.
        poITracingCtrl GetNumberOfSteps
        Gets the node trace number of steps.
        poITracingCtrl GetPartList
        Gets the list of part IDs that are being traced.
        poITracingCtrl GetSimStepList
        Gets the list of simulation traced steps.
        poITracingCtrl GetThickness
        Gets the node trace line thickness.
        poITracingCtrl RemoveEntity
        Removes an entity from the tracing control.
        poITracingCtrl RemoveNode
        Removes a node from the tracing control.
        poITracingCtrl RemovePart
        Removes a part from the tracing control.
        poITracingCtrl RemoveSimStepFromList
        Removes a simulation step index from the list of simulation steps that are traced.
        poITracingCtrl SetColor
        Sets the node trace line color.
        poITracingCtrl SetColorByComponent
        Defines the Tracing plot 'Color by Component' option.
        poITracingCtrl SetCurveByComponent
        Defines the Tracing plot 'Curve by Component' option.
        poITracingCtrl SetEntityColor
        Sets the entity color.
        poITracingCtrl SetLineColor
        Sets the node trace line color.
        poITracingCtrl SetLineThickness
        Sets the node trace line thickness.
        poITracingCtrl SetMode
        Sets the node trace mode.
        poITracingCtrl SetNumberOfSteps
        Sets the number of traced steps.
        poITracingCtrl SetSimSteps
        Sets the entity color.
        poITracingCtrl SetThickness
        Sets the node trace line thickness.
        poITracingCtrl SortNodes
        Sorts nodes of the Tracing panel based on certain rules.
      - 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.

poITracingCtrl AddEntity

Adds an entity to the tracing control.

Syntax

poITracingCtrl_handle AddEntity entity_id_str

Application

HyperView Tcl Modify

Description

This command adds an entity to the tracing control.

Inputs

entity_id_str: The entity ID, or the pool entity ID.

Errors

Returns 0 if successful, otherwise an error code.