poIImagePlane GetSyncBlockID
Gets the unique animation sync block for the image plane.
Syntax
Imageplane_handle GetSyncBlockID
Application
HyperView Tcl Query
Description
Unique animation sync block IDs are used by HyperView to identify each source of animated frames. Though not directly visible to the end user, sync block IDs are used by the “Time Scales” panel to synchronize multiple windows or videos. This command returns the unique sync block ID associated with the image plane.
Example
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
set ipid1 [ipc_handle AddImagePlane Logo1]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
imageplane_handle SetFileName g:/samples2/VideoOverlay/logo1.jpg
imageplane_handle SetMode background
imageplane_handle ReleaseHandle
set ipid2 [ipc_handle AddImagePlane Video1]
ipc_handle GetImagePlaneHandle imageplane_handle $ipid2
imageplane_handle SetFileName g:/samples2/VideoOverlay/video1.jpg
imageplane_handle SetMode background
imageplane_handle ReleaseHandle
puts "ImagePlane Basic Properties :";
ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
puts " ID = [imageplane_handle GetID]";
puts " Filename = [imageplane_handle GetFileName]";
puts " Label = [imageplane_handle GetLabel]";
puts " Syncblock ID = [imageplane_handle GetSyncBlockID]";
puts " Visibility = [imageplane_handle GetVisibility]";
puts " Alpha = [imageplane_handle GetAlpha]";
puts " Mode = [imageplane_handle GetMode]";
puts " Associated Model ID = [imageplane_handle GetAssociatedModelID]";
puts " Cull Angle = [imageplane_handle GetCullAngle]";
puts " Backface Visibility = [imageplane_handle GetBackFaceVisibility]";
puts " Crop = [imageplane_handle GetCrop]";
puts " Stretch = [imageplane_handle GetStretchToFit]";
puts " Maintain Aspect = [imageplane_handle GetMaintainAspectRatio]";
hwi CloseStack
Console Output:
ImagePlane Basic Properties :
ID = 1
Filename = g:/samples2/VideoOverlay/logo1.jpg
Label = Logo1
Syncblock ID = W1:V1
Visibility = true
Alpha = 100
Mode = Background
Associated Model ID = -1
Cull Angle = 20
Backface Visibility = false
Crop = 0.00, 0.00, 1.00, 1.00
Stretch = false
Maintain Aspect = true
Errors
None.