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.
Postquery Commands
Postquery Animation Commands
::hwp::GetVectorCtrl
Gets a VectorCtrl handle of an animation client model.

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
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
      - Postquery Framework Commands
      - Postquery Animation Commands
        ::hwp::getClosestNode
        Finds the closest node for the specified point coordinates.
        ::hwp::GetComplexCtrl
        Gets a ComplexCtrl handle of an animation client model.
        ::hwp::GetComponent
        Gets a component handle of an animation client model.
        ::hwp::getComponentList
        Gets a list of existing components.
        ::hwp::GetContourCtrl
        Gets a ContourCtrl handle of an animation client model.
        ::hwp::GetContourLegend
        Gets a ContourLegend handle of an animation client model.
        ::hwp::getCurrentSimulation
        Returns the current simulation.
        ::hwp::getCurrentSubcase
        Returns the current subcase.
        ::hwp::getDefaultPartPool
        Gets a page handle.
        ::hwp::GetExplosion
        Gets an explosion handle of an animation client.
        ::hwp::GetFLDCase
        Gets an FLD case study handle.
        ::hwp::GetFLDCtrl
        Gets an FLDCtrl handle of an animation client model.
        ::hwp::GetH3DOptions
        Gets an H3D options handle of an animation client.
        ::hwp::getIdListFromSelectionSet
        Gets an ID list from a given selection set.
        ::hwp::GetIterator
        Gets an iterator handle to a query handle.
        ::hwp::GetLocalSystem
        Gets a SystemHandle to the LocalSystem in an animation client.
        ::hwp::getMaxContourValue
        Displays a contour result.
        ::hwp::GetMeasure
        Gets a measure handle of an animation client model.
        ::hwp::GetModel
        Gets a model handle of the animation client.
        ::hwp::getPhaseAngle
        Sets the phase angle of the current animation window.
        ::hwp::GetQueryControl
        Gets a query handle of an animation client model.
        ::hwp::getRealTime
        Gets the current time of an animation.
        ::hwp::GetRenderOptions
        Gets a render options handle of an animation client.
        ::hwp::GetResultCtrl
        Gets a ResultCtrl handle of an animation client model.
        ::hwp::GetScaleCtrl
        Gets a Scale Control handle of an animation client model.
        ::hwp::GetSection
        Gets a section handle of an animation client model.
        ::hwp::GetSelectionSet
        Gets a SelectionSet handle of an animation client model.
        ::hwp::getSimulationList
        Returns all simulations for a subcase that are contained in the current model/results.
        ::hwp::GetSubcase
        Returns a Subcase handle to the belonging Subcase ID.
        ::hwp::getSubcaseList
        Returns all subcases that are contained in the current model/results.
        ::hwp::GetSystem
        Gets a system handle of an animation client model.
        ::hwp::GetTensorCtrl
        Gets a TensorCtrl handle of an animation client model.
        ::hwp::GetTensorLegend
        Gets a TensorLegend handle of an animation client model.
        ::hwp::GetTrackingSystem
        Gets a tracking system handle of an animation client model.
        ::hwp::GetVectorCtrl
        Gets a VectorCtrl handle of an animation client model.
        ::hwp::GetVectorLegend
        Gets a VectorCtrl handle of the active animation client model.
        ::hwp::hv_gethwcmark
        Returns ID’s of HyperView entities marked with HWC.
      - Postquery Plot Commands
      - Postquery Plot 3D 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.

::hwp::GetVectorCtrl

Gets a VectorCtrl handle of an animation client model.

Syntax

Application

Tcl Query

Description

This procedure returns a VectorCtrl handle of the active HyperView model.

Mandatory Arguments

None.

Optional Arguments

None.

Returns

Returns a VectorCtrl handle of the active animation client model.

Example

set vectorCtrlHandle [::hwp::GetVectorCtrl]