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.