poIImagePlane SetSyncMode

Sets the mode used to synchronize an image plane video with a model animation.

Syntax

Imageplane_handle SetSyncMode mode

Application

HyperView Tcl Modify

Description

This command automatically adjusts the image plane video scaling based on the selected mode.

Inputs

mode
Manual (Default)
No changes are made. The synch mode is automatically set to manual if the scaling is changed by the user.
Length
The scaling is adjusted so that the video and model start and stop animating at the same time.
Framerate
The scaling is adjusted so that the video and model animate at the same number of frames per second.

Example

To set the sync mode of an image plane with an index of 1 to "Length":
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 SetSyncMode Length
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid, or HW_Error if the mode is not a valid string.