Description | Example | Return Message | Group

Author

Used to create the VDF files.

Syntax

Author <ScenarioPath> {Option}

Description

The Author command will allow the user to create VDF files.

{Option}	Description
SetOptimize {On \| Off}	Toggles the optimization mode to optimize the VDF size when it is created.
SetOption "<AdvOption>" {Options}	Set the advanced options values. This command will fail if Optimization is enabled. For the following "<AdvOption>" values the valid values for {Options} are On and Off: Computed Ephemeris EOP Planetary Ephemeris Terrain Marker/Label Cloud Model Celestial Image Report/Graph Style Scenario Folder For the following "<AdvOption>" value the valid values for {Options} are Current, Search and Default: Globe
CreateViewerDataFile "<DirectoryPath>" "<FileName>" [Password <Password>] [Description "<Desc>"] [WindowID <WinNumber>]	"<DirectoryPath>" is the fully qualified directory path where the file is to be written, and "<FileName>" is the name of the VDF file to be created. Including the filename extension (.vdf) is optional. The Password, Description and WindowID parameters are optional. The Password option sets the password required for loading the Visual Data Format file. If not included the Visual Data Format File will not be password protected. Use the Description option to provide a descriptive overview of the data file. <WinNumber> is the ID of the VO window to be converted. If WindowID <WinNumber> is not entered, the first VO window is used. Note: The WindowID is relevant only for the Viewer ActiveX control.

{Option}

Description

SetOptimize {On | Off}

Toggles the optimization mode to optimize the VDF size when it is created.

SetOption "<AdvOption>" {Options}

Set the advanced options values. This command will fail if Optimization is enabled.

For the following "<AdvOption>" values the valid values for {Options} are On and Off:

Computed Ephemeris
EOP
Planetary Ephemeris
Terrain
Marker/Label
Cloud
Model
Celestial Image
Report/Graph Style
Scenario Folder

For the following "<AdvOption>" value the valid values for {Options} are Current, Search and Default:

Globe

CreateViewerDataFile "<DirectoryPath>" "<FileName>" [Password <Password>] [Description "<Desc>"] [WindowID <WinNumber>]

"<DirectoryPath>" is the fully qualified directory path where the file is to be written, and "<FileName>" is the name of the VDF file to be created. Including the filename extension (.vdf) is optional.

The Password, Description and WindowID parameters are optional.

The Password option sets the password required for loading the Visual Data Format file. If not included the Visual Data Format File will not be password protected.

Use the Description option to provide a descriptive overview of the data file.

<WinNumber> is the ID of the VO window to be converted. If WindowID <WinNumber> is not entered, the first VO window is used.

Note: The WindowID is relevant only for the Viewer ActiveX control.

Example

To Optimize the File:

Author * SetOptimize On

To use Default globe data:

Author * SetOption "Globe" Default

To use Planetray Ephemeris data:

Author * SetOption "Planetary Ephemeris" On

To Create a Visual Data Format file:

Author * CreateViewerDataFile "c:\ProgramFiles\AGIViewerFiles" "Scenario.vdf" WindowID 1

To Create a Visual Data Format file:

Author * CreateViewerDataFile "c:\ProgramFiles\AGIViewerFiles" "Scenario1.vdf" Description "This scenario contains a simple animation, with Satellite and Facility." WindowID 1

ReturnMessage

If activated, Connect returns an acknowledgment message for each Author command sent.

Group Membership

This command belongs to the following group(s):

VO Objects

Author

Version

8.1

STK Programming Interface 11.0.1