HyperWorks Desktop

2022.2

Home
HyperWorks 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.
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
poIFBDCtrl 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 Reference Guides

2022.2

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2022.2.
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
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 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.
- Extensions
  Extensions are programs integrated with HyperWorks to enhance or extend the user experience.
- 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
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
        
        poIFBDCtrl CreateCrossSection
        Creates an FBD cross section.
        
        poIFBDCtrl DeleteCrossSection
        Deletes a specified FBD cross section.
        
        poIFBDCtrl GetBinding
        Gets the output/vector binding of the current request.
        
        poIFBDCtrl GetColor
        Gets the color of a component for forces and moments.
        
        poIFBDCtrl GetCrossSectionList
        Gets a list of the available cross sections.
        
        poIFBDCtrl GetCrossSectionProperty
        Gets the cross section property.
        
        poIFBDCtrl GetCrossSectionPropertyList
        Gets a list of the available cross section properties.
        
        poIFBDCtrl GetCurrentCrossSectionList
        Gets the currently selected cross section.
        
        poIFBDCtrl GetCurrentCSValueList
        Gets the values for the currently selected cross section.
        
        poIFBDCtrl GetDrawPosition
        Gets the draw position of an FBD vector.
        
        poIFBDCtrl GetDrawPositionList
        Gets a list of the available FBD vector draw positions.
        
        poIFBDCtrl GetDrawValues
        Gets the draw values for an FBD vector.
        
        poIFBDCtrl GetElemSelectionSetHandle
        Gets the element selection handle for a cross section.
        
        poIFBDCtrl GetEnableState
        Gets the state of the FBD controller.
        
        poIFBDCtrl GetIgnoreNodeSet
        Returns whether or not the node selection has been ignored.
        
        poIFBDCtrl GetLoadType
        Gets the current load type.
        
        poIFBDCtrl GetNodeSelectionSetHandle
        Gets the node selection handle for a cross section.
        
        poIFBDCtrl GetNumericFormat
        Gets the numeric format.
        
        poIFBDCtrl GetNumericFormatList
        Gets the numeric format list.
        
        poIFBDCtrl GetPrecision
        Gets the precision value.
        
        poIFBDCtrl GetReaderType
        Gets the current reader type/name.
        
        poIFBDCtrl GetScale
        Gets the scale/floating point number.
        
        poIFBDCtrl GetShowPrefix
        Gets the state of show prefix.
        
        poIFBDCtrl GetSumPointSize
        Gets the size of the sphere for the resultant coordinate location.
        
        poIFBDCtrl GetSumPointType
        Gets the summation point type.
        
        poIFBDCtrl GetTableMode
        Gets the current table mode.
        
        poIFBDCtrl GetTolerance
        Gets the tolerance value for the controller.
        
        poIFBDCtrl GetVectorDisplayMode
        Gets the current display mode.
        
        poIFBDCtrl GetVectorDisplayModeList
        Gets the display mode list.
        
        poIFBDCtrl GetVectorHeadType
        Gets the vector head type.
        
        poIFBDCtrl GetVectorHeadTypeList
        Gets a list of the available vector head types.
        
        poIFBDCtrl GetVectorResultType
        Gets the current vector type.
        
        poIFBDCtrl IsCrossSectionValid
        Checks to see if the cross section is valid.
        
        poIFBDCtrl IsValid
        Checks to see if the FBD controller is valid.
        
        poIFBDCtrl SetColor
        Sets the color of force and moment components.
        
        poIFBDCtrl SetCrossSectionProperty
        Sets the cross section properties.
        
        poIFBDCtrl SetCurrentCrossSectionList
        Sets the cross sections which need to be evaluated to current.
        
        poIFBDCtrl SetDrawPosition
        Sets the draw position for an FBD vector.
        
        poIFBDCtrl SetDrawValues
        Sets the draw values for an FBD vector.
        
        poIFBDCtrl SetEnableState
        Sets the auto load/unload FBD vector data state.
        
        poIFBDCtrl SetIgnoreNodeSet
        Sets whether or not the node selection should be ignored.
        
        poIFBDCtrl SetLoadType
        Sets the current load type.
        
        poIFBDCtrl SetNumericFormat
        Sets the numeric format.
        
        poIFBDCtrl SetPrecision
        Sets the precision value.
        
        poIFBDCtrl SetScale
        Sets the scale value used to display vectors.
        
        poIFBDCtrl SetScaleMode
        Sets the scale mode used to display vectors.
        
        poIFBDCtrl SetShowPrefix
        Sets the state of show prefix.
        
        poIFBDCtrl SetSumPointSize
        Sets the size of the sphere for the resultant coordinate location.
        
        poIFBDCtrl SetTableMode
        Sets the table mode.
        
        poIFBDCtrl SetTolerance
        Sets the tolerance value for the controller.
        
        poIFBDCtrl SetVectorDisplayMode
        Sets the vector control display mode.
        
        poIFBDCtrl SetVectorHeadType
        Sets the vector head type for both Force and Moments.
        
        poIFBDCtrl SetVectorResultType
        Sets the current vector type.
      - 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
      - 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
    - Postquery Commands
    - Context Commands
    - Framework Commands
