SclViewport setActive

Overview

You use this command to make a viewport active, identifying it by its reference handle.

Synopsis

SclViewport setActive <$viewportHandle>

Description

Sets the viewport, referred to by the handle, as the active viewport in the system. The handle must be a valid viewport handle; otherwise an error message is displayed.

Arguments

setActive

A literal string to identify the function.

<$viewportHandle>

The reference handle to the viewport to be made active.

Returns

If successful, this command returns a reference handle to the active viewport. If the handle to the viewport is not valid, an error message is returned.

Examples

# Make a viewport active
set vp1 [SclViewport getActive]
set vp2 [SclViewport split vertical 30 $vp1 ]
set vp3 [SclViewport split horizontal 50 $vp2 ]
SclViewport setActive $vp2