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

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
        poIFLDCtrl AddCase
        Adds a study case.
        poIFLDCtrl GetActiveCase
        Gets the ID of the active study case.
        poIFLDCtrl GetCategoryColor
        Gets the color of a particular band of the FLD zone category legend.
        poIFLDCtrl GetCategoryLabel
        Gets the label of a particular band of the FLD zone category legend.
        poIFLDCtrl GetCaseHandle
        Gets the study case control object for FLD.
        poIFLDCtrl GetCaseList
        Gets a list of study cases.
        poIFLDCtrl GetCompressionLineOn
        Gets the curve definition mode.
        poIFLDCtrl GetContourMode
        Gets the current contour type of FLD.
        poIFLDCtrl GetCurrentCompressionLineDefFile
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentCompressionLineDefPoints
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentCompressionLineDefPointsNum
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentCompressionLineMathDef
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentFLCDefMode
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentFLCDefPoints
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentFLCDefPointsNum
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentFLCThickness
        Gets the curve definition mode.
        poIFLDCtrl GetCurrentHardenExp
        Gets the curve definition mode.
        poIFLDCtrl GetCurveFitOn
        Gets the curve definition mode.
        poIFLDCtrl GetEnableState
        Gets the auto load/unload FLD data state.
        poIFLDCtrl GetLegendHandle
        Gets the legend control object for FLD.
        poIFLDCtrl GetLooseMetalLineBound
        Gets the curve definition mode.
        poIFLDCtrl GetLooseMetalLineOn
        Gets the curve definition mode.
        poIFLDCtrl GetMarginalLineOffset
        Gets the curve definition mode.
        poIFLDCtrl GetMarginalLineOn
        Gets the curve definition mode.
        poIFLDCtrl GetPartID
        Gets the curve definition mode.
        poIFLDCtrl GetPlotWindow
        Gets the ID of the plot window.
        poIFLDCtrl GetShellLayer
        Gets the curve definition mode.
        poIFLDCtrl GetUseEngineering
        Gets the curve definition mode.
        poIFLDCtrl RemoveCase
        Removes a study case.
        poIFLDCtrl SetActiveCase
        Sets the active study case.
        poIFLDCtrl SetCategoryColor
        Sets the color of a particular band of the FLD zone category legend.
        poIFLDCtrl SetCategoryLabel
        Sets the label of a particular band of the FLD zone category legend.
        poIFLDCtrl SetCompressionLineOn
        Sets the curve definition mode.
        poIFLDCtrl SetContourMode
        Sets the FLD contour type.
        poIFLDCtrl SetCurrentCompressionLineDefFile
        Sets the curve definition mode.
        poIFLDCtrl SetCurrentCompressionLineDefPoints
        Sets the curve definition mode.
        poIFLDCtrl SetCurrentCompressionLineMathDef
        Sets the curve definition mode.
        poIFLDCtrl SetCurrentFLCDefFile
        Sets the curve definition mode.
        poIFLDCtrl SetCurrentFLCDefPoints
        Sets the curve definition mode.
        poIFLDCtrl SetCurrentFLCMathDef
        Sets the curve definition mode.
        poIFLDCtrl SetCurveFitOn
        Sets the curve definition mode.
        poIFLDCtrl SetEnableState
        Sets the auto load/unload FLD data state.
        poIFLDCtrl SetLooseMetalLineBound
        Sets the curve definition mode.
        poIFLDCtrl SetLooseMetalLineOn
        Sets the curve definition mode.
        poIFLDCtrl SetMarginalLineOffset
        Sets the curve definition mode.
        poIFLDCtrl SetMarginalLineOn
        Sets the curve definition mode.
        poIFLDCtrl SetPartID
        Sets the curve definition mode.
        poIFLDCtrl SetShellLayer
        Sets the curve definition mode.
        poIFLDCtrl SetUseEngineering
        Sets the curve definition mode.
      - 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.

poIFLDCtrl GetLegendHandle

Gets the legend control object for FLD.

Syntax

poIFLDCtrl_handle GetLegendHandle legend_ctrl

Application

HyperView Tcl Query

Description

This command retrieves the legend control object for FLD.

Inputs

legend_ctrl: A legend control object handle (output).

Errors

Returns 0 if successful, otherwise an error code.