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.
HyperView
poIBestView Class
SetEntity
Sets the entity information for the best view.

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
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
        ActivateView
        Activates or updates the view with the current settings.
        ClearHiddenSet
        Clears the entry on SetHiddenSet.
        GetEntity
        Gets the entity information of the best view.
        GetFocusRegionSize
        Gets the radius of the sphere used for focused view modes (transparency).
        GetHiddenSet
        Gets the set used to hide entities in the model when showing the best view.
        GetID
        Gets the ID of the best view.
        GetNoteDistance
        Gets the note offset used for notes in screen percentage.
        GetNotePosition
        Gets the note position specified in the best view.
        GetNotePositionList
        Gets the list of available note positions in the best view.
        GetNoteShowSpotID
        Gets the status of whether or not spot IDs are shown in the note text.
        GetSimulationIndex
        Gets the simulation index used in the best view.
        GetSubcase
        Gets the subcase used in the best view.
        GetViewMode
        Gets the view mode used in the best view.
        GetViewModeList
        Gets the list of available view modes that can be used in the best view.
        SetEntity
        Sets the entity information for the best view.
        SetFocusRegionSize
        Sets the radius of the sphere for all focused view modes (transparency).
        SetHiddenSet
        Sets the set to be used for hiding entities.
        SetNoteDistance
        Sets the note offset distance from the entity center.
        SetNotePosition
        Sets the position of the note for the best view around the entity.
        SetNoteShowSpotID
        Sets whether or not the spot ID is shown in the note text.
        SetSimulationIndex
        Sets the simulation index to be used for the best view.
        SetSubcase
        Sets the subcase to be used for the best view.
        SetViewMode
        Sets the view mode to be used for the best view.
        UpdateViewWithCurrent
        Updates the view with the current view orientation and note locations.
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
      - poIFLDCtrl Class
      - poIGraphicMaterial Class
      - poIImagePlaneCtrl Class
      - poIImagePlane Class
      - poIIsoValueCtrl Class
      - poILayerFilter Class
      - poILegend Class
      - poIMeasure Class
      - poIModel Class
      - poINote Class
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
      - poIPostManager Class
      - poIQueryCtrl Class
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
      - poISweepCtrl Class
      - poISymmetry Class
      - poISystem Class
      - poISystemCtrl Class
      - poITensorCtrl Class
      - poITensorDefine Class
      - poITextAttribute Class
      - poITracingCtrl Class
      - poITrackingSystem Class
      - poIVectorCtrl Class
      - poIVectorDefine Class
    - 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.

SetEntity

Sets the entity information for the best view.

Syntax

bestview_handle SetEntity type loc_string

Application

HyperView Tcl Modify

Description

This command sets the entity information for the best view.

Inputs

type: The type of entity used (element, node, or component).
loc_string: A string to locate the entity, poolname, and ID.
Tip: Combinations can be used (example: {Node 123}).

Example

To set the entity information for the best view:

bestview_handle SetEntity element {Shell 1951613}
bestview_handle SetEntity node {Node 3012254}

Errors

Returns success (0) or an error code.