SclViewport setCameraPosition

Overview

You use this command to specify the x, y, and z coordinates of the camera for the viewport.

Synopsis

SclViewport setCameraPosition <$viewportHandle> <$x> <$y> <$z>

Description

Set the position of the camera for the viewport referred to by the handle. The camera values in each direction are specified by the parameters x, y, and z.

Arguments

setCameraPosition

A literal string to identify the function.

<$viewportHandle>

The reference handle to the viewport you want to set the camera position for.

<$x>

The x position of the camera.

<$y>

The y position of the camera.

<$z>

The x position of the camera.

Returns

If successful, this command returns $SCL_OK. If the viewport handle is not valid, an error message is returned.

Examples

# Get and set the camera position for a viewport
set vp [SclViewport getActive]
SclViewport getCameraPosition $vp xPos yPos zPos
puts "Camera target is at X=$xPos ; Y=$yPos ; Z=$zPos"
# Move the camera 100 metres right
SclViewport setCameraPosition $vp [expr $xPos + 100] $yPos $zPos
SclViewport getCameraPosition $vp xPos yPos zPos
puts "Camera position is now X=$xPos ; Y=$yPos ; Z=$zPos"