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
poIVectorCtrl Class
poIVectorCtrl GetLegendHandle
Gets the legend control object for vector 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
      - poITrackingSystem Class
      - poIVectorCtrl Class
        poIVectorCtrl CopyToClipBoard
        Copies vector data to the clipboard.
        poIVectorCtrl GetColor
        Gets the color for a given vector component.
        poIVectorCtrl GetColorMode
        Gets the color mode for vectors.
        poIVectorCtrl GetCurrentPlotStyle
        Gets the current plot style.
        poIVectorCtrl GetDataComponent
        Gets the current data component label.
        poIVectorCtrl GetDataType
        Gets the current vector data type label.
        poIVectorCtrl GetDisplayMode
        Gets the vector control display mode.
        poIVectorCtrl GetDisplayModeList
        Gets a list of vector control display modes.
        poIVectorCtrl GetEnabled
        Gets the pool state, either enabled or disabled.
        poIVectorCtrl GetEnableState
        Gets an auto load/unload vector data state.
        poIVectorCtrl GetFont
        Gets the font name being used to draw the vector plot text in the graphics area.
        poIVectorCtrl GetFontHandle
        Gets a handle to the poITextAttribute interface for the vector plot text.
        poIVectorCtrl GetLayer
        Gets the current layer label.
        poIVectorCtrl GetLegendHandle
        Gets the legend control object for vector control.
        poIVectorCtrl GetMultiplier
        Gets the multiplier for vector results.
        poIVectorCtrl GetPlotStyleList
        Gets a list of all the vector plot styles stored in the vector controller.
        poIVectorCtrl GetResultSystem
        Gets the result system ID.
        poIVectorCtrl GetScale
        Gets the scale value used to display vectors.
        poIVectorCtrl GetScaleMode
        Gets the scale mode used to display vectors.
        poIVectorCtrl GetSelectionSetSize
        Gets the size of the selection set.
        poIVectorCtrl GetShellLayer
        Gets the current layer label.
        poIVectorCtrl GetTextColor
        Gets the vector plot text color.
        poIVectorCtrl GetThresholdMax
        Gets the maximum threshold.
        poIVectorCtrl GetThresholdMaxEnableState
        Gets the enable/disable state of the maximum threshold.
        poIVectorCtrl GetThresholdMin
        Gets the minimum threshold.
        poIVectorCtrl GetThresholdMinEnableState
        Gets the enable/disable state of the minimum threshold.
        poIVectorCtrl GetValueList
        When nodal results are in use, multiple results may exist for nodes along part boundaries. In these cases, the returned list will contain the first nodal value encountered, while the nodal values for the other parts will be omitted.
        poIVectorCtrl RemovePlotStyle
        Removes a plot style with the specified name.
        poIVectorCtrl RenamePlotStyle
        Renames an existing/old plot style with a new name.
        poIVectorCtrl RestorePlotStyle
        Resets the vector controller settings with a memorized plot style.
        poIVectorCtrl SetColor
        Sets the component color.
        poIVectorCtrl SetColorMode
        Sets the color mode for vectors.
        poIVectorCtrl SetCurrentPlotStyle
        Sets the current plot style.
        poIVectorCtrl SetDataComponent
        Sets the data component for a given component label.
        poIVectorCtrl SetDataType
        Sets the data type for the vector control.
        poIVectorCtrl SetDisplayMode
        Sets the vector control display mode.
        poIVectorCtrl SetEnabled
        Sets the dimension state, either enabled or disabled.
        poIVectorCtrl SetEnableState
        Sets the auto load/unload vector data state.
        poIVectorCtrl SetFont
        Sets the font by name.
        poIVectorCtrl SetLayer
        Sets the current shell layer.
        poIVectorCtrl SetMultiplier
        Sets the multiplier for the vector results.
        poIVectorCtrl SetResultSystem
        Sets the result system ID.
        poIVectorCtrl SetScale
        Sets the scale value used to display vectors.
        poIVectorCtrl SetScaleMode
        Sets the scale mode used to display vectors.
        poIVectorCtrl SetSelectionSet
        Sets the selected entities to be used by the vector control.
        poIVectorCtrl SetShellLayer
        Sets the current layer.
        poIVectorCtrl SetTextColor
        Sets the vector plot text color.
        poIVectorCtrl SetThresholdMax
        Sets the maximum threshold.
        poIVectorCtrl SetThresholdMaxEnableState
        Sets the enable/disable state of the maximum threshold.
        poIVectorCtrl SetThresholdMin
        Sets the minimum threshold.
        poIVectorCtrl SetThresholdMinEnableState
        Sets the enable/disable state of the minimum threshold.
      - 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.

poIVectorCtrl GetLegendHandle

Gets the legend control object for vector control.

Syntax

poIVectorCtrl_handle GetLegendHandle legend_ctr

Application

HyperView Tcl Query

Description

This command retrieves the legend control object for vector control.

Inputs

legend_ctr: A legend control object handle (output).

Errors

Returns 0 if successful, otherwise an error code.