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
poIImagePlaneCtrl Class
poIImagePlaneCtrl RemoveImagePlane
Removes the specified image plane.

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
      - 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
        poIImagePlaneCtrl AddImagePlane
        Adds a new image plane.
        poIImagePlaneCtrl GetImagePlaneHandle
        Gets the handle for the image plane.
        poIImagePlaneCtrl GetImagePlaneID
        Gets the unique ID for the image plane having the label specified.
        poIImagePlaneCtrl GetImagePlaneList
        Gets a list of image plane IDs.
        poIImagePlaneCtrl GetZOrderList
        Returns the order in which image planes are drawn when they are configured as background or foreground 2D image planes.
        poIImagePlaneCtrl LowerZOrder
        Alters the drawing order of a foreground or background image plane so that it is behind one (or more) other image planes.
        poIImagePlaneCtrl RaiseZOrder
        Alters the drawing order of a foreground or background image plane so that it is in front of one (or more) other image planes.
        poIImagePlaneCtrl RemoveImagePlane
        Removes the specified image plane.
        poIImagePlaneCtrl SetZOrderList
        Sets the order in which image planes are drawn when they are configured as background or foreground 2D image planes.
      - 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

poIImagePlaneCtrl RemoveImagePlane

Removes the specified image plane.

Syntax

Imageplane_ctrl_handle RemoveImagePlane id

Application

HyperView Tcl Modify

Description

This command removes the specified image plane.

Inputs

id: The unique ID of the image plane.

Example

To create four image planes and then remove one of them:

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 GetClientHandle client_handle
client_handle GetImagePlaneCtrlHandle ipc_handle
set ipid [ipc_handle AddImagePlane Logo1]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName g:/samples2/VideoOverlay/logo1.jpg
imageplane_handle SetMode background
imageplane_handle ReleaseHandle
set ipid [ipc_handle AddImagePlane Logo2]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName g:/samples2/VideoOverlay/logo2.jpg
imageplane_handle SetMode background
imageplane_handle ReleaseHandle
set ipid [ipc_handle AddImagePlane Video1]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName g:/samples2/VideoOverlay/video1.jpg
imageplane_handle SetMode background
imageplane_handle ReleaseHandle
set ipid [ipc_handle AddImagePlane Video2]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName g:/samples2/VideoOverlay/video2.jpg
imageplane_handle SetMode background
imageplane_handle ReleaseHandle
set Zlist [ipc_handle GetZOrderList background]
client_handle Draw
puts "The Z Order List is: $Zlist"
ipc_handle RemoveImagePlane 3
client_handle Draw
set Zlist [ipc_handle GetZOrderList background]
puts "The Z Order List is: $Zlist"
hwi CloseStack

Output:

The Z Order List is: 4 3 2 1

The Z Order List is: 4 2 1

Errors

Returns HW_InvalidHandle if the image plane control handle is invalid, or HW_IDNotFound if an image plane with the specified ID does not exist.

To obtain the error information, use GetError on the Session object as shown in the example.