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
plt3DICurve Class
plt3DICurve GetShadowPlane
Gets the shadow plane of the curve.

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
        plt3DICurve AddCursor
        Creates a new cursor in HyperGraph 3D.
        plt3DICurve AddInterator
        Gets a handle to a plt3DIIterator interface for Curve.
        plt3DICurve AddPoint
        Adds a point to a 3D curve and optionally sorts the points.
        plt3DICurve DeleteIterator
        Gets a handle to a plt3DIIterator interface for Curve.
        plt3DICurve GetCursorHandle
        Gets a pointer to an hwICursor.
        plt3DICurve GetCurveGroupHandle
        Gets the handle of the curves’ owner (a curve group).
        plt3DICurve GetDataSourceHandle
        Gets a handle to a pulIDataSource for the specified curve.
        plt3DICurve GetDisplayInLegend
        Gets whether or not the curve is displayed in the legend.
        plt3DICurve GetHighlighted
        Gets the highlight state of the curve.
        plt3DICurve GetIteratorHandle
        Gets a handle to a plt3DIIterator interface for Curve.
        plt3DICurve GetLineColor
        Gets the line color of the curve.
        plt3DICurve GetLineStyle
        Gets the line style of the curve.
        plt3DICurve GetLineThickness
        Gets the line thickness of the curve.
        plt3DICurve GetMetaData
        Gets a named meta-data value previously associated with the curve.
        plt3DICurve GetNumberOfCursors
        Gets the number of cursors on the curve.
        plt3DICurve GetNumberOfIterators
        Gets a handle to a plt3DIIterator interface for Curve.
        plt3DICurve GetNumberOfPoints
        Gets the number of points on the curve.
        plt3DICurve GetParametric
        Gets whether a curves X, Y, and Z vectors are parameterized by a U vector.
        plt3DICurve GetShadowColor
        Returns the curve’s shadow color index.
        plt3DICurve GetShadowFilled
        Returns the shadow’s filled state.
        plt3DICurve GetShadowIntensity
        Gets opacity of the shadow under the curve.
        plt3DICurve GetShadowPlane
        Gets the shadow plane of the curve.
        plt3DICurve GetShadowTransparent
        Gets whether the shadow under the curve is transparent.
        plt3DICurve GetShadowVisibility
        Returns the shadow visibility state.
        plt3DICurve GetSymbolColor
        Gets the symbol color of the curve.
        plt3DICurve GetSymbolEvery
        Gets the symbol frequency of the curve.
        plt3DICurve GetSymbolSize
        Gets the size of symbols along the curve.
        plt3DICurve GetSymbolStyle
        Gets the symbol style of the curve.
        plt3DICurve GetVisibility
        Returns the curve’s visibility state.
        plt3DICurve RemoveCursor
        Removes a cursor from HyperGraph 3D.
        plt3DICurve SetDisplayInLegend
        Sets whether or not the curve is displayed in the legend.
        plt3DICurve SetHighlighted
        Sets the curve’s highlight state.
      - plt3DICurveGroup Class
      - plt3DILegend Class
      - plt3DINote Class
      - plt3DIParametric Class
      - plt3DIPlane Class
      - 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.

plt3DICurve GetShadowPlane

Gets the shadow plane of the curve.

Syntax

plt3DICurve_handle GetShadowPlane

Application

Tcl Query

Description

Returns the index of the symbol of the curve.

Errors

None.