poI3DViewCtrl GetMultiPointAligned

Gets the status if the view is created from an image plane alignment operation.

Syntax

poI3DViewCtrl_handle GetMultiPointAligned name

Application

HyperView Tcl Query

Description

Returns true if the view is created from an image plane alignment operation, and false otherwise. This status is useful to determine whether the image plane ID of the view can be changed. If the return value is true, the view is associated with this image plane in life time.

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 find out if a view named “View 1” is created from an image plane alignment operation:
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

Error

Returns HW_InvalidHandle if the view handle is invalid.

Returns HW_InvalidArgs if the named view does not exist.