SclViewport setTargetPosition

Overview

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

Synopsis

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

Description

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

Arguments

setTargetPosition

A literal string to identify the function.

<$viewportHandle>

The reference handle to the viewport of interest.

<$x>

The x position of the camera target.

<$y>

The y position of the camera target.

<$z>

The x position of the camera target.

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 target for a viewport
set vp [SclViewport getActive]
SclViewport getTargetPosition $vp xPos yPos zPos
puts "Camera target is at X=$xPos ; Y=$yPos ; Z=$zPos"
# Move the camera 100 metres right
SclViewport setTargetPosition $vp [expr $xPos + 100] $yPos $zPos
SclViewport getTargetPosition $vp xPos yPos zPos
puts "Camera target is now X=$xPos ; Y=$yPos ; Z=$zPos"