HyperWorks Desktop

2021

Home
HyperWorks Desktop Reference Guides
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.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following HyperWorks Desktop applications.
HyperView
poISection Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

2021

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Learn how to create, open, import and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
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.
HyperWorks Desktop Reference Guides
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.
- HyperWorks Desktop
  - External Readers and Altair Binary Format
    Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
  - Generic ASCII Reader
    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
    Batch mode allows you perform a series of operations outside the program interface.
  - External Resources
    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.
  - Tcl/Tk Commands
    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
    - Program with HyperWorks APIs for Beginners
      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.
    - Object Hierarchy
      Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, MotionView, MediaView and TextView.
    - Tcl/Tk Classes
      Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
    - Script Use Cases
      Examples of script uses cases.
    - Tcl/Tk Example
      Learn more about Tcl/Tk with this basic example.
    - Program with HyperWorks Tcl/Tk Command Tutorials
      Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
    - Tcl/Tk Commands
      Tcl/Tk classes for the following HyperWorks Desktop applications.
      - HyperWorks Desktop
      - MotionView
      - HyperView
        
        Hotspot Finder API Structure
        
        Upfront Data Loader APIs
        
        poI3DViewCtrl Class
        
        poIAdvancedQuery Class
        
        poIAssembly Class
        
        poIBestView Class
        
        poICFD Class
        
        poICFD_rake Class
        
        poICollisionCtrl Class
        
        poICollisionSet Class
        
        poIComplexCtrl Class
        
        poIComponent Class
        
        poIContourCtrl Class
        
        poIExplosion Class
        
        poIFBDCtrl Class
        
        poIFLDCtrl Class
        
        poIGraphicMaterial Class
        
        poIImagePlaneCtrl Class
        
        poIImagePlane Class
        
        poIIsoValueCtrl Class
        
        poILayerFilter Class
        
        poILegend Class
        
        poIMeasure Class
        
        poIModel Class
        
        poINote Class
        
        poIPart Class
        
        poIPartAssembly Class
        
        poIPost Class
        
        poIPostManager Class
        
        poIQueryCtrl Class
        
        poIQueryDistanceRule Class
        
        poIQueryExpressionRule Class
        
        poIQueryExtremeRule Class
        
        poIQueryIgnoreElemTypeRule Class
        
        poIQueryIterator Class
        
        poIQueryRule Class
        
        poIQuerySetRule Class
        
        poIRenderOptions Class
        
        poIResultCtrl Class
        
        poIResultMathCtrl Class
        
        poIScalarDefine Class
        
        poIScaleCtrl Class
        
        poISCL Class
        
        poISection Class
        
        poISection GetBase
        Gets the section base coordinate.
        
        poISection GetBaseFrame
        Gets the section base frame (for deformable sections only).
        
        poISection GetBaseTime
        Gets the section base time.
        
        poISection GetClipAbove
        Gets the current direction of the clipping surface (above or below).
        
        poISection GetClipElements
        Gets the boundary element clipping state for a section.
        
        poISection GetColor
        Gets the section cut color value.
        
        poISection GetColorOverride
        Gets the state of color override option for a section cut.
        
        poISection GetCrossSectionOnly
        Gets the cross section only state.
        
        poISection GetD
        Gets the plane "D" parameter for a Planar section type.
        
        poISection GetDeformMode
        Gets the deform mode. Section cuts operate in either deformable or section_type (planar or spherical) mode.
        
        poISection GetDisplayOption
        Gets the state of the given section display option.
        
        poISection GetDMax
        Gets the maximum plane "D" parameter for a Planar section type.
        
        poISection GetDMin
        Gets the minimum plane "D" parameter for a Planar section type.
        
        poISection GetGridSpacingX
        Gets the distance between each grid line on the local X axis for a Planar section type.
        
        poISection GetGridSpacingY
        Gets the distance between each grid line on the local Y axis for a Planar section type.
        
        poISection GetGridTextPrecision
        Gets the precision of the grid text values for a Planar section type.
        
        poISection GetID
        Gets the section ID.
        
        poISection GetLabel
        Gets the section label.
        
        poISection GetOrientation
        Gets the section's orientation plane for a Planar section type.
        
        poISection GetOrientationMethod
        Gets the section display mode, used to control polygon visibility for a Planar section type.
        
        poISection GetRadius
        Gets the clipping sphere radius for a Spherical section type.
        
        poISection GetType
        Gets the type of section.
        
        poISection GetVisibility
        Gets the section visibility state.
        
        poISection GetWidth
        Gets the width of a cross section.
        
        poISection Reverse
        Reverses the current direction of the clipping plane.
        
        poISection SetBase
        Sets the section base coordinate.
        
        poISection SetBaseFrame
        Sets the section base frame (for deformable sections only).
        
        poISection SetBaseNode
        Sets the section base coordinate.
        
        poISection SetBaseTime
        Sets the base time for a section cut.
        
        poISection SetClipAbove
        Toggles the current direction for the section.
        
        poISection SetClipElements
        Toggles the boundary element clipping state for a section.
        
        poISection SetClipTransparency
        Sets whether the clipped geometry (by iso or section cut) is displayed as transparent instead of being ignored.
        
        poISection SetColor
        Sets the section cut color.
        
        poISection SetColorOverride
        Sets the state of the color override option for a section.
        
        poISection SetCrossSectionOnly
        Sets the cross section only state.
        
        poISection SetD
        Sets the plane "D" parameter for a Planar section type.
        
        poISection SetDeformMode
        Toggles the deformable section mode.
        
        poISection SetDIncrement
        Sets the amount to increment the plane's "D" when translating the section along the normal for a Planar section type.
        
        poISection SetDisplayOption
        Sets the state of the given section display option.
        
        poISection SetGridSpacingX
        Sets the distance between each grid line on the local X axis for a Planar section type.
        
        poISection SetGridSpacingY
        Sets the distance between each grid line on the local Y axis for a Planar section type.
        
        poISection SetGridTextPrecision
        Sets the precision of the grid text values for a Planar section type.
        
        poISection SetLabel
        Sets the section label.
        
        poISection SetOrientation
        Sets the section's orientation plane for a Planar section type.
        
        poISection SetOrientationMethod
        Sets the section orientation method for a Planar section type.
        
        poISection SetOrientationNode
        Sets the section's orientation plane by model/node ID pairs for a Planar section type.
        
        poISection SetRadius
        Sets the clipping sphere radius for a Spherical section type.
        
        poISection SetVisibility
        Sets the section visibility.
        
        poISection SetWidth
        Sets the width of a cross section for a Planar section type.
        
        poISelectionSet Class
        
        poIStressLinearizationCtrl Class
        
        poISubcase Class
        
        poISweepCtrl Class
        
        poISymmetry Class
        
        poISystem Class
        
        poISystemCtrl Class
        
        poITensorCtrl Class
        
        poITensorDefine Class
        
        poITextAttribute Class
        
        poITracingCtrl Class
        
        poITrackingSystem Class
        
        poIVectorCtrl Class
        
        poIVectorDefine Class
      - HyperGraph 2D
      - HyperGraph 3D
      - MediaView
      - TextView
      - HgTrans
      - TableView
  - Translators
    Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
  - Result Math
    XML commands in the Result Math Module.
  - HyperWorks Record and Playback
    Record playback workflows in HyperView.
