poIImagePlane GetSyncMode

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

Syntax

Imageplane_handle GetSyncMode

Application

HyperView Tcl Query

Description

This command returns the sync mode currently applied to the image plane:
Manual (default)
No current synchronization or user has modified the synchronization.
Length
The video and model start and stop animating at the same time.
Framerate
The video and model animate at the same number of frames per second.

Example

To get the sync mode of an image plane with an index of 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 GetClientHandle client_handle
client_handle GetImagePlaneCtrlHandle ipc_handle
ipc_handle GetImagePlaneHandle image_plane_handle 1
image_plane_handle GetSyncMode
hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid.