poIImagePlane SetFit

Sets a 2D image plane to fit its window in the graphics area.

Syntax

Imageplane_handle SetFit val

Application

HyperView Tcl Modify

Description

This command sets the Fit display option of a 2D image plane. “Fit” means the image plane is resized to fill its window in the graphics area while its aspect ratio is reserved and the entire image plane is within the window.

Inputs

val: A Boolean value to determine if the Fit display option is applied to the 2D image plane. True indicates that Fit is applied. False indicates that Fit is unchecked.

Example

To set Fit for a 2D image plane:

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 GetImagePlaneHandle image_plane_handle 1 
image_plane_handle SetFileName "some file"
image_plane_handle SetFit true
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.