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
plt3DISurface Class
plt3DISurface GetDisplayInLegend
Gets whether a surface is displayed in the legend.

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
      - plt3DIPlot Class
      - plt3DISurface Class
        plt3DISurface AddCursor
        Gets a handle to a plt3DICursor interface for the surface.
        plt3DISurface GetColor
        Gets the color of the surface.
        plt3DISurface GetCursorHandle
        Gets a handle to a plt3DICursor interface for the surface.
        plt3DISurface GetDataSourceHandle
        Gets the handle of a particular data source from the surface.
        plt3DISurface GetDisplayInLegend
        Gets whether a surface is displayed in the legend.
        plt3DISurface GetHighlighted
        Gets whether surface is highlighted.
        plt3DISurface GetMeshColor
        Gets the color of mesh lines superimposed on the surface.
        plt3DISurface GetMeshMode
        Returns the surface’s mesh mode.
        plt3DISurface GetMetaData
        Gets a named meta-data value previously associated with the surface.
        plt3DISurface GetNumberOfCursors
        Gets a handle to a plt3DICursor interface for the surface.
        plt3DISurface GetParametric
        Gets whether a curve’s X, Y, and Z vectors are parameterized by U and V vectors.
        plt3DISurface GetPolygonMode
        Returns the surface’s polygon mode.
        plt3DISurface GetVisibility
        Gets whether surface is visible.
        plt3DISurface RemoveCursor
        Gets a handle to a plt3DICursor interface for the surface.
        plt3DISurface SetColor
        Sets the color of the surface.
        plt3DISurface SetDisplayInLegend
        Sets whether a surface is displayed in the legend.
        plt3DISurface SetHighlighted
        Sets whether the surface is highlighted.
        plt3DISurface SetMeshColor
        Sets the color of mesh lines superimposed on the surface.
        plt3DISurface SetMeshMode
        Sets the surface’s mesh mode.
        plt3DISurface SetMetaData
        Associates a named meta-data value with the surface.
        plt3DISurface SetParametric
        Sets whether a surface’s X, Y, and Z vectors are parameterized by U and V vectors.
        plt3DISurface SetPolygonMode
        Sets the surface’s polygon mode.
        plt3DISurface SetVisibility
        Sets whether the surface is visible.
      - 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.

plt3DISurface GetDisplayInLegend

Gets whether a surface is displayed in the legend.

Syntax

plt3DISurface_handle GetDisplayInLegend

Application

Tcl Query

Description

By default, all surfaces, curves, groups, charts, and waterfalls are displayed in the legend (except while contouring). Individual objects can be excluded from the list by setting this flag to false.

Returns true or false.

Example

To check whether a surface is listed in the legend:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetSurfaceHandle mySurfaceName
mySurfaceName GetDisplayInLegend false
mySurfaceName GetDataSourceHandle dsW w

Errors

None.