poIImagePlane SetVisibility

Sets the visibility setting for the image plane.

Syntax

Imageplane_handle SetVisibilitystate

Application

HyperView Tcl Modify

Description

The visibility flag indicates whether the image plane will be drawn or remain invisible. This command alters the visibility.

Inputs

state
True to make the image plane visible, False to make it invisible.

Example

To create two image planes, and then make one invisible:
hwi OpenStack
if {[catch {
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 ipid1 [ipc_handle AddImagePlane Logo1]
    ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
    imageplane_handle SetFileName g:/samples2/VideoOverlay/logo1.jpg
    imageplane_handle SetMode background
    imageplane_handle ReleaseHandle
    set ipid2 [ipc_handle AddImagePlane Video1]
    ipc_handle GetImagePlaneHandle imageplane_handle $ipid2
    imageplane_handle SetFileName g:/samples2/VideoOverlay/video1.jpg
    imageplane_handle SetMode background
    imageplane_handle ReleaseHandle
    
    ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
    imageplane_handle SetVisibility false
    client_handle Draw
} result]} {
    global errorInfo;
    puts stderr $result;
    puts "[session_handle GetError]";
    puts stderr "*** Tcl TRACE ***";
    puts stderr $errorInfo;
} else {
    puts "No errors.";
    puts "Warnings: ";
    puts "    [session_handle GetError]";
}   
    
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.