2023.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 2023.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 HyperView and HyperGraph.
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.
Adds a printer to the printer list.
Applies a report.
Capture the active window to an image file of a specific dimension.
Creates a movie file by animating the current page.
Creates a movie file by animating the current page, allowing you to first draw a box and select a sub-rectangle of the page for capture.
Captures the screen to a movie file.
Creates a video file of a window on the current page.
Captures the entire desktop to an image file.
Captures a portion of the desktop to an image file.
Captures the current screen to an image file.
Captures the screen to an image file.
Captures the current screen to an image file of the specified pixel resolution.
Creates an image file of a window on the current page.
Clears the list of registered external solvers.
Clears a visible wait mouse cursor.
Closes the session.
Deletes the given report.
Exports curves in the given format.
Returns the AMF export options interface handle for the session.
Finds the application title.
Obtain a handle to the session’s AVIExportOptions object
Returns the image and screen capture's background mode, 'automatic' or 'maintain'.
Lists the display names of the clients that are available.
Gets the client info handle.
Gets a list of all the currently available clients.
Returns the client manager interface object.
Returns the name of the active client.
Finds the current paper orientation.
Finds the current paper size.
Finds the current printer.
Returns the data file interface object for a given file.
Returns a formatted error message if an error has occurred since the last call to *GetError(). *GetError() clears the error message after being called.
Gets the export mode for the session.
Retrives a list of the names of all currently registered external readers.
Returns a Tcl list of registered external solvers of the form {name, path}.
Gets a list of all of the available fonts.
Returns the GIF export options interface handle for the session.
Obtain a handle to the session’s H3DExportOptions object.
Returns the HWC Record and Playback interface object to load HWC files and execute HWC commands.
Retrieves a list of the names of all currently registered import templates.
Obtain a handle to the session’s JPGExportOptions object.
Gets the library director handle.
Returns information on physical memory, virtual memory, and per process.
Returns memory usage in bytes (physical) and virtual.
Gets the menu controller handle.
Gets the message log handle.
Finds the number of report templates in the session.
Finds the height of the main page client area.
Finds the width of the main page client area.
Returns a list of all the paper size options.
Gets the preference manager handle.
Returns a list of printers that are available for use.
Returns the range of pages to be printed.
Returns the project interface object.
Returns the current recording mode.
Returns the current recording status.
Retrieves a list of the names of all currently loaded report templates.
Gets the report template handle.
Gets the session file name.
Returns the highest Spaceball button ID that can be mapped to a Tcl callback via the RegisterSpaceballCallback procedure.
Accesses application information.
Gets a meta data associated with the session level.
Gets the XML file handle.
Indicates whether the image links in the exported PowerPoint file have embedded or linked images.
Indicates whether or not the specified client type is available in the current session.
Checks if the application is running in standalone mode.
Loads the given report.
Loads the given session file.
Creates a new project.
Posts and displays the indicated message in the message log.
Prints the current session.
Runs a Tcl/Tk script in a protected manner according to the specified execution mode.
Publishes the current session in either the HTML or XML format.
Registers the given external function.
Registers the given external reader.
Appends an external solver to the list of registered external solvers.
Registers the given import template.
Allows registration of Tcl callbacks for Spaceball button events.
Registers the given Templex function.
Removes a printer from the printer list.
Save the current session to a report template.
Writes the session to the given filename.
Sets the background color during image and screen capture.
Sets the current paper orientation.
Sets the current paper size.
Sets the current printer.
Sets the export mode for the page.
Sets the range of pages to be printed.
Sets the session file name.
Associates a value to a variable on the session level.
Sets whether the images in the exported PowerPoint file have embedded links.
Shows a wait mouse cursor in the application.
Unloads a previously loaded XML file, freeing the associated memory.
Unregisters the given Templex function.
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.
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