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.
HyperGraph 3D
plt3DIPlane Class
plt3DIPlane SetHighlighted
Sets whether the plane is highlighted.

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
    - HyperGraph 2D
    - HyperGraph 3D
      - plt3DIAxis Class
      - plt3DIBarChart Class
      - plt3DIChart Class
      - plt3DICursor Class
      - plt3DICurve Class
      - plt3DICurveGroup Class
      - plt3DILegend Class
      - plt3DINote Class
      - plt3DIParametric Class
      - plt3DIPlane Class
        plt3DIPlane GetBase
        Gets the plane’s base coordinate.
        plt3DIPlane GetColor
        Returns the color of the plane.
        plt3DIPlane GetCrossSectionOnly
        Returns the cross section only state.
        plt3DIPlane GetD
        Gets the current drag location for the plane.
        plt3DIPlane GetDMax
        Gets the maximum drag location for the plane.
        plt3DIPlane GetDMin
        Gets the minimum drag location for the plane.
        plt3DIPlane GetEnabled
        Gets the plane’s enabled state.
        plt3DIPlane GetFontHandle
        Gets a handle to an hwIFont interface for the font of the plane's label.
        plt3DIPlane GetHighlighted
        Gets whether a plane is highlighted.
        plt3DIPlane GetLabelLocation
        Gets the location of a plane's label.
        plt3DIPlane GetOrientation
        Gets the plane’s orientation plane.
        plt3DIPlane GetTransparent
        Sets the current drag location for the plane.
        plt3DIPlane GetVisibility
        Returns the plane’s visibility state.
        plt3DIPlane Reverse
        Reverses the current direction of the plane.
        plt3DIPlane SetBase
        Sets the plane’s base coordinate.
        plt3DIPlane SetColor
        Sets the plane’s color index.
        plt3DIPlane SetCrossSectionOnly
        Sets the cross section only state.
        plt3DIPlane SetD
        Sets the current drag location for the plane.
        plt3DIPlane SetEnabled
        Sets the plane’s enabled state.
        plt3DIPlane SetHighlighted
        Sets whether the plane is highlighted.
        plt3DIPlane SetLabelLocation
        Sets the location of a plane's label.
        plt3DIPlane SetOrientation
        Sets the plane’s orientation plane.
        plt3DIPlane SetTransparent
        Sets the current drag location for the plane.
        plt3DIPlane SetVisibility
        Sets the plane’s visibility state.
      - plt3DIPlot Class
      - plt3DISurface Class
      - plt3DIWaterfall Class
    - 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.

plt3DIPlane SetHighlighted

Sets whether the plane is highlighted.

Syntax

plt3DIPlane_handle SetHighlighted enabled

Application

Tcl Modify

Description

The appearance of a highlighted plane will change to indicate that it is active or has been picked through the GUI. To see this effect, alter the highlighted flag to cause a redraw of the client.

Inputs

enabled: Highlighted, true or false.

Example

To highlight an existing plane:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetPlaneHandle myPlaneName
myPlaneName SetHighlighted true
myClientName Draw

Errors

Success (0) or an error code.