API, Reference Guides

2023.1

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
plt3DICursor Class
plt3DICursor GetI
Returns the cursor I position.

What's New
Get Started
Tutorials
API, Reference Guides

2023.1

API, Reference Guides

What's New
View new features for version 2023.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 HyperView and HyperGraph.
- 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
        
        plt3DICursor Find
        Moves the cursor to the point corresponding to an argument list.
        
        plt3DICursor FindGlobalMax
        Moves the cursor to the global maximum of one component of the plot.
        
        plt3DICursor FindGlobalMin
        Moves the cursor to the global minimum of one component of the plot.
        
        plt3DICursor FindLocalMax
        Moves the cursor to the local maximum of one component of the plot along an axis.
        
        plt3DICursor FindLocalMin
        Moves the cursor to the local minimum of one component of the plot along an axis.
        
        plt3DICursor GetBoxColor
        Returns the cursor box color index.
        
        plt3DICursor GetBoxVisibility
        Returns the cursor’s box visibility.
        
        plt3DICursor GetHighlighted
        Returns the curve’s highlight state.
        
        plt3DICursor GetI
        Returns the cursor I position.
        
        plt3DICursor GetJ
        Returns the cursor J position.
        
        plt3DICursor GetLineColor
        Returns the curve’s color index.
        
        plt3DICursor GetLineVisibility
        Returns the cursor line’s visibility.
        
        plt3DICursor GetMetaData
        Gets a named meta-data value previously associated with the cursor.
        
        plt3DICursor GetParent
        Gets the unique variable name (varname) of the cursor’s parent object.
        
        plt3DICursor GetTextVisibility
        Returns the cursor’s text visibility.
        
        plt3DICursor GetVisibility
        Returns the curve’s visibility state.
        
        plt3DICursor GetW
        Gets the W value at the cursor location.
        
        plt3DICursor GetX
        Gets the X value at the cursor location.
        
        plt3DICursor GetY
        Gets the Y value at the cursor location.
        
        plt3DICursor GetZ
        Gets the Z value at the cursor location.
        
        plt3DICursor GotoPickedPoint
        Sets the cursor i and j position to match the pick point.
        
        plt3DICursor SetBoxColor
        Sets the cursor box color index.
        
        plt3DICursor SetBoxVisibility
        Sets the cursor box’s visibility.
        
        plt3DICurve SetHighlighted
        Sets the curve’s highlight state.
        
        plt3DICursor SetI
        Sets the cursor I position.
        
        plt3DICursor SetJ
        Sets the cursor J position.
        
        plt3DICurve SetLineColor
        Sets the curve color index.
        
        plt3DICursor SetLineVisibility
        Sets the cursor line’s visibility.
        
        plt3DICursor SetTextVisibility
        Sets the cursor text visibility.
        
        plt3DICurve SetVisibility
        Sets the auto curve visibility state.
      - plt3DICurve Class
      - 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
- 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.

View All Altair HyperWorks Help

API, Reference Guides

2023.1

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
plt3DICursor Class
plt3DICursor GetI
Returns the cursor I position.

What's New
Get Started
Tutorials
API, Reference Guides

plt3DICursor GetI

Returns the cursor I position.

Syntax

plt3DICursor_handle GetI

Application

Tcl Query

Description

Returns the color index.

Errors

None.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent