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
poIComplexCtrl Class
poIComponent GetColor
Gets the component color index.

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
        poIComplexCtrl GetAnimationFilter
        Gets the current complex filter for the current animation mode.
        poIComplexCtrl GetFilterList
        Gets the list of the available complex filters.
        poIComplexCtrl GetResultFilter
        Gets the current complex filter for the current animation mode.
        poIComplexCtrl SetAnimationFilter
        Sets the current complex filter for the current animation mode.
        poIComplexCtrl SetDefaultFilter
        Sets the current result filter to the default state.
        poIComplexCtrl SetResultFilter
        Sets the current complex filter for the current animation mode.
        poIComponent ApplyDefaults
        Sets component material to default values.
        poIComponent GetAssemblyID
        Gets the assembly ID of a component.
        poIComponent GetAutoColor
        Gets the component auto color index.
        poIComponent GetChildrenList
        Gets a list of the all child components.
        poIComponent GetColor
        Gets the component color index.
        poIComponent GetComponentID
        Gets the component's ID.
        poIComponent GetDisplayMode
        Gets the component display option setting.
        poIComponent GetDisplayModeList
        Gets a list of component display modes.
        poIComponent GetLabel
        Gets the component's label.
        poIComponent GetMaterial
        Gets the component's material index.
        poIComponent GetMeshMode
        Gets the component’s mesh mode.
        poIComponent GetNumberOfChildren
        Gets the number of child components.
        poIComponent GetPolygonMode
        Gets the component's polygon mode.
        poIComponent GetTracingMode
        Gets the component's tracing mode.
        poIComponent GetTranslation
        Gets the translation vector in the global coordinate system.
        poIComponent GetType
        Gets the component's type string.
        poIComponent GetVisibility
        Gets the component’s visibility.
        poIComponent SetAssemblyID
        Sets the assembly ID of a component.
        poIComponent SetAutoColor
        Sets the component’s auto color index.
        poIComponent SetColor
        Sets the component’s color index.
        poIComponent SetDisplayMode
        Sets the component's display mode.
        poIComponent SetLabel
        Sets the component’s label.
        poIComponent SetMaterial
        Sets the component's material index.
        poIComponent SetMeshMode
        Sets the component’s mesh mode.
        poIComponent SetPolygonMode
        Sets the component’s polygon mode.
        poIComponent SetTracingMode
        Sets the component’s tracing mode.
        poIComponent SetTranslation
        Translates a component by the vector given.
        poIComponent SetVisibility
        Sets the component’s visibility.
      - 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
      - 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.

poIComponent GetColor

Gets the component color index.

Important: Please note that this command has been deprecated and therefore is not recommended for use. See the poIPart Class for an alternative command that can be used.

Syntax

poIComponent_handle GetColor list

Application

HyperView Tcl Query

Description

This command returns the component color index.

Errors

None.