SclViewport maximise

Overview

You use this command to make one viewport take up the entire graphics workspace.

Synopsis

SclViewport maximise <$viewportHandle>

Description

Maximise the viewport referred to by the viewport handle. When a viewport is maximised, it will occupy all available space, and will overlay any other viewports that maybe present. Only one viewport can be maximised at a time.

Arguments

maximise

A literal string to identify the function.

<$viewportHandle>

The reference handle to the viewport to be maximised.

Returns

This command returns $SCL_OK.

Examples

# Maximise and restore a viewport
set vp1 [SclViewport getActive]
set vp2 [SclViewport split vertical 30 $vp1 ]
set vp3 [SclViewport split horizontal 50 $vp2 ]
puts "Click the mouse to maximise viewport 3"
SclPause
SclViewport maximise $vp3
puts "Click the mouse to restore viewport 3"
SclPause
SclViewport restore $vp3