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
poIIsoValueCtrl Class
poIIsoValueCtrl GetLegendMode
Gets the current legend mode.

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
        poIIsoValueCtrl ExportSTL
        Exports an STL format ASCII file.
        poIIsoValueCtrl GetAverageFactor
        Gets the nodal variation factor.
        poIIsoValueCtrl GetAverageMode
        Gets the method by which elemental results are averaged to nodes.
        poIIsoValueCtrl GetAverageModeList
        Gets the list of possible averaging modes.
        poIIsoValueCtrl GetAvgAcrossPartsEnable
        Gets the state of the average across parts.
        poIIsoValueCtrl GetBinding
        Gets the output/contour binding of the current request.
        poIIsoValueCtrl GetColor
        Gets the iso surface color value.
        poIIsoValueCtrl GetColorOverride
        Gets the state of color override option for the iso value.
        poIIsoValueCtrl GetCornerDataEnabled
        Gets the corner data enabled state.
        poIIsoValueCtrl GetDataComponent
        Gets the current data component for the given dimension.
        poIIsoValueCtrl GetDataType
        Gets the current iso value data type.
        poIIsoValueCtrl GetDimensionEnabled
        Gets the dimension state: enabled or disabled.
        poIIsoValueCtrl GetDisplayMode
        Gets the current display mode.
        poIIsoValueCtrl GetEnabled
        Gets the pool state, either enabled or disabled.
        poIIsoValueCtrl GetEnableState
        Gets the auto load/unload iso value data state.
        poIIsoValueCtrl GetFeatureAngleAverage
        Gets the angle set for the feature angle average.
        poIIsoValueCtrl GetFeatureAngleAverageEnableState
        Gets the state of the feature angle average.
        poIIsoValueCtrl GetIgnoredFlippedNormal
        Gets the state of the "Ignore Flipped Normal" option set for the feature angle average.
        poIIsoValueCtrl GetIncrement
        Gets the current iso value increment.
        poIIsoValueCtrl GetIsoValue
        Gets the current iso value.
        poIIsoValueCtrl GetIsoValueMax
        Gets the maximum iso value possible.
        poIIsoValueCtrl GetIsoValueMin
        Gets the minimum iso value possible.
        poIIsoValueCtrl GetLayer
        Gets the current layer label.
        poIIsoValueCtrl GetLegendMode
        Gets the current legend mode.
        poIIsoValueCtrl GetProjectionRule
        Gets the projection rule associated with the iso controller.
        poIIsoValueCtrl GetResultSystem
        Gets the result system ID.
        poIIsoValueCtrl GetSelectionSetHandle
        Gets the set handle from the iso controller.
        poIIsoValueCtrl GetSelectionSetSize
        Gets the set size of the iso controller.
        poIIsoValueCtrl GetShellLayer
        Gets the current shell layer label.
        poIIsoValueCtrl GetShowMidsideNodeResults
        Gets the state of the "Show Midside Node Results" option for the iso control.
        poIIsoValueCtrl SetAverageFactor
        Sets the nodal variation factor's valid range.
        poIIsoValueCtrl SetAverageMode
        Sets the method by which elemental results are averaged to nodes.
        poIIsoValueCtrl SetAvgAcrossPartsEnable
        Sets the state of the average across parts.
        poIIsoValueCtrl SetColor
        Sets the iso surface color value.
        poIIsoValueCtrl SetColorOverride
        Sets the state of color override option for the iso value.
        poIIsoValueCtrl SetCornerDataEnabled
        Enables node on element data.
        poIIsoValueCtrl SetDataComponent
        Sets the data component for a given component.
        poIIsoValueCtrl SetDataType
        Sets the data type for the iso control.
        poIIsoValueCtrl SetDimensionEnabled
        Sets the dimension state: enabled or disabled.
        poIIsoValueCtrl SetDisplayMode
        Sets the current display mode.
        poIIsoValueCtrl SetEnabled
        Sets the dimension state, either enabled or disabled.
        poIIsoValueCtrl SetEnableState
        Sets the auto load/unload iso value data state.
        poIIsoValueCtrl SetFeatureAngleAverage
        Sets the angle for the feature angle average.
        poIIsoValueCtrl SetFeatureAngleAverageEnableState
        Sets the state of the feature angle average.
        poIIsoValueCtrl SetIgnoredFlippedNormal
        Sets the state of the "Ignore Flipped Normal" option for the feature angle average.
        poIIsoValueCtrl SetIncrement
        Sets the current iso value increment.
        poIIsoValueCtrl SetIsoValue
        Sets the iso value to the specified value.
        poIIsoValueCtrl SetLayer
        Sets the current layer.
        poIIsoValueCtrl SetLegendMode
        Sets the legend mode to true or false.
        poIIsoValueCtrl SetProjectionRule
        Sets the projection rule for projecting 3D tensors to the 2D element plane.
        poIIsoValueCtrl SetResultSystem
        Sets the result system ID.
        poIIsoValueCtrl SetSelectionSet
        Sets the selected entities to be used by the iso control.
        poIIsoValueCtrl SetShellLayer
        Sets the current shell layer.
        poIIsoValueCtrl SetShowMidsideNodeResults
        Sets the state of the "Show Midside Node Results" option for the iso control.
      - 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.

poIIsoValueCtrl GetLegendMode

Gets the current legend mode.

Syntax

poIIsoValueCtrl_handle GetLegendMode

Application

HyperView Tcl Query

Description

This command retrieves the current legend mode.

Error

Returns true if the contour legend was used to generate the iso value, otherwise false.