Description | Example | Return message | Group

VO SnapFrame

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

Syntax

VO <ScenarioPath> SnapFrame {SnapOption} [<Parameters>] [WindowID <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.

The optional WindowID <WinNumber> can be included at the end of any command to specify a 3D Graphics window number or All. If All is specified then Connect applies the command to All applicable 3D Graphics windows. If no WindowID <WinNumber> is specified, Connect applies the command to the first 3D Graphics windows.

{SnapOptions} and <Parameters> can be:

{SnapOption}<Parameters>
ToFile"<FilePath>"
ToClipboardN/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 | PNG | TIF}

RGB is only available on UNIX SGI platforms.

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

If On is entered then also enter the anti-alias strength value, 2, 3 or 4, or enter FXAA to use the Fast Approximate Anti-aliasing (FXAA) algorithm.

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

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

Examples

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"

To turn on anti-aliasing using the FXAA algorithm:

VO * SnapFrame SetValues AntiAlias On FXAA

Return message

Group membership

This command belongs to the following group(s):

Attitude

VO

VO Objects

Version

11.4