HyperWorks Desktop

2021.2

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
poI3DViewCtrl 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.2

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.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 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.
- Extensions
  Extensions are programs integrated with HyperWorks to enhance or extend the user experience.
- 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
        
        poI3DViewCtrl Fit
        Fits the model(s) in the current window so that all of the model(s) is visible.
        
        poI3DViewCtrl FitAllFrames
        Fits the model(s) in the current window so that all of the model(s) is visible through all time steps.
        
        poI3DViewCtrl GetActiveView
        Gets the name of the current view marked as active.
        
        poI3DViewCtrl GetAlignedImagePlane
        Gets the ID of the image plane associated with the view.
        
        poI3DViewCtrl GetCropping
        Gets the number of pixels cropped from each side of the image plane associated with the view.
        
        poI3DViewCtrl GetCurrentViewString
        Gets the string name of the current view.
        
        poI3DViewCtrl GetFocalLength
        Gets the focal length of the current or specified view.
        
        poI3DViewCtrl GetImagePlaneHeight
        Gets the height of the image plane associated with a stored view.
        
        poI3DViewCtrl GetImagePlaneWidth
        Gets the width of the image plane associated with a stored view.
        
        poI3DViewCtrl GetInputPrincipalPointOffset
        Gets the input principal point offset of a stored view.
        
        poI3DViewCtrl GetInputSensorHeight
        Gets the input sensor height of a stored view.
        
        poI3DViewCtrl GetLookAt
        Gets nine points which represent the lookat matrix.
        
        poI3DViewCtrl GetMultiPointAligned
        Gets the status if the view is created from an image plane alignment operation.
        
        poI3DViewCtrl GetOrientation
        Returns the orientation of the model within the view.
        
        poI3DViewCtrl GetOrtho
        Returns the parameters describing the current view in the orthographic projection mode.
        
        poI3DViewCtrl GetPerspectiveAngle
        Gets the perspective angle of a stored view.
        
        poI3DViewCtrl GetPerspectiveMode
        Turns the perspective mode on or off.
        
        poI3DViewCtrl GetPrincipalPointOffset
        Gets the principal point offset of a stored view.
        
        poI3DViewCtrl GetProjectionType
        Gets the type of projection used by a stored view.
        
        poI3DViewCtrl GetSensorHeight
        Gets the sensor height of a stored view.
        
        poI3DViewCtrl GetUpOrientationMethod
        Gets the orientation method of the camera top position.
        
        poI3DViewCtrl GetUpOrientationVector
        Gets the orientation vector of the camera top position.
        
        poI3DViewCtrl GetViewList
        Gets a list of all memorized views for the current window.
        
        poI3DViewCtrl GetViewMatrix
        Gets a 4x4 view matrix orientation of the active window.
        
        poI3DViewCtrl GetWithMasking
        Gets the "With Masking" state of a stored view.
        
        poI3DViewCtrl GetZOffset
        Gets the z offset of a stored view.
        
        poI3DViewCtrl RemoveView
        Removes a view from the list of memorized views.
        
        poI3DViewCtrl RenameView
        Renames an existing memory view with a new name.
        
        poI3DViewCtrl RestoreView
        Restores the current view parameters with the memorized view name.
        
        poI3DViewCtrl RotateX
        Rotates the contents of the current window about the X axis.
        
        poI3DViewCtrl RotateY
        Rotates the contents of the current window about the Y axis.
        
        poI3DViewCtrl RotateZ
        Rotates the contents of the current window about the Z axis.
        
        poI3DViewCtrl SaveView
        Captures the current view parameters and saves it to a memory view with the given name.
        
        poI3DViewCtrl SetActiveView
        Sets a view as active or not active.
        
        poI3DViewCtrl SetAlignedImagePlane
        Sets an ID of image planes to indicate that the image plane is associated with this view.
        
        poI3DViewCtrl SetCropping
        Sets the number of pixels cropped from each side of the image plane associated with the view.
        
        poI3DViewCtrl SetFocalLength
        Sets the focal length of the current of specified view.
        
        poI3DViewCtrl SetInputPrincipalPointOffset
        Sets the input principal point offset of a stored view.
        
        poI3DViewCtrl SetInputSensorHeight
        Sets the input sensor height of a stored view.
        
        poI3DViewCtrl SetLookAt
        Sets the view matrix using nine points.
        
        poI3DViewCtrl SetOrientation
        Sets the orientation of the model within the view.
        
        poI3DViewCtrl SetOrtho
        Changes the current view when in the orthographic projection mode.
        
        poI3DViewCtrl SetPerspectiveAngle
        Sets the perspective angle of a stored view.
        
        poI3DViewCtrl SetPerspectiveMode
        Turns the perspective mode on or off.
        
        poI3DViewCtrl SetPrincipalPointOffset
        Sets the principal point offset of a stored view.
        
        poI3DViewCtrl SetProjectionType
        Sets the type of projection used by a view entity.
        
        poI3DViewCtrl SetSensorHeight
        Sets the sensor height of a stored view.
        
        poI3DViewCtrl SetUpOrientationMethod
        Sets the orientation method of the camera top position.
        
        poI3DViewCtrl SetUpOrientationVector
        Gets the orientation vector of the camera top position.
        
        poI3DViewCtrl SetViewMatrix
        Sets a 4x4 view matrix orientation for the active window.
        
        poI3DViewCtrl SetWithMasking
        Sets the "With Masking" state of a stored view.
        
        poI3DViewCtrl SetZOffset
        Sets the z offset of a stored view.
        
        poI3DViewCtrl Translate
        Translates the contents of the current window to the given position.
        
        poI3DViewCtrl Zoom
        Zooms by the given factor.
        
        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
        
        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
  - 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

