2021
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk classes for the following HyperWorks Desktop applications.
View new features for HyperWorks Desktop 2021.
Learn the basics and discover the workspace.
Discover HyperWorks Desktop functionality with interactive tutorials.
Start HyperWorks Desktop and configure the applications.
Learn how to create, open, import and save models.
Control the view and display of your model in the modeling window.
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Automate common workflows using the Process Manager or Automate tool.
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
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 allows you perform a series of operations outside the program interface.
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.
APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, MotionView, MediaView and TextView.
Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
Examples of script uses cases.
Learn more about Tcl/Tk with this basic example.
Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
Adds the advanced query and returns the query ID.
Adds/creates a BestView entry to be used for showing individual entities.
Adds a material to the database.
Creates an undefined measure that can be changed to any type.
Loads the given model file, overlaying any existing models.
Adds the model to participate in Result overlay (multi-model plot).
Adds a note.
Adds the query rule to the advanced query.
Adds a result definition with the given label.
Adds a model and result pair to HyperView and enables result math.
Adds a new section of the specified type to the current client.
Applies the style of the current model to another model on the current page, or on a different page in the session.
Arranges the notes so that they are located near their attachment location, while being moved off of the model and legend areas.
Cancels all loading operations that are in progress.
Renders the current HyperView window to an off-screen image file.
Renders a specific region of the current HyperView window to an off-screen image.
Resets the current post instance by removing all models and resetting the view (as well as any other post state).
Clears the notes on all of the best views from the graphics area.
Copies a result definition from another definition.
Redraws the current window.
Exports an H3D format file.
Exports the result definitions to an XML file.
Gets the active model ID.
Gets the handle to the advanced query.
Gets the advanced query list.
Gets the handle of the best view.
Gets the list of best views present in the current session.
Gets the transparency level applied for all best views.
Gets the boundary mesh mode for section cuts and iso surfaces.
Gets a list of all data components for all the models loaded.
Gets a list with all data type labels for all the models loaded.
Gets the default measure type used when creating new measures.
Gets the measure display option setting.
Gets the list of post display options.
Gets the list of fonts available on your machine.
Gets a handle to a graphic material.
Gets the list of graphic material IDs in the database.
Gets a list of shell layer labels from all the models loaded.
Gets the angle format used by all measures in the window.
Gets the global measure display option setting.
Gets a handle to the given measure by ID.
Gets a list of measure IDs.
Gets the numeric format used by all measures in the window.
Gets the number of digits past the decimal to be displayed by all measures in the window.
Gets a handle to the given model by index.
Gets a list of the all model IDs in this window.
Gets a list of model readers for a given model file. If no filename is given, then all model readers are returned.
Gets the handle to the note.
Gets a list of note IDs.
Gets the number of best views present in the current post client.
Gets the number of readers.
Gets the value of the angle for the perspective view.
Gets the query rule handle from the client.
Gets the list of query rules from the client.
Gets a list of all query rule types from the client.
Gets the handle to the global graphics rendering options.
Gets a handle to the specified result definition.
Gets a list of defined result IDs of the given type.
Gets the load progress as a percentage (from 0-100) for the given result.
Gets the error list for Result overlay (multi-model plot).
Gets the list of model IDs which are participating in Result overlay (multi-model plot).
Gets the plot status for the given result definition ID.
Gets a list of result readers for a given result file. If no filename is given, then all result readers are returned.
Gets the load status for the given result definition ID.
If deformable sections are active, the interpolation frame, which was active when the section was cut, becomes planar.
Gets the type of section cut: deformable or planar.
Gets the time at which the section mode was changed to deformable.
Gets a handle to the given section by ID.
Gets a list of sections IDs.
Gets the section cut acceleration.
Gets a list of styles that can be applied to the other models.
Hides all sections available in the window.
Imports the result definitions from an XML file.
Checks if the current model is old or new.
Removes the advanced query.
Removes all loaded models.
Removes the BestView.
Removes the graphical material from the database.
Removes the given measure by ID.
Removes the given model by ID.
Removes the model from participating in Result overlay (multi-model plot).
Removes the note with specified ID.
Removes query rule from the advanced query.
Removes a result definition with the given ID.
Removes the given section by ID.
Sets the active model ID.
Sets the transparency level for all best views.
Sets the boundary mesh mode for iso and section cuts.
Sets the post display options.
Sets the angle format used by all angle measures in this window.
Sets the numeric format used by all measures in this window.
Sets the number of digits past the decimal to be displayed by all measures in this window.
Sets the mesh mode of non-visible geometry.
Sets the angle for the perspective view.
Toggles the deformable section mode.
Sets the global flag controlling the display of non-visible geometry as transparent.
Causes the application to wait for all of the results of the given type to load before returning.
Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
XML commands in the Result Math Module.
Record playback workflows in HyperView.
The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.
View All Altair HyperWorks Help