- 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 and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

View All Altair Simulation Help

HyperWorks Desktop

2022.2

Home
HyperWorks 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.
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
poIFBDCtrl 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 Reference Guides

poIFBDCtrl Class

Note: See the Free Body Diagrams (FBD) topic in the HyperView User's Guide for additional information.

poIFBDCtrl CreateCrossSection
Creates an FBD cross section.
poIFBDCtrl DeleteCrossSection
Deletes a specified FBD cross section.
poIFBDCtrl GetBinding
Gets the output/vector binding of the current request.
poIFBDCtrl GetColor
Gets the color of a component for forces and moments.
poIFBDCtrl GetCrossSectionList
Gets a list of the available cross sections.
poIFBDCtrl GetCrossSectionProperty
Gets the cross section property.
poIFBDCtrl GetCrossSectionPropertyList
Gets a list of the available cross section properties.
poIFBDCtrl GetCurrentCrossSectionList
Gets the currently selected cross section.
poIFBDCtrl GetCurrentCSValueList
Gets the values for the currently selected cross section.
poIFBDCtrl GetDrawPosition
Gets the draw position of an FBD vector.
poIFBDCtrl GetDrawPositionList
Gets a list of the available FBD vector draw positions.
poIFBDCtrl GetDrawValues
Gets the draw values for an FBD vector.
poIFBDCtrl GetElemSelectionSetHandle
Gets the element selection handle for a cross section.
poIFBDCtrl GetEnableState
Gets the state of the FBD controller.
poIFBDCtrl GetIgnoreNodeSet
Returns whether or not the node selection has been ignored.
poIFBDCtrl GetLoadType
Gets the current load type.
poIFBDCtrl GetNodeSelectionSetHandle
Gets the node selection handle for a cross section.
poIFBDCtrl GetNumericFormat
Gets the numeric format.
poIFBDCtrl GetNumericFormatList
Gets the numeric format list.
poIFBDCtrl GetPrecision
Gets the precision value.
poIFBDCtrl GetReaderType
Gets the current reader type/name.
poIFBDCtrl GetScale
Gets the scale/floating point number.
poIFBDCtrl GetShowPrefix
Gets the state of show prefix.
poIFBDCtrl GetSumPointSize
Gets the size of the sphere for the resultant coordinate location.
poIFBDCtrl GetSumPointType
Gets the summation point type.
poIFBDCtrl GetTableMode
Gets the current table mode.
poIFBDCtrl GetTolerance
Gets the tolerance value for the controller.
poIFBDCtrl GetVectorDisplayMode
Gets the current display mode.
poIFBDCtrl GetVectorDisplayModeList
Gets the display mode list.
poIFBDCtrl GetVectorHeadType
Gets the vector head type.
poIFBDCtrl GetVectorHeadTypeList
Gets a list of the available vector head types.
poIFBDCtrl GetVectorResultType
Gets the current vector type.
poIFBDCtrl IsCrossSectionValid
Checks to see if the cross section is valid.
poIFBDCtrl IsValid
Checks to see if the FBD controller is valid.
poIFBDCtrl SetColor
Sets the color of force and moment components.
poIFBDCtrl SetCrossSectionProperty
Sets the cross section properties.
poIFBDCtrl SetCurrentCrossSectionList
Sets the cross sections which need to be evaluated to current.
poIFBDCtrl SetDrawPosition
Sets the draw position for an FBD vector.
poIFBDCtrl SetDrawValues
Sets the draw values for an FBD vector.
poIFBDCtrl SetEnableState
Sets the auto load/unload FBD vector data state.
poIFBDCtrl SetIgnoreNodeSet
Sets whether or not the node selection should be ignored.
poIFBDCtrl SetLoadType
Sets the current load type.
poIFBDCtrl SetNumericFormat
Sets the numeric format.
poIFBDCtrl SetPrecision
Sets the precision value.
poIFBDCtrl SetScale
Sets the scale value used to display vectors.
poIFBDCtrl SetScaleMode
Sets the scale mode used to display vectors.
poIFBDCtrl SetShowPrefix
Sets the state of show prefix.
poIFBDCtrl SetSumPointSize
Sets the size of the sphere for the resultant coordinate location.
poIFBDCtrl SetTableMode
Sets the table mode.
poIFBDCtrl SetTolerance
Sets the tolerance value for the controller.
poIFBDCtrl SetVectorDisplayMode
Sets the vector control display mode.
poIFBDCtrl SetVectorHeadType
Sets the vector head type for both Force and Moments.
poIFBDCtrl SetVectorResultType
Sets the current vector type.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent