CoordinateSystem.BuildCoordinateSystem(CelestialObject, Vector) Method

Top 

Description

Uses the specified CelestialObject's Body Fixed Frame to define a custom Coordinate System, using vectorPosition to specify the offset of the origin of the Coordinate System.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Method Signature

CoordinateSystem.BuildCoordinateSystem(

CelestialObject celestialObject,


Vector vectorPosition)

 

 

Arguments

celestialObject


Description:

CelestialObject whose Body Fixed Frame defines the Coordinate System.

 

 

vectorPosition


Description:

Origin offset vector for the coordinate system.

 

 

 

Return Value

Type:

boolean

 

 

Returns a 1 if the Coordinate System was built successfully. Returns a 0 if there was an error with the build.

 

Syntax

myVariable1 = myCoordinateSystem1.BuildCoordinateSystem(myCelestialObject1, myVector1);

 

 

See also

CoordinateSystem Object

CoordinateSystem.BuildCoordinateSystem

Vectors and Coordinate Systems Guide

Orbit Reference Frames Guide

Attitude Reference Frames Guide

Matrix, Array, and Variable Math Guide