2021.2

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
poI3DViewCtrl 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

poI3DViewCtrl Class

Note: See Entity Editor - Views in the HyperView User's Guide for additional information.

poI3DViewCtrl Fit
Fits the model(s) in the current window so that all of the model(s) is visible.
poI3DViewCtrl FitAllFrames
Fits the model(s) in the current window so that all of the model(s) is visible through all time steps.
poI3DViewCtrl GetActiveView
Gets the name of the current view marked as active.
poI3DViewCtrl GetAlignedImagePlane
Gets the ID of the image plane associated with the view.
poI3DViewCtrl GetCropping
Gets the number of pixels cropped from each side of the image plane associated with the view.
poI3DViewCtrl GetCurrentViewString
Gets the string name of the current view.
poI3DViewCtrl GetFocalLength
Gets the focal length of the current or specified view.
poI3DViewCtrl GetImagePlaneHeight
Gets the height of the image plane associated with a stored view.
poI3DViewCtrl GetImagePlaneWidth
Gets the width of the image plane associated with a stored view.
poI3DViewCtrl GetInputPrincipalPointOffset
Gets the input principal point offset of a stored view.
poI3DViewCtrl GetInputSensorHeight
Gets the input sensor height of a stored view.
poI3DViewCtrl GetLookAt
Gets nine points which represent the lookat matrix.
poI3DViewCtrl GetMultiPointAligned
Gets the status if the view is created from an image plane alignment operation.
poI3DViewCtrl GetOrientation
Returns the orientation of the model within the view.
poI3DViewCtrl GetOrtho
Returns the parameters describing the current view in the orthographic projection mode.
poI3DViewCtrl GetPerspectiveAngle
Gets the perspective angle of a stored view.
poI3DViewCtrl GetPerspectiveMode
Turns the perspective mode on or off.
poI3DViewCtrl GetPrincipalPointOffset
Gets the principal point offset of a stored view.
poI3DViewCtrl GetProjectionType
Gets the type of projection used by a stored view.
poI3DViewCtrl GetSensorHeight
Gets the sensor height of a stored view.
poI3DViewCtrl GetUpOrientationMethod
Gets the orientation method of the camera top position.
poI3DViewCtrl GetUpOrientationVector
Gets the orientation vector of the camera top position.
poI3DViewCtrl GetViewList
Gets a list of all memorized views for the current window.
poI3DViewCtrl GetViewMatrix
Gets a 4x4 view matrix orientation of the active window.
poI3DViewCtrl GetWithMasking
Gets the "With Masking" state of a stored view.
poI3DViewCtrl GetZOffset
Gets the z offset of a stored view.
poI3DViewCtrl RemoveView
Removes a view from the list of memorized views.
poI3DViewCtrl RenameView
Renames an existing memory view with a new name.
poI3DViewCtrl RestoreView
Restores the current view parameters with the memorized view name.
poI3DViewCtrl RotateX
Rotates the contents of the current window about the X axis.
poI3DViewCtrl RotateY
Rotates the contents of the current window about the Y axis.
poI3DViewCtrl RotateZ
Rotates the contents of the current window about the Z axis.
poI3DViewCtrl SaveView
Captures the current view parameters and saves it to a memory view with the given name.
poI3DViewCtrl SetActiveView
Sets a view as active or not active.
poI3DViewCtrl SetAlignedImagePlane
Sets an ID of image planes to indicate that the image plane is associated with this view.
poI3DViewCtrl SetCropping
Sets the number of pixels cropped from each side of the image plane associated with the view.
poI3DViewCtrl SetFocalLength
Sets the focal length of the current of specified view.
poI3DViewCtrl SetInputPrincipalPointOffset
Sets the input principal point offset of a stored view.
poI3DViewCtrl SetInputSensorHeight
Sets the input sensor height of a stored view.
poI3DViewCtrl SetLookAt
Sets the view matrix using nine points.
poI3DViewCtrl SetOrientation
Sets the orientation of the model within the view.
poI3DViewCtrl SetOrtho
Changes the current view when in the orthographic projection mode.
poI3DViewCtrl SetPerspectiveAngle
Sets the perspective angle of a stored view.
poI3DViewCtrl SetPerspectiveMode
Turns the perspective mode on or off.
poI3DViewCtrl SetPrincipalPointOffset
Sets the principal point offset of a stored view.
poI3DViewCtrl SetProjectionType
Sets the type of projection used by a view entity.
poI3DViewCtrl SetSensorHeight
Sets the sensor height of a stored view.
poI3DViewCtrl SetUpOrientationMethod
Sets the orientation method of the camera top position.
poI3DViewCtrl SetUpOrientationVector
Gets the orientation vector of the camera top position.
poI3DViewCtrl SetViewMatrix
Sets a 4x4 view matrix orientation for the active window.
poI3DViewCtrl SetWithMasking
Sets the "With Masking" state of a stored view.
poI3DViewCtrl SetZOffset
Sets the z offset of a stored view.
poI3DViewCtrl Translate
Translates the contents of the current window to the given position.
poI3DViewCtrl Zoom
Zooms by the given factor.

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

Intellectual Property Rights Notice | Technical Support