poIImagePlane SetFileName

Sets the file name of the image or video associated with the image plane.

Syntax

Imageplane_handle SetFileNamefilename

Application

HyperView Tcl Modify

Description

Each image plane is associated with a image or video file. This command sets/specifies a new image or video that HyperView will open, process, and associate with the image plane.

Inputs

filename
Specifies the complete path to the new media file to open.

Example

To create two image planes, and then set the file name for one of them:
hwi OpenStack
if {[catch {
    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

    ipc_handle GetImagePlaneHandle imageplane_handle $ipid1
    imageplane_handle SetLabel "Company Logo";
    imageplane_handle SetAlpha 80
    imageplane_handle SetMode foreground
    imageplane_handle SetAssociatedModelID 1
    imageplane_handle SetCullAngle 45
    imageplane_handle SetBackFaceVisibility true
    imageplane_handle SetCrop 0.2 0.2 0.8 0.8
    imageplane_handle SetStretchToFit false
    imageplane_handle SetMaintainAspectRatio false
    client_handle Draw
} result]} {
    global errorInfo;
    puts stderr $result;
    puts "[session_handle GetError]";
    puts stderr "*** Tcl TRACE ***";
    puts stderr $errorInfo;
} else {
    puts "No errors.";
    puts "Warnings: ";
    puts "    [session_handle GetError]";
}

hwi CloseStack

Errors

Returns HW_InvalidHandle if the image plane handle is invalid, or HW_Error if an unexpected error occurred while processing the specified media file.