Description | Example | Return Message | Group

VO SnapFrame

Take a picture of the current 3D window and save it

Syntax

VO <ScenarioPath> SnapFrame {SnapOption} [<Parameters>] [<WinNumber>]

Description

The VO SnapFrame command allows you to take a snapshot of the current 3D window and save it to a file or to the clipboard.

{SnapOptions} and <Parameters> can be:

{SnapOption} <Parameters>
ToFile "<FilePath>"
ToClipboard N/A
SetValues {SetOption} <SetParams>

{SetOption} and <SetParams> are described in the next Table

If {SnapOption} is SetValues, then {SetOption} and <SetParams> can be:

{SetOption} <SetParams>
Format {BMP | JPEG | TIF | RAS | RGB}

RGB is only available on UNIX SGI platforms.

AntiAlias {On | Off} [{2 | 3 | 4}]

If On is entered then also enter the anti-alias strength value, 2, 3 or 4.

Resolution {High | Normal} [<DPI> <Width>]

<Width> is entered in inches. If High is entered, you must also specify <DPI> and <Width>.

Example

To snap a picture and save it in TIF format:

VO * SnapFrame SetValues Format tif

To save the previously snapped frame as VOMoonShot.tif:

VO * SnapFrame ToFile "C:\stk\User\stkData\vosnaps\VOMoonshot.tif":

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Attitude

VO

VO Objects

Version

4.2

STK Programming Interface 11.0.1