Home
API, Reference Guides
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.
Tcl/Tk Commands
The application's 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 Altair HyperWorks applications.
HyperView
poI3DViewCtrl Class
poI3DViewCtrl GetImagePlaneWidth
Gets the width of the image plane associated with a stored view.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
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.
- Extensions
  Extensions are programs integrated with the application 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.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    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.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, 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 Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
      - Hotspot Finder API Structure
      - HyperView - MultiCore 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 GetLastRestoredView
        Gets the view name of the last restored 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
      - poIPartSet 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.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- 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 HyperWorks Help

poI3DViewCtrl GetImagePlaneWidth

Gets the width of the image plane associated with a stored view.

Syntax

poI3DViewCtrl_handle GetImagePlaneWidth name

Application

HyperView Tcl Query

Description

Returns the image plane width in term of number of pixels. This image plane is the one associated with the view. Along with height, it is used to recalculate view properties given the cropping situation.

Inputs

name: If specified, the offset of the view with that name will be returned. Otherwise, the current view’s offset will be returned.

Example

To get the image plane width of a view named "View 1":

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetViewControlHandle view_handle
view_handle GetImagePlaneWidth "View 1"
hwi CloseStack

Error

Returns HW_InvalidHandle if the view handle is invalid.

Returns HW_InvalidArgs if the named view does not exist.