poIImagePlane SetMode

Sets the drawing mode for the image plane.

Syntax

Imageplane_handle SetModemode

Application

HyperView Tcl Modify

Description

Image planes support three drawing modes: foreground, background, and 3D. In the foreground and background modes, the image or video is drawn as a flat rectangle, either in front of all the 3D model elements in the graphic area, or behind all the 3D model elements in the graphic area, respectively. In 3D mode, the image plane is drawn as a plane in three dimensional model space. It follows the rotation, zoom, and panning of the rest of the model, and can be also be aligned so that the camera angle of the image or video matches the 3D position of the plane relative to the FE model. This command sets/changes the mode that the image plane is in.

Inputs

mode: The new mode for the image plane.

Example

To create two image planes, and then set the mode (as well as some other basic properties) 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 PO_InvalidImageMode if the specified mode is invalid.