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
hwIH3DExportOptions Class
hwIH3DExportOptions GetCompressOutput
Queries whether to apply compression to results during output.

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
      - 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
        hwIH3DExportOptions GetCompressOutput
        Queries whether to apply compression to results during output.
        hwIH3DExportOptions GetCompressionLevel
        Gets the level of non-lossy compression.
        hwIH3DExportOptions GetMaxCompressionError
        Queries the maximum margin of error allowable during compression.
        hwIH3DExportOptions GetWriteAnimation
        Queries whether animation data will be exported with the model.
        hwIH3DExportOptions GetWriteAttributes
        Queries whether attributes will be written out with graphical entities.
        hwIH3DExportOptions GetWriteDisplayedComponents
        Queries whether only visible components will be written.
        hwIH3DExportOptions GetWriteEntityIDs
        Queries whether entity IDs will be written with the file.
        hwIH3DExportOptions GetWriteHTML
        Queries whether an HTML file will be generated.
        hwIH3DExportOptions GetWritePreviewImage
        Gets whether a preview image should be imbedded in the file.
        hwIH3DExportOptions GetWriteResults
        Gets whether the contour, vector, or tensor data should be written.
        hwIH3DExportOptions GetWriteSolidsAsFaces
        Queries whether solids should be written as sets of polygonal faces.
        hwIH3DExportOptions SetCompressOutput
        Sets whether to apply compression to results during output.
        hwIH3DExportOptions SetCompressionLevel
        Sets the level of non-lossy compression.
        hwIH3DExportOptions SetMaxCompressionError
        Sets the maximum margin of error allowed during compression.
        hwIH3DExportOptions SetWriteAnimation
        Sets whether animation data is exported with the model.
        hwIH3DExportOptions SetWriteAttributes
        Dictates whether attributes will be written out with graphical entities.
        hwIH3DExportOptions SetWriteDisplayedComponents
        Sets whether only visible components will be written.
        hwIH3DExportOptions SetWriteEntityIDs
        Sets whether the IDs should be written out with the file.
        hwIH3DExportOptions SetWriteHTML
        Sets whether an HTML file will be generated.
        hwIH3DExportOptions SetWritePreviewImage
        Dictates whether a JPEG preview image is embedded in the file.
        hwIH3DExportOptions SetWriteResults
        Controls writing contour, vector, and tensor data.
        hwIH3DExportOptions SetWriteSolidsAsFaces
        Dictates whether solids will be written as 3D elements or 2D faces.
      - 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.

hwIH3DExportOptions GetCompressOutput

Queries whether to apply compression to results during output.

Syntax

hwIH3DExportOptions_handle GetCompressOutput

Application

Tcl Query

Description

Returns true or false, depending on whether writing results is enabled.

Compression is comprised of two processes: lossy and non-lossy. To produce lossless compression, turn compression on and set the allowable error to zero.

Example

To check if compression is enabled:

hwi GetSessionHandle mySessionName
mySessionName GetH3DExportOptionsHandle option_handle
options_handle GetCompressOutput

Errors

None.