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 new assembly.
Adds a section of the specified type to the current client.
Adds a new explosion to the current model.
Creates a part from the given part reference parented by the given assembly locator string.
Creates a new selection set on the current model.
Creates a tracking system and assigns a name.
Adds a new coordinate system to the current model.
Sets component material to default values. Calling this command on an assembly has no affect.
Applies the style of the current model to another model on the current page, or on a different page in the session.
Changes the type of the current selection set with respect to the selection set entity binding.
Defines an assembly in a model.
Gets the ID of the active explosion.
Gets the active tracking system ID.
Gets an assembly handle for the given assembly locator string.
Gets the parent assembly's ID.
Returns the bounding box coordinates of the model.
Gets the number of child components. For an assembly, only the child parts and assemblies are returned, the IDs of child systems are not returned.
Gets the component color index. If this component is an assembly, the returned color will always be the first one listed in the color table.
Gets the current color mode for the model.
Gets the list of available color modes.
Gets a handle to the given component by ID.
Gets the component ID.
Gets a handle to the given cross section by ID.
Gets a list of cross sections IDs (both planar and set types).
Gets a list of cross sections IDs (planar type).
Gets a list of cross sections IDs (set type).
Gets the component display option setting. If this component is an assembly, true will indicate that one or more child parts have the display mode set.
Gets the list of component display modes.
Gets the number of entities of a particular pool type and optionally, the pool label.
Returns the property information for a given entity.
Gets the list of entity IDs in a given pool.
Gets a list of explosion IDs.
Gets the failed element counts for a given element configuration and simulation.
Gets the failure time list with information of element ID, time frame, and time value.
Gets the model file name.
Gets the global property list.
Gets the model ID.
Gets the label ID.
Populates the given set with the currently masked elements.
Gets the component material ID (zero if none assigned). If this is an assembly, -1 is always returned.
Gets the component's mesh mode. If this is an assembly, ALL child parts must be set to the same mesh mode, otherwise the returned mode will be "none".
Gets the number of child components.
Gets the number of components in this model.
Gets the number of elements in this model.
Gets the number of nodes in this model.
Gets the number of parts in this model.
Gets the number of systems in the model.
Gets a handle to the given part assembly by ID.
Gets the list of part assembly IDs in the model.
Gets a handle to the given part by ID.
Gets a handle to the given part set by ID.
Gets the list of part set IDs in the model.
Gets the component's polygon mode. If this is an assembly, ALL child parts must have the same polygon mode set, otherwise the returned mode will be "none".
Gets the list of pools for the particular type in this model.
Gets the type of pools available in this model.
Gets a handle to the query control object.
Gets the model reader name.
Gets a handle to the result control object.
Returns the reader options which were used to read the model data.
Gets the attached result file name.
Gets the list of loaded result IDs.
Gets the result reader name.
Returns the reader options which were used to read the result data.
Retrieves the handle for a particular selection set.
This command retrieves a list of all selection set IDs on the current model.
Gets a list of styles that can be applied to other models.
Gets the model sync block ID.
Gets the list of coordinate system groups (analogous to the HyperMesh system collectors).
Gets the coordinate system handle by ID.
Gets a list of coordinate systems for the given group ID.
Gets the tracing control.
Gets the component's tracing mode. If this is an assembly mode, "ff" is always returned.
Gets the tracking system's drawing mode.
Gets a handle to the given tracking system by ID.
Gets a list of tracking system IDs.
Gets the translation vector in the global coordinate system. If this component is an assembly, a zero translation will always be returned.
Gets the component's type string.
Gets a handle for the user-defined system as specified by the ID string.
Gets a list containing all of the user-defined systems present in the current model.
Gets a list containing all of the possible types of user-defined systems which can be created.
Gets the model's visibility state.
Gets the coordinates of the currently visible nodes for the part (part_locator). If for example there is an active 0 width cross section, only the nodes on the cut will be returned (the same will be true for ISO sections). Node positions will be listed only once.
Returns the number of entities in the selection set which are visible in the current view orientation.
Masks the contents of a selection set.
Masks all parts or systems.
Masks off screen elements.
Removes an assembly from the model.
Removes the given explosion by ID.
Removes the given part reference from its parent.
Removes a result from the model.
Removes a selection set on the current model.
Removes the given tracking system by ID.
Removes a user-defined system from the current model.
Reverses the visibility on elements and systems.
Sets the active explosion by ID.
Sets the active tracking system by ID.
Sets the model's approximation error.
Sets the parent to the assembly identified by assy_id. This will always fail. You cannot change the model's parent.
Enables or disables the selection set identified by the set_id.
Sets the component's color index. This command will be invalid if it is called on a component that is an assembly, doing so will have no affect, and a warning will be returned.
Sets the current color mode for the model.
Sets the component display option setting. If this component is an assembly, all the child parts will be set to this state.
Sets the model label.
Sets the component material index. Calling this command on an assembly has no affect.
Sets the component's mesh mode. If this is an assembly, ALL child parts are set to the specified mesh mode.
Sets the component's polygon mode. If this is an assembly, ALL child parts are set to the specified polygon mode.
Attaches the given result file to the model.
Sets the model sync value.
Sets the component's tracing mode. This command has no affect on an assembly.
Sets the tracking system drawing mode.
Sets the translation vector in the global coordinate system. If this component is an assembly, a zero translation will always be returned. Translating/exploding the root level (model) assembly is an invalid operation. The translation will be put into a TRANSLATION mode explosion.
Sets the model's visibility state (doesn't affect part/element visibility).
Unmasks the contents of a selection set.
Unmasks all elements.
Unmasks screen elements.
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