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
poIContourCtrl Class
poIContourCtrl GetLegendHandle
Gets the legend control object for contouring.

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
        poIContourCtrl CopyToClipBoard
        Copies contour data to the clipboard.
        poIContourCtrl Class GetAverageColor
        Gets the averaging state for element results.
        poIContourCtrl GetAverageMode
        Gets the method by which elemental results are averaged to nodes.
        poIContourCtrl GetAverageModeList
        Gets the list of possible averaging modes.
        poIContourCtrl GetAvgAcrossPartsEnable
        Gets the state of the average across parts.
        poIContourCtrl GetColoredByLayer
        Gets the current color mode.
        poIContourCtrl GetCornerDataEnabled
        Gets the contour corner data enabled state.
        poIContourCtrl GetCurrentPlotStyle
        Gets the current plot style.
        poIContourCtrl GetDataComponent
        Gets the current data component for the given dimension.
        poIContourCtrl GetDataType
        Gets the current contour data type.
        poIContourCtrl GetDimensionEnabled
        Gets the dimension state.
        poIContourCtrl GetDiscreteColor
        Gets the discrete color mode.
        poIContourCtrl GetEnabled
        Gets the pool state, either enabled or disabled.
        poIContourCtrl GetEnableState
        Gets the auto load/unload contour data state.
        poIContourCtrl GetFeatureAngleAverage
        Gets the angle set for the feature angle average.
        poIContourCtrl GetFeatureAngleAverageEnableState
        Gets the state of the feature angle average.
        poIContourCtrl GetIgnoredFlippedNormal
        Gets the state of the "Ignore Flipped Normal" option set for the feature angle average.
        poIContourCtrl GetInterpolateColor
        Gets the interpolate color mode.
        poIContourCtrl GetLayer
        Gets the current layer's label.
        poIContourCtrl GetLegendHandle
        Gets the legend control object for contouring.
        poIContourCtrl GetMultipleLayerList
        Gets the layer list. Returns both Top/Bottom as multiple layers.
        poIContourCtrl GetMultiplier
        Retrieves the multiplication factor for the current contoured data type.
        poIContourCtrl GetOffset
        Gets the current contour offset value (lowest scale in the legend).
        poIContourCtrl GetPlotStyleList
        Gets a list of all the contour plot styles stored in the contour controller.
        poIContourCtrl GetResultSystem
        Gets the result system ID.
        poIContourCtrl GetShellLayer
        Gets the current shell layer label.
        poIContourCtrl GetShowMidsideNodeResults
        Gets the state of the "Show Midside Node Results" option for the contour control.
        poIContourCtrl GetThresholdMax
        Gets the maximum threshold value of the contour.
        poIContourCtrl GetThresholdMaxEnableState
        Gets the threshold maximum enable state (true/false).
        poIContourCtrl GetThresholdMin
        Gets the minimum threshold value of the contour.
        poIContourCtrl GetThresholdMinEnableState
        Gets the threshold minimum enable state (true/false).
        poIContourCtrl GetValidResultsSystemsList
        Gets a list of valid systems for the specified data type and components.
        poIContourCtrl GetValueFilter
        Gets the contour value filter string.
        poIContourCtrl GetValueFilterEnableState
        Gets the state of the contour value filter.
        poIContourCtrl GetValueList
        Gets the list of values associated with a node or element selection set.
        poIContourCtrl IsMultipleLayer
        Checks to see if the Top/Bottom mode is enabled in the contour controller.
        poIContourCtrl RemovePlotStyle
        Removes a plot style with the specified name.
        poIContourCtrl RenamePlotStyle
        Renames an existing/old plot style with a new name.
        poIContourCtrl RestorePlotStyle
        Resets the contour controller settings with a memorized plot style.
        poIContourCtrl SavePlotStyle
        Captures the current contour controller settings and saves it with the given name.
        poIContourCtrl SetAverageColor
        Sets the averaging state for element results.
        poIContourCtrl SetAverageFactor
        Sets the valid range for the nodal variation factor.
        poIContourCtrl SetAverageMode
        Sets the method by which elemental results are averaged to nodes.
        poIContourCtrl SetAvgAcrossPartsEnable
        Sets the state of the average across parts.
        poIContourCtrl SetColoredByLayer
        Sets the current color mode.
        poIContourCtrl SetCornerDataEnabled
        Enables contouring node on element data.
        poIContourCtrl SetCurrentPlotStyle
        Sets the current plot style.
        poIContourCtrl SetDataComponent
        Sets the data component for a given component.
        poIContourCtrl SetDataType
        Sets the data type for the contour control.
        poIContourCtrl SetDimensionEnabled
        Sets the dimension state; enabled or disabled.
        poIContourCtrl SetDiscreteColor
        Sets the discrete color mode for node-based coloring.
        poIContourCtrl SetEnabled
        Sets the dimension state, either enabled or disabled.
        poIContourCtrl SetEnableState
        Sets the auto load/unload contour data state.
        poIContourCtrl SetFeatureAngleAverage
        Sets the angle for the feature angle average.
        poIContourCtrl SetFeatureAngleAverageEnableState
        Sets the state of the feature angle average.
        poIContourCtrl SetIfMultiLayer
        Sets the Top/Bottom mode in the contour controller.
        poIContourCtrl SetMultipleLayerList
        Sets the Top/Bottom layer.
        poIContourCtrl SetIgnoredFlippedNormal
        Sets the state of the "Ignore Flipped Normal" option for the feature angle average.
        poIContourCtrl SetInterpolateColor
        Sets the interpolate color mode for Interpolation/Modal animation mode.
        poIContourCtrl SetLayer
        Sets the current layer label.
        poIContourCtrl SetMultiplier
        Sets a multiplication factor for the current contoured data type.
        poIContourCtrl SetOffset
        Sets the offset value of the contour.
        poIContourCtrl SetResultSystem
        Sets the result system ID.
        poIContourCtrl SetSelectionSet
        Sets the selected entities to be used by the contour control.
        poIContourCtrl SetShellLayer
        Sets the current shell layer. The scalar storage within HyperView can accept a shell layer or a derived quantity of all shell layers (max, min, or extreme).
        poIContourCtrl SetShowMidsideNodeResults
        Sets the state of the "Show Midside Node Results" option for the contour control.
        poIContourCtrl SetThresholdMax
        Sets the maximum threshold value of a contour.
        poIContourCtrl SetThresholdMaxEnableState
        Sets the threshold maximum enable state value of a contour (true/false).
        poIContourCtrl SetThresholdMin
        Sets the minimum threshold value of a contour.
        poIContourCtrl SetThresholdMinEnableState
        Sets the threshold minimum enable state value of a contour (true/false).
        poIContourCtrl SetValueFilter
        Sets contour value filter value.
        poIContourCtrl SetValueFilterEnableState
        Sets the state of the contour value filter.
      - 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.

poIContourCtrl GetLegendHandle

Gets the legend control object for contouring.

Syntax

poIContourCtrl_handle GetLegendHandle legend_ctrl

Application

HyperView Tcl Query

Description

This command retrieves the legend control object for contouring.

Inputs

legend_ctrl: A legend control object handle (output).

Error

Returns 0 if successful, otherwise an error code.