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.
Framework
amfIMarker Class
amfIMarker GetFinalFrameIndex
Gets the index of the final frame for which the marker is being tracked.

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
      - amfIMarker Class
        amfIMarker GetFillMarker
        Gets the value of the flag denoting whether the marker symbol should be displayed as a filled circle or as an outline.
        amfIMarker GetFinalFrameIndex
        Gets the index of the final frame for which the marker is being tracked.
        amfIMarker GetFontHandle
        Returns a font handle.
        amfIMarker GetInitialFrameIndex
        Gets the index of the initial frame for which the marker is being tracked.
        amfIMarker GetMarkerColor
        Gets the color of the marker symbol.
        amfIMarker GetName
        Gets the name of the marker.
        amfIMarker GetRecalcState
        Gets the value of the flag denoting whether or not the marker should have its tracking data recalculated.
        amfIMarker GetShowState
        Gets the value of the flag denoting whether or not the marker and its trace should be drawn on the video.
        amfIMarker GetTracklineColor
        Gets the color of the trace line drawn for a marker.
        amfIMarker GetTracklineThickness
        Gets the thickness of the trace line drawn for a marker.
        amfIMarker GetTrackPointX
        Gets the initial X coordinate of the marker, in pixels.
        amfIMarker GetTrackPointY
        Gets the initial Y coordinate of the marker, in pixels.
        amfIMarker SetFillMarker
        Sets the value of the flag denoting whether the marker symbol should be displayed as a filled circle or as an outline.
        amfIMarker SetFinalFrameIndex
        Sets the index of the final frame for which the marker will be tracked.
        amfIMarker SetInitialFrameIndex
        Sets the index of the initial frame for which the marker will be tracked.
        amfIMarker SetMarkerColor
        Sets the color of the marker symbol.
        amfIMarker SetName
        Sets the name of the marker.
        amfIMarker SetRecalcState
        Sets the value of the flag denoting whether or not the marker should have its tracking data recalculated.
        amfIMarker SetShowState
        Sets the value of the flag denoting whether or not the marker and its trace will be drawn on the video.
        amfIMarker SetTracklineColor
        Sets the color of the trace line drawn for a marker.
        amfIMarker SetTracklineThickness
        Sets the thickness of the trace line drawn for a marker.
        amfIMarker SetTrackPoint
        Sets the initial X and Y coordinates of the marker, in pixels.
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - HyperGraph 2D
    - 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.

amfIMarker GetFinalFrameIndex

Gets the index of the final frame for which the marker is being tracked.

Syntax

marker_handle GetFinalFrameIndex

Description

Returns the frame number at which the marker will stop being tracked during the tracking calculation. The default value for the final frame index is -1, which means tracking will continue until the end of the video.

Examples

marker_handle GetFinalFrameIndex

Errors

3 = HW_InvalidHandle

Note: A return value of -1 is not an error code in this case, as -1 is the default value for the final frame (see above).