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.
MediaView
vidINote Class
vidINote GetVisibility
Gets whether the note is displayed or hidden.

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
    - MediaView
      - vidIDisplayCtrl Class
      - vidIMarkerPlot Class
      - vidIMeasurePlot Class
      - vidIMovie Class
      - vidINote Class
        vidINote GetAlignment
        Gets the text alignment for the note.
        vidINote GetAttachment
        Gets the attachment method for the note.
        vidINote GetBitmap
        Gets the filename of any bitmap displayed in the note.
        vidINote GetBorderThickness
        Gets the border thickness of the note.
        vidINote GetColor
        Gets the text color of the note.
        vidINote GetFontHandle
        Gets a handle to an hwIFont interface for the note font.
        vidINote GetName
        Gets the title of the note.
        vidINote GetPosition
        Gets the note position.
        vidINote GetText
        Gets the (unevaluated) text of the note.
        vidINote GetVisibility
        Gets whether the note is displayed or hidden.
        vidINote SetAlignment
        Sets the text alignment for the note.
        vidINote SetAttachment
        Sets the attachment method for the note.
        vidINote SetBorderThickness
        Sets the border thickness of the note.
        vidINote SetColor.
        Sets the text color of the note.
        vidINote SetName
        Sets the title of the note.
        vidINote SetPosition
        Sets the note position.
        vidINote SetText
        Sets the unevaluated text of the note.
        vidINote SetVisibility
        Sets whether the note is displayed or hidden.
      - vidITitle Class
      - vidIVideo Class
      - vidIViewControl Class
    - 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.

vidINote GetVisibility

Gets whether the note is displayed or hidden.

Syntax

vidINote_handle GetVisibility

Application

Tcl Query

Description

Returns true (the note is displayed) or false (the note is hidden).

Errors

None.