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. You can then add these user-created structures and elements to those available for 3D display in the 3D Graphics window and Attitude View window.
The SpatialTool command is not valid for Chain, CommSystem, Constellation, CoverageDefinition, Star, or Scenario objects.
Valid {Options} are described here.
| {Options} | Description |
|---|---|
| Compute "<ComponentSpec>" | This directs STK to 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>" | This clears 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>"... | This exports 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>" is the path to a file on your local drive. "<ComponentSpec>" is the name of a component to be exported. You can enter this parameter two or more times on the command line. All components exported to one file must have the same parent. |
| Import <TruncObjectPath> "<Filename>" | This imports the components from the specified "<Filename>". <TruncObjectPath> specifies the parent of the imported components. "<Filename>" is the path to a file on your local drive. |
| Rename "<ComponentSpec>" <NewName> | This renames the specified Spatial component to the new name. |
| RenameTemplate "<TemplateSpec>" <NewName> | This renames the specified Spatial template to the new name. |
| Duplicate "<ComponentSpec>" [<NewName>] | This duplicates the specified Spatial component using the <NewName>, if entered. If you do not enter <NewName>, 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 you do not enter <NewName>, then STK will create a unique name for the duplicate template. |
| UserDescription "<ComponentSpec>" "<Description>" | This adds a user description to the specified Spatial component or template.
If "<Description>" is more than 300 characters, it will be truncated to 300. You cannot change the user description on the following read-only items: component from template, installed components and templates, and embedded components. |
| {Create | Modify | Delete} | Follow these links for details to using the SpatialTool command to create, modify and delete Spatial components and templates. SpatialTool Spatial CalculationSpatialTool Spatial ConditionSpatialTool Volume Grid |
For details on the format of "<ComponentSpec>" see Component Specification.
Examples
To compute a Volume Grid:
Examples
To create an Angle Off Reference Spatial Calculation and then modify it:
Examples
To create an Spatial Calculation Bounds component and then delete it:
Examples
Rename the specified Spatial Calculation component to SatCalc2 and then duplicate it, allowing STK to name the duplicated component:
Rename the specified Spatial Condition template:
Examples
Add a user description to a Spatial Condition template:
Add a user description to a Spatial Calculation component:
Return message
Group membership
This command belongs to the following group(s):
Version
12.10