vidIViewControl Translation

Syntax

hwIViewControl_handle Translation str

Application

Tcl Modify

Description

This command moves the video within the window, based upon an input string. This differs from Translate in that you input a string with a preset amount to move, rather than an input value to move.

Inputs

str

The str, or string, is an input which tells the function which direction it should move. Each string moves the video one unit in each direction stated. The different string options include: “up”, "down", "left", "right", "upleft", "upright", "downleft", and "downright".

Example

hwi GetSessionHandle sess;
sess GetProjectHandle proj;
proj GetPageHandle p1 1;
p1 GetWindowHandle w1 1;
w1 GetViewControlHandle vc;
vc Translation “downleft”;

Errors

If no string is input, an error message is displayed. If a string that is not one of the options is input, nothing will happen. Otherwise, it returns success (0) and the plot changes.

Keywords