poI3DViewCtrl GetAlignedImagePlane

Gets the ID of the image plane associated with the view.

Syntax

poI3DViewCtrl_handle GetAlignedImagePlane name

Application

HyperView Tcl Query

Description

Returns an ID of image planes. It represents the image plane associated with the view for recalculating view properties given the cropping situation. If the returned ID is 0, it indicates that this view is not associated with any image plane.

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 ID 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 GetAlignedImagePlane "View 1"
hwi CloseStack

Errors

Returns HW_InvalidHandle if the view handle is invalid.

Returns HW_InvalidArgs if the named view does not exist.