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
amfIMeasure Class
amfIMeasure SetShowX
Sets the value of the flag denoting whether or not the X values and X value difference of the end points will be shown on the measure.

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
        amfIMeasure ClearMarker1
        Remove the first marker from the dynamic measure.
        amfIMeasure ClearMarker2
        Remove the second marker from the dynamic measure.
        amfIMeasure ClearPoint1
        Remove the first marker from the static measure.
        amfIMeasure ClearPoint2
        Remove the second marker from the static measure.
        amfIMeasure GetFontHandle
        Gets a handle to an hwIFont interface for the font of the measure.
        amfIMeasure GetColor
        Gets the measure line color.
        amfIMeasure GetFormat
        Gets the format used for displaying values on the measure.
        amfIMeasure GetLength
        Gets the Length of the master measure in the selected unit.
        amfIMeasure GetName
        Gets the name of the measure.
        amfIMeasure GetMarker1ID
        Gets the first marker ID of the dynamic measure line.
        amfIMeasure GetMarker2ID
        Gets the second marker ID of the dynamic measure line.
        amfIMeasure GetMasterTransientFlag
        Gets the value of the flag denoting whether or not the master measure is the transient type.
        amfIMeasure GetPixelLength
        Gets Length of the master measure in screen pixels.
        amfIMeasure GetPrecision
        Gets the number of decimal places displayed for values on the measure.
        amfIMeasure GetShow
        Gets the value of the flag denoting whether or not the measure line should be drawn on the video.
        amfIMeasure GetShowEndPoints
        Gets the value of the flag denoting whether or not the X, Y values of the end points should be shown on the measure.
        amfIMeasure GetShowMagnitude
        Gets the value of the flag denoting whether or not the magnitude annotation should be shown on the measure.
        amfIMeasure GetShowName
        Gets the value of the flag denoting whether or not the name of the measure should be shown on the video.
        amfIMeasure GetShowX
        Gets the value of the flag denoting whether or not the X values of the endpoints and the X value difference should be shown on the measure.
        amfIMeasure GetShowY
        Gets the value of the flag denoting whether or not the Y values of the endpoints and the Y value difference should be shown on the measure.
        amfIMeasure GetTimeStep
        Gets the time step of the transient measure.
        amfIMeasure GetType
        Gets the type of the measure.
        amfIMeasure GetUnits
        Gets the unit type used by the master measure.
        amfIMeasure SetColor
        Sets the color of the measure line.
        amfIMeasure SetFormat
        Sets the format used for displaying values on the measure.
        amfIMeasure SetLength
        Sets the length of the master measure in the selected unit.
        amfIMeasure SetName
        Sets the name of the measure.
        amfIMeasure SetPrecision
        Sets the number of decimal places displayed for values on the measure.
        amfIMeasure SetShow
        Sets the value of the flag denoting whether or not the measure line will be drawn on the video.
        amfIMeasure SetShowEndPoints
        Sets the value of the flag denoting whether or not the X, Y values of the end points will be shown on the measure.
        amfIMeasure SetShowMagnitude
        Sets the value of the flag denoting whether or not the magnitude of the measure will be shown on the video.
        amfIMeasure SetShowName
        Sets the value of the flag denoting whether or not the name of the measure will be shown on the video.
        amfIMeasure SetShowX
        Sets the value of the flag denoting whether or not the X values and X value difference of the end points will be shown on the measure.
        amfIMeasure SetShowY
        Sets the value of the flag denoting whether or not the Y values and Y value difference of the end points will be shown on the measure.
        amfIMeasure SetTimeStep
        Sets the time step of the transient measure.
        amfIMeasure SetUnits
        Sets the unit type of the master measure.
      - 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
      - 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.

amfIMeasure SetShowX

Sets the value of the flag denoting whether or not the X values and X value difference of the end points will be shown on the measure.

Syntax

measure_handle SetShowX on

Application

Tcl Modify

Description

Sets the value of the flag denoting whether or not the X values and the X value difference of the end points will be shown on the video.

Inputs

on

1: Indicates that all the values regarding X will be shown.
0: Indicates all the values regarding X will not be shown.

Example

measure_handle SetShowX 1

Error

Standard hwResult error codes:

1 = HW_Error
3 = HW_InvalidHandle
4 = HW_InvalidArgs

Keywords

MediaView

Measure

Tracing

Tracking System