- HyperWorks Report
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script Exchange
  The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.

View All Altair HyperWorks Help

HyperWorks Desktop

2021

Home
HyperWorks Desktop Reference Guides
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.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following HyperWorks Desktop applications.
HyperView
poISection Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

poISection Class

Note: See the Section Cut topic in the HyperView User's Guide for additional information.

poISection GetBase
Gets the section base coordinate.
poISection GetBaseFrame
Gets the section base frame (for deformable sections only).
poISection GetBaseTime
Gets the section base time.
poISection GetClipAbove
Gets the current direction of the clipping surface (above or below).
poISection GetClipElements
Gets the boundary element clipping state for a section.
poISection GetColor
Gets the section cut color value.
poISection GetColorOverride
Gets the state of color override option for a section cut.
poISection GetCrossSectionOnly
Gets the cross section only state.
poISection GetD
Gets the plane "D" parameter for a Planar section type.
poISection GetDeformMode
Gets the deform mode. Section cuts operate in either deformable or section_type (planar or spherical) mode.
poISection GetDisplayOption
Gets the state of the given section display option.
poISection GetDMax
Gets the maximum plane "D" parameter for a Planar section type.
poISection GetDMin
Gets the minimum plane "D" parameter for a Planar section type.
poISection GetGridSpacingX
Gets the distance between each grid line on the local X axis for a Planar section type.
poISection GetGridSpacingY
Gets the distance between each grid line on the local Y axis for a Planar section type.
poISection GetGridTextPrecision
Gets the precision of the grid text values for a Planar section type.
poISection GetID
Gets the section ID.
poISection GetLabel
Gets the section label.
poISection GetOrientation
Gets the section's orientation plane for a Planar section type.
poISection GetOrientationMethod
Gets the section display mode, used to control polygon visibility for a Planar section type.
poISection GetRadius
Gets the clipping sphere radius for a Spherical section type.
poISection GetType
Gets the type of section.
poISection GetVisibility
Gets the section visibility state.
poISection GetWidth
Gets the width of a cross section.
poISection Reverse
Reverses the current direction of the clipping plane.
poISection SetBase
Sets the section base coordinate.
poISection SetBaseFrame
Sets the section base frame (for deformable sections only).
poISection SetBaseNode
Sets the section base coordinate.
poISection SetBaseTime
Sets the base time for a section cut.
poISection SetClipAbove
Toggles the current direction for the section.
poISection SetClipElements
Toggles the boundary element clipping state for a section.
poISection SetClipTransparency
Sets whether the clipped geometry (by iso or section cut) is displayed as transparent instead of being ignored.
poISection SetColor
Sets the section cut color.
poISection SetColorOverride
Sets the state of the color override option for a section.
poISection SetCrossSectionOnly
Sets the cross section only state.
poISection SetD
Sets the plane "D" parameter for a Planar section type.
poISection SetDeformMode
Toggles the deformable section mode.
poISection SetDIncrement
Sets the amount to increment the plane's "D" when translating the section along the normal for a Planar section type.
poISection SetDisplayOption
Sets the state of the given section display option.
poISection SetGridSpacingX
Sets the distance between each grid line on the local X axis for a Planar section type.
poISection SetGridSpacingY
Sets the distance between each grid line on the local Y axis for a Planar section type.
poISection SetGridTextPrecision
Sets the precision of the grid text values for a Planar section type.
poISection SetLabel
Sets the section label.
poISection SetOrientation
Sets the section's orientation plane for a Planar section type.
poISection SetOrientationMethod
Sets the section orientation method for a Planar section type.
poISection SetOrientationNode
Sets the section's orientation plane by model/node ID pairs for a Planar section type.
poISection SetRadius
Sets the clipping sphere radius for a Spherical section type.
poISection SetVisibility
Sets the section visibility.
poISection SetWidth
Sets the width of a cross section for a Planar section type.

(c) 2021. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support