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.
Framework
hwIAnimator Class
hwIAnimator SetUseBitmap
Sets the current animator's use bitmap flag.

Welcome
What's New
View new features for version 2025.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
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
        hwIAnimator AtModelStep
        Tests if the animator is at the model step.
        hwIAnimator GetBounce
        Gets the current animator's bounce state.
        hwIAnimator GetCurrentFrame
        Gets the current frame index.
        hwIAnimator GetCurrentStep
        Gets the current animation step index.
        hwIAnimator GetCurrentTime
        Gets the current time in seconds.
        hwIAnimator GetEndFrame
        Gets the end frame index.
        hwIAnimator GetEndTime
        Gets the end time in seconds.
        hwIAnimator GetMaxTime
        Gets the current animator's maximum time.
        hwIAnimator GetMinTime
        Gets the current animator's minimum time.
        hwIAnimator GetMode
        Gets the current mode (or type) of the current animator.
        hwIAnimator GetNumberOfFrames
        Gets the number of frames to be interpolated.
        hwIAnimator GetNumberOfSteps
        Gets the number of animation steps.
        hwIAnimator GetStartFrame
        Returns the start frame of the animator.
        hwIAnimator GetStartTime
        Gets the start time in seconds.
        hwIAnimator Next
        Advances the animator to the next frame. If the animator is at the last frame, Next wraps to the first frame.
        hwIAnimator Previous
        Advances the animator to the previous frame. If the animator is at the first frame, Previous wraps to the last frame.
        hwIAnimator SetBounce
        Sets the current animator's bounce state.
        hwIAnimator SetCurrentFrame
        Sets the current frame index.
        hwIAnimator SetCurrentStep
        Sets the current animation step index.
        hwIAnimator SetCurrentTime
        Sets the current time.
        hwIAnimator SetEndTime
        Sets the end time.
        hwIAnimator SetNumberOfFrames
        Sets the number of frames to be interpolated.
        hwIAnimator SetStartFrame
        Sets the start frame of the animator.
        hwIAnimator SetStartTime
        Sets the start time.
        hwIAnimator SetUseBitmap
        Sets the current animator's use bitmap flag.
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - 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.

hwIAnimator SetUseBitmap

Sets the current animator's use bitmap flag.

Syntax

hwIAnimator_handle SetUseBitmap usebitmap

Application

HyperView Tcl Modify

Description

This command sets the current animator's use bitmap flag.

Note: This flag is used to speed up animation of large models by saving bitmap images for each frame, then flipping through them instead of recalculating each frame.

Inputs

usebitmap: The use bitmap state: either true or false.

Error

Returns 0 if successful, otherwise an error code.