API, Reference Guides

2023.1

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
hwIPage Class
hwIPage GetActiveWindow
Returns the active window index.

What's New
Get Started
Tutorials
API, Reference Guides

2023.1

API, Reference Guides

What's New
View new features for version 2023.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 HyperView and HyperGraph.
- 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
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
        
        hwIPage AddLayer
        Adds a reference to an existing layer to the page.
        
        hwIPage AddWindowSyncGroup
        Adds a window synchronization group.
        
        hwIPage CopyWindow
        Copies a window.
        
        hwIPage Draw
        Forces each window to draw itself.
        
        hwIPage GetActiveWindow
        Returns the active window index.
        
        hwIPage GetActiveWindowExpanded
        Indicates whether the active window on the page is expanded or not.
        
        hwIPage GetAnimationMode
        Returns the page animation mode.
        
        hwIPage GetAnimatorHandle
        Returns an animator object.
        
        hwIPage GetAverageAnimationFramerate
        Gets the average animation framerate, in frames per second.
        
        hwIPage GetCorrelationDifference
        Returns the correlation difference for this page.
        
        hwIPage GetCurrentAnimationFramerate
        Gets the current animation frame rate, in frames per second.
        
        hwIPage GetDefaultLayout
        Finds the default page layout.
        
        hwIPage GetID
        Gets the page’s ID.
        
        hwIPage GetIsExporting
        Gets whether a page is written out when running hwlSession_handle PublishSession.
        
        hwIPage GetLayerList
        Returns a list of layer ID's referenced by this page.
        
        hwIPage GetLayout
        Returns the page layout type.
        
        hwIPage GetMasterSyncBlockID
        Gets the sync block ID of the master, if it is set.
        
        hwIPage GetModelStep
        Gets the model step state.
        
        hwIPage GetNumberOfLayers
        Returns the number of layers referenced by this page.
        
        hwIPage GetNumberOfSyncBlocks
        Returns the number of sync blocks associated with this page.
        
        hwIPage GetNumberOfWindows
        Returns the number of windows.
        
        hwIPage GetPercentOfMaximumSpeed
        Gets the percent of maximum speed currently used by the animator.
        
        hwIPage GetSyncBlockAnimatorHandle
        Returns an animator object for a single sync block in the page.
        
        hwIPage GetSyncBlockIDList
        Returns a list of the sync blocks on this page.
        
        hwIPage GetSyncEnableAnimation
        Gets the flag that indicates whether the animation is enabled for the sync block.
        
        hwIPage GetSyncOffset
        Gets the offset for the sync block identified by the sync block ID.
        
        hwIPage GetSyncScale
        Gets the scale of the sync block identified by the sync block ID.
        
        hwIPage GetSyncTabGenerationPolicy
        Gets the sync table generation policy.
        
        hwIPage GetSyncTolerance
        Gets the animation sync tolerance for the page.
        
        hwIPage GetTitle
        Returns the page title.
        
        hwIPage GetTitleDisplayed
        Returns the page title visibility flag.
        
        hwIPage GetTitleFontHandle
        Gets a handle to an hwIFont interface for the font of the page title.
        
        hwIPage GetWindowHandle
        Returns the window associated with the given window index.
        
        hwIPage GetWindowIDList
        Gets a list of the window IDs.
        
        hwIPage GetWindowSyncGroupItemList
        Gets a list of window IDs in the synchronization group.
        
        hwIPage GetWindowSyncGroupState
        Gets the current state of an existing window synchronization group.
        
        hwIPage IsAnimating
        Returns the current animator's animation state.
        
        hwIPage OverlayWindow
        Combines windows.
        
        hwIPage PasteWindow
        Pastes a previously copied window.
        
        hwIPage RemoveWindowSyncGroup
        Removes a window synchronization group.
        
        hwIPage ResetAnimationFrameRateAverage
        Resets the average animation frame rate tracker.
        
        hwIPage SetActiveWindow
        Sets the active window.
        
        hwIPage SetActiveWindowExpanded
        Expands or reduces the active window on the page.
        
        hwIPage SetAnimationFrameRateTracking
        Enables the animation frame rate tracker.
        
        hwIPage SetAnimationMode
        Set the page’s animation mode.
        
        hwIPage SetIsExporting
        Sets whether or not the page is exported.
        
        hwIPage SetLayout
        Sets the page layout type.
        
        hwIPage SetMasterSyncBlockID
        Sets the new master sync block ID and recalculates the master sync table. This command is ignored if the sync table generation policy is not set to MASTER_BLOCK first.
        
        hwIPage SetModelStep
        Sets the model step state to on or off.
        
        hwIPage SetPercentOfMaximumSpeed
        Sets the percent of maximum speed to be used by the animator.
        
        hwIPage SetSyncEnableAnimation
        Enables or disables animation for the model or page area containing the sync block ID identified.
        
        hwIPage SetSyncOffset
        Sets a new offset for the sync block identified by the sync block ID
        
        hwIPage SetSyncScale
        Sets a new scale for the sync block identified by the sync block ID.
        
        hwIPage SetSyncTabGenerationPolicy
        Sets the sync table generation policy.
        
        hwIPage SetSyncTolerance
        Sets the animation sync tolerance for the page.
        
        hwIPage SetSyncToleranceBySeconds
        Sets the animation sync tolerance for the page in seconds and nanoseconds for better accuracy.
        
        hwIPage SetTitle
        Sets the page title.
        
        hwIPage SetTitleDisplayed
        Sets whether or not the page title is displayed.
        
        hwIPage SetWindowSyncGroupState
        Changes the state of an existing window synchronization group.
        
        hwIPage StartAnimation
        Starts the animation.
        
        hwIPage StopAnimation
        Stops the animation.
        
        hwIPage SwapWindows
        Swaps the contents of two windows on a page.
      - 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
- 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.

View All Altair HyperWorks Help

API, Reference Guides

2023.1

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
hwIPage Class
hwIPage GetActiveWindow
Returns the active window index.

What's New
Get Started
Tutorials
API, Reference Guides

hwIPage GetActiveWindow

Returns the active window index.

Syntax

hwIPage_handle GetActiveWindow

Application

Tcl Query

Error

Success (0) or an error code.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent