poI3DViewCtrl SetAlignedImagePlane

Sets an ID of image planes to indicate that the image plane is associated with this view.

Syntax

poI3DViewCtrl_handle SetAlignedImagePlane value name

Application

HyperView Tcl Modify

Description

Set an ID of image planes to indicate that image plane is associated with this view. Information for the image plane with this ID is retrieved for recalculating view properties given the cropping situation.

Inputs

value
The image plane ID. Any existing image plane IDs are valid inputs. If it is set to 0, it indicates that this view is not associated with any image plane.
name
String specifying the name of the view to be modified. The current view will be modified if a name is not specified.

Example

To set the image plane ID of a view named "View 1" to 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 SetAlignedImagePlane "1" "View 1"
hwi CloseStack

Error

Returns HW_InvalidHandle if the view handle is invalid.

Returns HW_InvalidArgs if the values are invalid or if a named view does not exist.