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
poIPostManager Class
poIPostManager GetMouseFunction
Gets a description of a mouse button function.

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
        poIPostManager AddGraphicMaterial
        Adds a material that describes the graphical properties of a surface, such as shininess, emmissivity, and specular color.
        poIPostManager AddModel
        Loads the given model file. A reference to the model needs to be attached to a post client window using AddModelReference.
        poIPostManager GetAsyncMode
        Query whether the HyperView - MultiCore (previously known as Upfront Data Loading Mode) is enabled or not.
        poIPostManager GetFontList
        Gets the list of fonts available on a machine.
        poIPostManager GetGlobalPropertyList
        Gets the global property list.
        poIPostManager GetGlobalPropertyType
        Gets the global property type.
        poIPostManager GetGlobalPropertyValue
        Gets the global property value.
        poIPostManager GetGlobalPropertyValueRangeList
        Gets the list of values for the global property value.
        poIPostManager GetGraphicMaterialHandle
        Gets a handle to a graphic material.
        poIPostManager GetGraphicMaterialList
        Gets a list of graphic materials.
        poIPostManager GetMaximumMemoryUsage
        Gets the maximum percentage of physical memory that the post client should use.
        poIPostManager GetMemoryWarningEnabled
        Query whether the memory usage warning is enabled.
        poIPostManager GetMemoryWarningThreshold
        Gets the memory warning threshold value.
        poIPostManager GetModelFilterList
        Gets a list of filters for all model readers.
        poIPostManager GetModelHandle
        Gets a handle to a graphic material.
        poIPostManager GetModelList
        Gets a list of all loaded models.
        poIPostManager GetModelReaderList
        Gets a list of model readers for a given model file. If no filename is given, then all model readers are returned.
        poIPostManager GetModelReferenceList
        Gets a list of post (or window) references to the given model.
        poIPostManager GetMouseAction
        Gets the action associated with the given button modifier key string.
        poIPostManager GetMouseFunction
        Gets a description of a mouse button function.
        poIPostManager GetMouseActionList
        Gets the list of available mouse button actions.
        poIPostManager GetNumberOfReaders
        Gets the number of readers.
        poIPostManager GetReaderPropertyList
        Gets the list of properties for the specified reader.
        poIPostManager GetReaderPropertyType
        Gets the property type {NUMBER, STRING, LIST} for the specified reader.
        poIPostManager GetReaderPropertyValue
        Gets the property value for the specified reader.
        poIPostManager GetReaderPropertyValueRangeList
        Gets a range of valid values for a particular property of the specified reader.
        poIPostManager GetRenderOptionsHandle
        Gets the handle to the global graphics rendering options.
        poIPostManager GetResultFilterList
        Gets a list of filters for all result readers.
        poIPostManager GetResultReaderList
        Gets a list of result readers for a given result file. If no filename is given, then all result readers are returned.
        poIPostManager IsFileSupportedForAsync
        Determines whether the given file is supported in HyperView - MultiCore profile.
        poIPostManager IsFontAvailable
        Looks through the list of enumerated fonts to see if there is one that matches the passed attributes.
        poIPostManager IsLoadingData
        Query whether any HyperView window is loading data of the given type.
        poIPostManager RemoveGraphicMaterial
        Removes a material from the material's list.
        poIPostManager RemoveModel
        Removes the given model from the master model table. The model is only removed if there are no other references to that model.
        poIPostManager ResetMouseActions
        Restores the mouse actions to the defaults.
        poIPostManager SetCachingEnabled
        Enables or disables disk caching.
        poIPostManager SetGlobalPropertyDefaults
        Sets the default values to the global properties.
        poIPostManager SetGlobalPropertyValue
        Sets the global property value.
        poIPostManager SetMaximumMemoryUsage
        Sets the maximum percentage of physical memory that the post client should use.
        poIPostManager SetMemoryWarningEnabled
        Enable or disables the memory usage warning.
        poIPostManager SetMemoryWarningThreshold
        Sets the memory warning threshold value.
        poIPostManager SetMouseAction
        Sets the given button and modifier key string to the action.
        poIPostManager SetPoolAliases
        Sets the pool aliases for pool reference resolution.
        poIPostManager SetReaderPropertyValue
        Sets the property value for the specified reader.
        poIPostManager WaitForResults
        Causes the application to wait for all of the results of the given type to load before returning.
      - 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.

poIPostManager GetMouseFunction

Gets a description of a mouse button function.

Syntax

poIPostManager_handle GetMouseFunction key button

Application

HyperView Tcl Query

Description

This command retrieves a description of a mouse button function.

Inputs

key: The name of the key combined with the mouse button. Possible values include: none, ctrl, shift, and ctrl+shift.
button: The number that describes the mouse button. Possible values are: 1, 2, or 3.

Errors

Returns the function name, or an error code.