2024.1
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.
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk classes for the following Altair HyperWorks applications.
View new features for version 2024.1.
Learn the basics and discover the workspace.
Discover product functionality with interactive tutorials.
Extensions are programs integrated with the application to enhance or extend the user experience.
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.
The Python API documentation for HyperMesh applications.
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.
Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, 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 Tcl/Tk commands with this tutorial.
Gets the state of the global flag controlling the display of non-visible geometry using feature lines.
Gets the state of the global flag controlling the display of non-visible geometry as transparent.
Gets the state of Animation during Dynamic view manipulation.
Gets the current anti-aliasing setting.
Gets the color of the specified global axis.
Gets the color of the labels for the global axis.
Gets the background color of the view.
Gets the quality of images to be captured or printed.
Gets the selection highlighting color.
Gets the selection highlighting mode.
Gets the lighting state when a contour is applied.
Gets the size used to draw coordinate systems.
Indicates whether the Display Acceleration Block (DAB) display acceleration is enabled or disabled.
Gets the default selection highlighting color.
Gets the element mark drawing state.
Gets the element mark shape for a given element configuration.
Gets the status of the environment mapping option.
Gets the image format of the environment mapping textures.
Gets the relative path of the environment mapping textures folder.
Gets the element mark size in model percentage units.
Gets the erosion draw enabled status (true/false).
Gets the ratio of distance between the viewer's eyes and the distance from the screen.
Gets the feature or crease angle between elements.
Gets the foreground color of the view.
Gets the thickness of the lines generated from iso value and section cut operations.
Gets the global axis draw option.
Gets the gradient background layout.
Gets a list of available background gradient layouts.
Gets the current lighting mode.
Gets the light position in the form "x y".
Gets the material shininess.
Gets the mesh line color.
Gets the mesh color mode.
Gets the list of all mesh color modes.
Gets the current value of the mesh detail slider.
Gets the number of simulation steps to trace.
Gets the status of the optimize rotate/pan option.
Gets the current view mode.
Gets the pick aperture size or tolerance for the mouse cursor.
Gets the PreLoad Simulation Data state.
Gets the status of the realistic rendering option.
Gets the legend image capturing state.
Gets the image capturing state.
Gets whether to scale annotations during image capture.
Gets the shading mode.
Gets the display state of the triad axis arrows.
Gets the specular color.
Gets the number of spring coils beyond which a cylinder will be generated (rather than a spring).
Returns whether or not the stereoscopic display is enabled.
Gets the perspective field of view angle when the stereoscopic display is enabled.
Gets the undeformed shape color mode.
Gets the undeformed shape mesh mode.
Gets the undeformed track enabled state.
Gets the color specified for the undeformed shape.
Gets whether to use the model center during keyboard rotations.
Gets the view acceleration state.
Gets the display mode of the view cube.
Gets the geometry mode of the view cube.
Gets the current front face orientation of the view cube.
Gets the current position of the view cube.
Gets the reflectors display mode of the view cube.
Gets the rotator increment angle of the view cube.
Gets the rotators display mode of the view cube.
Gets the status of the smooth view transition option.
Gets the zoom factor.
Sets the global flag controlling the display of non-visible geometry using feature lines.
Sets the global flag controlling the display of non-visible geometry as transparent.
Sets the state of Animation during Dynamic view manipulation.
Sets the current anti-aliasing setting.
Sets the color for the global axis.
Sets the color of the labels for the global axis.
Sets the background color(s).
Sets the quality of images to be captured or printed.
Sets the selection highlighting color.
Sets the selection highlighting mode to transparent highlighting.
Sets the lighting state when a contour is applied.
Sets the size used to draw coordinate systems.
Allows you to enable or disable the Display Acceleration Block (DAB) display acceleration.
Sets the element mark state.
Sets the element mark shape for a given element configuration.
Sets the element mark size in model percentage units.
Sets the status of the environment mapping option.
Sets the relative path and image format of the environment textures folder.
Sets the erosion draw enabled status.
Sets the ratio of distance between the viewer's eyes and the distance from the screen.
Sets the feature or crease angle between elements.
Sets the foreground color of the view.
Sets the thickness of lines generated from iso value and section cut operations.
Sets the global axis draw option.
Sets the gradient background layout.
Sets the current lighting mode.
Sets the light position.
Sets the material shininess.
Sets the mesh lines color.
Sets the mesh color mode.
Sets the current value of the mesh detail slider.
Sets the number of simulation steps to trace.
Sets the status of the optimize rotate/pan option.
Enables/disables perspective viewing. If disabled, an orthographic view is displayed.
Sets the pick aperture size or tolerance for the mouse cursor.
Sets the PreLoad Simulation Data state.
Sets the status of the realistic rendering option.
Sets the legend image capturing state.
Sets the image capturing state.
Set to enable the scaling of annotations during image capture.
Sets the shading mode.
Sets the display state of the triad axis arrows.
Sets the specular color.
Sets the number of spring coils beyond which a cylinder will be generated (rather than a spring).
Enables/disables the stereoscopic display.
Sets the perspective field of view angle when the stereoscopic display is enabled.
Sets the undeformed shape color mode.
Sets the undeformed shape mesh mode.
Sets the undeformed track enabled state.
Sets the color for undeformed shape.
Set whether to use the model center for keyboard rotations.
Sets the view acceleration state.
Sets the view cube display state.
Sets the view cube geometry state.
Sets the view cube front face orientation.
Sets the view cube position.
Sets the view cube reflectors display state.
Sets the view cube rotator increment angle.
Sets the view cube rotators display state.
Sets the smooth view transition state.
Sets the zoom factor.
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 the application.
Use the Task Manager to load an XML file that defines tasks and their attributes.
The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.
View All Altair HyperWorks Help