poIImagePlaneCtrl GetImagePlaneList

Gets a list of image plane IDs.

Syntax

Imageplane_ctrl_handle GetImagePlaneList

Application

HyperView Tcl Query

Description

This command retrieves the IDs of all image planes. The IDs can then be used for further queries.

Example

To create four image planes and then retrieve a list of the image plane IDs:

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 Logo]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid
imageplane_handle SetFileName C:/samples/logo.jpg
imageplane_handle SetMode background
ipc_handle AddImagePlane Logo2
ipc_handle AddImagePlane video1
ipc_handle AddImagePlane video2
set iplist [ipc_handle GetImagePlaneList]
puts "Image Plane ID List: $iplist"
client_handle Draw
hwi CloseStack

Ouput

Image Plane ID List: 1 2 3 4

Error

Returns HW_InvalidHandle if the image plane control handle is invalid.

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