poIImagePlaneCtrl SetZOrderList

Sets the order in which image planes are drawn when they are configured as background or foreground 2D image planes.

Syntax

Imageplane_ctrl_handle SetZOrderList"idList" type

Application

HyperView Tcl Modify

Description

Image planes have one of three modes for placement into the client window: foreground, background, or 3D. Background image planes are always drawn behind the model elements. Foreground image planes are always drawn in front of the model elements. When multiple background or foreground image planes are present, the Z order controls how overlapping image planes are drawn with respect to one another. This command defines the order in which image planes are drawn for the specified type. The specified list contains the IDs for the image planes of that type, in the order they will appear in the graphic area. An image listed at the beginning of the list will be drawn in front of image planes at the end of the Z order list.

If there are no image planes of the type specified, nothing will be returned by this command.

Inputs

idList: A list of valid image plane IDs, specified in the order they should appear on the screen. The list must be surrounded by double-quotes. All the IDs in the list must refer to valid image planes configured as 2D. The first ID in the list will be drawn front most, and the last ID in the list will be drawn bottom most.
type: The type of images to reorder. Valid values are “foreground” and “background”.

Example

The example below creates several image planes and then reorders how they are drawn (the image plane with the ID of 2 will be drawn in front, and the image plane with the ID of 1 will be drawn at the back):

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
ipc_handle SetZOrderList "2 4 3 1" background
client_handle Draw
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane control handle is invalid, or PO_InvalidImageMode if the specified type is invalid.

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