Description | Example | Return message | Group

VectorTool

Define coordinate systems and elements used in constructing them, including templates.

Syntax

VectorTool <ScenarioPath> {Options}

Related commands

Description

The VectorTool command enables you to define coordinate systems and elements used in constructing them, i.e. vectors, axes and points, as well as angles between vectors. These user-created structures and elements can then be added to those available for 3D display in the VO and/or Attitude View windows.

The VectorTool command is not valid for Chain, CommSystem, Constellation, CoverageDefinition, Star, or Scenario objects.

Valid {Options} are described here.

{Options}	Description
Compute "<ComponentSpec>"	Compute the Vector Geometry component. This command will Nack if the component is already computed or cannot be computed. To get the Compute/Clear status of a Vector Geometry component use the VectorTool_R command with the Status option. The Compute option is not valid for a template.
Clear "<ComponentSpec>"	Clear the Vector Geometry component.This command will Nack if the component is already cleared or cannot be cleared. To get the Compute/Clear status of a Vector Geometry component use the VectorTool_R command with the Status option. The Clear option is not valid for a template.
Export "<Filename>" "<ComponentSpec>"...	Export the specified components to a file. "<Filename>" is the file that will be written, it should have the extension .awb. If the file already exists it will be overwritten. "<FilePath>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information. "<ComponentSpec>" is the name of a component to be exported. This parameter can be entered multiple times on the command line. All components exported to one file must have the same parent.
Import <TruncObjectPath> "<Filename>"	Import the components from the specified "<Filename>". <TruncObjectPath> specifies the parent of the imported components. "<Filename>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information.
Rename "<ComponentSpec>" <NewName>	Rename the specified Vector Geometry component to the new name.
RenameTemplate "<TemplateSpec>" <NewName>	Rename the specified Vector Geometry template to the new name.
Duplicate "<ComponentSpec>" [<NewName>]	Duplicate the specified Vector Geometry component using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate component.
DuplicateTemplate "<TemplateSpec>" [<NewName>]	Duplicate the specified Vector Geometry template using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate template.
UserDescription "<ComponentSpec>" "<Description>"	Add a user description to the specified Vector Geometry component or template. If "<Description>" is more than 300 characters it will be truncated to 300. The user description cannot be changed on the following read-only items: To Vector, component from template, installed components and templates, and embedded components.
{Create \| Modify \| Delete}	Follow these links for details to using the VectorTool command to Create, Modify and Delete Vector Geometry components and templates. VectorTool Angle, VectorTool Axes, VectorTool Plane, VectorTool Point, VectorTool System, VectorTool Vector

For details on the format of "<ComponentSpec>" see Component Specification.

Examples

To compute an Axes:

VectorTool * Compute "CentralBody/Earth Inertial Axes"

Examples

To create a Quadrant Plane and then modify it so that it is based on the YZ quadrant of the Earth ICRF system:

VectorTool * Satellite/ScenTestSat Create Plane SatPlane2 "Quadrant"

VectorTool * Satellite/ScenTestSat Modify Plane SatPlane2 "Quadrant" YZ "CentralBody/Earth ICRF" "AxisX" "AxisY"

Examples

To create an Angle Rate Vector, modify and then delete it:

VectorTool * Facility/ScenTestFac Create Vector FacVector2 "Angle Rate"

VectorTool * Facility/ScenTestFac Modify Vector FacVector2 "Angle Rate" "CentralBody/Earth SunRA" 0.25

VectorTool * Facility/ScenTestFac Delete Vector FacVector2

Examples

To create, modify and then delete a Spinning Axes Template:

VectorTool * Satellite Create AxesTemplate SatAxesT2 "Spinning"

VectorTool * Satellite Modify AxesTemplate SatAxesT2 "Spinning" Epoch "1 Oct 1999 04:00:00.00" Rate 0.25 Offset 12.5

VectorTool * Satellite Delete AxesTemplate SatAxesT2

Examples

To export Place components to a file and then import them to Satellite2:

VectorTool * Export "C:\Users\stkUser\ExportImport\Export2.awb" "Place/Place1 PVec1 Vector" "Place/Place1 PSystem1 System"

VectorTool * Import Satellite/Satellite2 "C:\Users\stkUser\ExportImport\Export2.awb"

Examples

Rename the specified Point component to TestOName and then duplicate it, allowing STK to name the duplicated component:

VectorTool * Rename "Satellite/Satellite2 pointTen Point" TestOName

VectorTool * Duplicate "Satellite/Satellite2 TestOName Point"

Rename the specified Vector template:

VectorTool * RenameTemplate "Facility dirVec Vector" northVec

Examples

Add a user description to an Axes template:

VectorTool * UserDescription "Satellite SatAxesT2 Axes" "The axes template spinning at a rate of 0.25 revs per second."

Add a user description to a Vector component:

VectorTool * UserDescription "Satellite/Satellite2 SatVec43 Vector" "My very special vector."

Return message

Group membership

This command belongs to the following group(s):

Area Targets

Attitude

Comm

Facilities, Places & Targets

Version

11.5