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 2D
pltINote Class
pltINote GetCursorAlwaysVisible
Gets whether the animation cursor is always shown.

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
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
      - pltIDrawControl Class
      - pltIEdit Class
      - pltIExportCtrl Class
      - pltILegend Class
      - pltIMacro Class
      - pltINote Class
        pltINote DrawOutline
        Draws an outline around a note.
        pltINote GetAlignment
        Gets the text alignment for the note.
        pltINote GetAttachment
        Gets the attachment method for the note.
        pltINote GetAttachToCurveIndex
        Gets the index of the curve to which the note is attached.
        pltINote GetAttachToPointIndexExpression
        Gets the expression or the value of the point on the curve to which the note is attached.
        pltINote GetAttachToPointIndexValue
        Gets the index of the point on the curve to which the note is attached.
        pltINote GetBitmap
        Gets the filename of any bitmap displayed in the note.
        pltINote GetBorderThickness
        Gets the border thickness of the note.
        pltINote GetColor
        Gets the text color of the note.
        pltINote GetComplexLinkToPhase
        Gets the flag for whether this note is linked to a Phase curve.
        pltINote GetComplexLinkToReal
        Gets the flag for whether this note is linked to a Real curve.
        pltINote GetContextMenuParameter
        Gets the note’s context menu parameter.
        pltINote GetCoordinateXExpression
        Gets the expression for the x value to which the note is attached.
        pltINote GetCoordinateXValue
        Gets the x coordinate value when the note’s attachment type is “Coordinates”.
        pltINote GetCoordinateYExpression
        Gets the expression for the y value to which the note is attached.
        pltINote GetCoordinateYValue
        Gets the y coordinate value when the note’s attachment type is “Coordinates”.
        pltINote GetCursorAlwaysVisible
        Gets whether the animation cursor is always shown.
        pltINote GetCurveColor
        Gets whether the note color is automatically matched to curve color.
        pltINote GetEmbedded
        Finds if the note is embedded on a curve.
        pltINote GetFontHandle
        Gets a handle to an hwIFont interface for the font of the note.
        pltINote GetIndex
        Gets the note’s index.
        pltINote GetName
        Gets the title of the note.
        pltINote GetPosition
        Gets the position of a note in a plot client.
        pltINote GetText
        Gets the (unevaluated) text of the note.
        pltINote GetVisibility
        Gets whether the note is displayed or hidden.
        pltINote SetAlignment
        Sets the text alignment for the note.
        pltINote SetAttachment
        Sets the attachment method for the note.
        pltINote SetAttachToCurveIndex
        Sets the index of the curve to which the note is attached.
        pltINote SetAttachToPointIndex
        Sets the index of the point on the curve to which the note is attached.
        pltINote SetBitmap
        Sets the filename of the bitmap to be displayed in the note.
        pltINote SetBorderThickness
        Sets the border thickness of the note.
        pltINote SetColor
        Sets the text color of the note.
        pltINote SetComplexLinkToPhase
        Set the flag for whether this note is linked to a Phase curve.
        pltINote SetComplexLinkToReal
        Set the flag for whether this note is linked to Phase curve.
        pltINote SetCoordinateXExpression
        Sets the expression for the x value to which the note is attached.
        pltINote SetCoordinateYExpression
        Sets the expression for the y value to which the note is attached.
        pltINote SetCursorAlwaysVisible
        Sets whether to always show the animation cursor.
        pltINote SetCurveColor
        Sets whether to match note color to curve color.
        pltINote SetEmbedded
        Sets if the note is embedded on a curve.
        pltINote SetName
        Sets the title of the note.
        pltINote SetPosition
        Sets the position of a note in the plot client.
        pltINote SetRasterPosition
        Sets the position of the note.
        pltINote SetText
        Sets the unevaluated text of the note.
        pltINote SetVisibility
        Sets whether the note is displayed or hidden.
      - pltIPlot Class
      - pltIPlotManager Class
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
      - pulIMacroParameter Class
    - HyperGraph 3D
    - 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.

pltINote GetCursorAlwaysVisible

Gets whether the animation cursor is always shown.

Syntax

pltINote_handle GetCursorAlwaysVisible

Application

Tcl Query

Description

Gets whether the animation cursor is always shown. Returns True if the cursor is always shown, otherwise false.

Normally, the animation cursor is only shown during animation or in certain graphical user interface modes. This command interrogates whether the cursor is always shown.

Example

To determine whether the cursor is always shown:

hwi ReleaseAllHandles
hwi GetActiveClientHandle myPlotName
myPlotName GetCursorAlwaysShown

Errors

None.

Keywords

Tcl

Note

Query