poI3DViewCtrl GetImagePlaneHeight

Gets the height of the image plane associated with a stored view.

Syntax

poI3DViewCtrl_handle GetImagePlaneHeight name

Application

HyperView Tcl Query

Description

Returns the image plane height in term of number of pixels. This image plane is the one associated with the view. Along with width, it is used to recalculate view properties given the cropping situation.

Inputs

name: If specified, the offset of the view with that name will be returned. Otherwise, the current view’s offset will be returned.

Example

To get the image plane height of a view named "View 1":

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 GetViewControlHandle view_handle
view_handle GetImagePlaneHeight "View 1"
hwi CloseStack

Errors

Returns HW_InvalidHandle if the view handle is invalid.

Returns HW_InvalidArgs if the named view does not exist.