SclViewport setActiveLayer

Overview

You use this command to select a layer as the active layer for a viewport, as identified by its reference handle.

Synopsis

SclViewport setActiveLayer <$viewportHandle> <$layerHandle>

Description

Set the active layer for the viewport referred to by the handle. The layer handle must be a valid graphics layer; otherwise an error message is displayed.

Arguments

setActiveLayer

A literal string to identify the function.

<$viewportHandle>

The reference handle to the viewport to return the active layer for.

<$layerHandle>

The reference handle to the layer to make active.

Returns

If successful, this command returns $SCL_OK. If the viewport or layer handles are not valid, an error message is returned.

Examples

# Set the active layer for the viewport
set vp [SclViewport getActive]
SclCreateSwa swaHandle "scl layer"
sclGraphicsLayers SclAdd $swaHandle $vp
SclViewport setActiveLayer $vp $swaHandle