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
plt3DIWaterfall Class
plt3DIWaterfall GetDisplayInLegend
Gets whether or not the curve 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
      - plt3DIWaterfall Class
        plt3DIWaterfall AddCursor
        Adds a new cursor on a waterfall.
        plt3DIWaterfall AddSlice
        Adds a new slice to a waterfall.
        plt3DIWaterfall CopySlice
        Copies a waterfall slice to the clipboard.
        plt3DIWaterfall GetColor
        Gets the color of the waterfall.
        plt3DIWaterfall GetCursorHandle
        Gets the handle of a cursor on the waterfall.
        plt3DIWaterfall GetDataSourceHandle
        Gets the handle of a particular data source from the waterfall.
        plt3DIWaterfall GetDisplayInLegend
        Gets whether or not the curve is displayed in the legend.
        plt3DIWaterfall GetGenerateCurves
        Gets whether waterfall is visible.
        plt3DIWaterfall GetHighlighted
        Returns the curve’s highlight state.
        plt3DIWaterfall GetMeshColor
        Gets the color of mesh lines superimposed on the waterfall.
        plt3DIWaterfall GetMeshMode
        Returns the curve’s mesh mode.
        plt3DIWaterfall GetMetaData
        Gets a named meta-data value previously associated with the waterfall.
        plt3DIWaterfall GetNumberOfSlices
        Gets the current number of slices in the waterfall.
        plt3DIWaterfall GetNumberOfSlicesOnClipboard
        Gets the current number of curves on the curve clipboard.
        plt3DIWaterfall GetParametric
        Gets whether a waterfall’s X, Y, and Z vectors are parameterized by U and V vectors.
        plt3DIWaterfall GetPolygonMode
        Returns the curve’s polygon mode.
        plt3DIWaterfall GetSliceHandle
        Gets the handle of a particular slice of the waterfall.
        plt3DIWaterfall GetVisibility
        Gets the curve’s visibility state.
        plt3DIWaterfall PasteSlice
        Pastes a waterfall slice from the clipboard.
        plt3DIWaterfall RemoveCursor
        Removes a cursor from a waterfall.
        plt3DIWaterfall RemoveSlice
        Removes a slice from a waterfall.
        plt3DIWaterfall SetColor
        Sets the color of the waterfall.
        plt3DIWaterfall SetDisplayInLegend
        Sets whether or not the curve is displayed in the legend.
        plt3DIWaterfall SetGenerateCurves
        Sets whether the waterfall is visible.
        plt3DIWaterfall SetMeshColor
        Sets the color of mesh lines superimposed on the waterfall.
        plt3DIWaterfall SetMetaData
        Associates a named meta-data value with the waterfall.
        plt3DIWaterfall SetMeshMode
        Sets the curve’s mesh mode.
        plt3DIWaterfall SetParametric
        Sets whether a waterfall’s X, Y, and Z vectors are parameterized by U and V vectors.
        plt3DIWaterfall SetPolygonMode
        Sets the curve’s polygon mode.
        plt3DIWaterfall SetVisibility
        Sets the auto curve visibility state.
        plt3DIWaterfall StitchCurves
        Converts a waterfall based on individual slices into one based on matrices.
    - 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.

plt3DIWaterfall GetDisplayInLegend

Gets whether or not the curve is displayed in the legend.

Syntax

plt3DIWaterfall_handle GetDisplayInLegend

Application

Tcl Query

Description

Returns:

True: The curve is displayed in the legend.
False: The curve is not displayed in the legend.

Errors

None.