poIImagePlaneCtrl GetImagePlaneID

Gets the unique ID for the image plane having the label specified.

Syntax

Imageplane_ctrl_handle GetImagePlaneID label

Application

HyperView Tcl Query

Description

This command retrieves the unique ID for the image plane with the label specified. The ID can then be used to get the image plane handle, modify its Z order when drawn, or to remove it.

Inputs

label: The label that was given to the image plane when AddImagePlane or SetLabel was called.

Example

To create four image planes, load a video into one, and then set the video to the background:

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
ipc_handle AddImagePlane Logo
ipc_handle AddImagePlane logo2
ipc_handle AddImagePlane vid1
ipc_handle AddImagePlane vid2
set ipid [ipc_handle GetImagePlaneID vid2]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName C:/samples/video.avi
imageplane_handle SetMode background
client_handle Draw
hwi CloseStack

Error

Returns HW_InvalidHandle if the image plane control handle is invalid, or PO_InvalidImageName if no image plane exists with the label specified.

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