Description | Example | Return Message | Group

SpatialTool

Define volumes and elements used in constructing them, including templates.

Syntax

SpatialTool <ScenarioPath> {Options}

Related Commands

Description

The SpatialTool 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.

Note: The SpatialTool command is not valid for Scenario, Chain, Constellation, or Star objects.

Valid {Options} are described here.

{Options}	Description
Compute "<ComponentSpec>"	Compute the Spatial component. This command will Nack if the component is already computed or cannot be computed. To get the Compute/Clear status of a Spatial component use the SpatialTool_R command with the Status option. The Compute option is not valid for a template.
Clear "<ComponentSpec>"	Clear the Spatial component.This command will Nack if the component is already cleared or cannot be cleared. To get the Compute/Clear status of a Spatial component use the SpatialTool_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. "<ComponentSpec>" is the name of a component to be exported. This parameter can be entered multiple times on the command line. Note: 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.
Rename "<ComponentSpec>" <NewName>	Rename the specified Spatial component to the new name.
RenameTemplate "<TemplateSpec>" <NewName>	Rename the specified Spatial template to the new name.
Duplicate "<ComponentSpec>" [<NewName>]	Duplicate the specified Spatial 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 Spatial template using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate template.
{Create \| Modify \| Delete}	Follow these links for details to using the SpatialTool command to Create, Modify and Delete Spatial components and templates. SpatialTool Spatial Calculation SpatialTool Spatial Condition SpatialTool Volume Grid

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

Example

To compute a Volume Grid:

SpatialTool * Compute "Satellite/ScenTestSat SatGrid4 Volume Grid"

Example

To create an Angle Off Reference Spatial Calculation and then modify it:

SpatialTool * Satellite/ScenTestSat Create "Spatial Calculation" SatSCalc1 "Angle Off Reference"

SpatialTool * Satellite/ScenTestSat Modify "Spatial Calculation" SatSCalc1 "Angle Off Reference" Angle AboutVectorSigned AboutVector "Satellite/ScenTestSat Moon Vector"