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 2019.
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 Session allows you to save the current session as an HTML file or a Microsoft PowerPoint file.
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes with the Parameters Browser.
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 an alignment point to the image plane object.
Calculates the data needed to track an image plane video.
Clears all alignment points of the image plane.
Gets a specific point or the list of points that were used (or would be used) to achieve a multipoint alignment for a 2D image plane.
Gets the mode used to align a 3D image plane with a model.
Gets information about an alignment point.
Gets the alpha transparency associated with the image plane.
Gets the back face visibility setting for the image plane.
Gets the color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
Gets the search tolerance for the target color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
Gets the culling angle setting for the image plane.
Gets the color of the edges when the post-processing Edge detection filter is active on an image plane.
Gets the file name of the image or video associated with the image plane.
Gets the current image post-processing filter mode for the image plane.
Gets the current image post-processing filter type for the image plane.
Gets the types of image post-processing filters available for image planes.
Gets the condition of the Fit display option form the current 2D image plane.
Gets the unique ID for an image plane.
Gets a subset of the input point list which includes all points that do not belong to the active model.
Gets the user assigned label for an image plane.
Gets the index of the last frame for which video tracking has been given.
Gets the current mipmap mode for an image plane.
Gets the list of mipmap modes available for an image plane.
Gets the drawing mode for the image plane.
Gets the number of alignment points in an image plane.
Gets the status of the video tracking marker.
Gets the unique animation sync block for the image plane.
Gets the mode used to synchronize an image plane video with a model animation.
Gets a list of valid sync modes.
Gets the model being synchronized with the image plane video.
Gets the RGB values assigned to the video tracking marker.
Gets the current tracking mode for the image plane.
Gets the list of tracking modes available for an image plane.
Gets the 2D or 3D user transform for the image plane.
Gets the video tracking data used to track a point.
Gets the size of the window used for video tracking.
Gets the visibility setting for the image plane.
Gets the condition of the Zoom display option from the current 2D image plane.
Aligns a 3D image plane with a model.
Transforms the model based on a list of points to align it to a 2D image plane.
Clears the 2D or 3D user transform for the image plane.
Removes an alignment point from an image plane.
Calculate the reprojection error between the current multi-point alignment points.
Defines an alignment point with a model node and image x,y pixel location.
Sets the alpha transparency associated with the image plane.
Associates the image plane with the specified model.
Sets the back face visibility setting for the image plane.
Sets the post-processing filter mode.
Sets the search tolerance for the target color that will be made transparent when the ColorAlpha image post-processing filter is active on the image plane.
Crops the image plane content.
Sets the culling angle setting for the image plane.
Sets the color of the edges when the post-processing edge detection filter is active on an image plane.
Sets the file name of the image or video associated with the image plane.
Sets the image post-processing filter mode for the image plane.
Sets the current image post-processing filter type for the image plane.
Sets a 2D image plane to fit its window in the graphics area.
Sets the user assigned label for an image plane.
Sets the value of the Maintain Aspect Ratio flag for the image plane.
Sets the current mipmap mode for an image plane.
Sets the drawing mode for the image plane.
Sets an image plane in the background or foreground mode to a predefined window location.
Enables/disables the video tracking marker.
Sets the mode used to synchronize an image plane video with a model animation.
Sets the model being synchronized with the image plane video.
Sets the color of the video tracking marker.
Sets the current tracking mode for the image plane.
Sets the 2D or 3D user transform for the image plane.
Explicitly sets the video tracking data.
Sets the size of the window used for video tracking.
Sets the visibility setting for the image plane.
Activate the Zoom function of a 2D image plane.
Checks to see if the sync scale has been modified.
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.
The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.
View All Altair HyperWorks Help