Description
Vectors can be displayed in 2D and 3D visualizations, easily determine the magnitude and direction to a specified target, and calculate intersections with Proximity Zones or define custom coordinate systems. See the Vectors and Coordinate Systems Guide for more information.
Inheritance Hierarchy: ObjectàVector
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
Active
|
Specifies whether or not to evaluate methods of the vector and draw it in the MissionView.
|
Alpha
|
Right ascension of the Vector in spherical coordinates. Used with Vector.Delta and Vector.Magnitude.
|
Color
|
The color to draw the vector. The color can be overridden for an individual view using the ViewWindow.SetObjectColor() method.
|
DeclaredName
|
The name of the object as declared.
|
Delta
|
Declination of the Vector in spherical coordinates measured in the x-y plane. Used with Vector.Alpha and Vector.Magnitude.
|
DrawMethod
|
Method in which to draw the vector
|
Element
|
The x, y, z components of the vector.
|
Epoch
|
For Vector objects built on vectors which are relative to the position of bodies that move in space over time, the Epoch property indicates the time at which the Vector is defined or re-evaluated.
To model a Vector that rotates in time, the Vector object should be updated any time the spacecraft state is updated. Therefore, the user should add a line Inside the control loop of the script to synchronize the coordinate system (in time) with the spacecraft, such asVector1.Epoch = Spacecraft1.Epoch;
The Epoch property can also be set to a time in GSFC MJD Format
|
ExistingXAxisCoordinateSystem
|
Specifies the coordinate system to use when the VectorType is 'Existing X-Axis'.
|
LabelLocation
|
Determines where the vector label is drawn when the DrawMethod is arrow and the vector is visualized in a Mission View.
|
Magnitude
|
Vector magnitude used with spherical coordinates. Used with Vector.Alpha and Vector.Delta.
|
MagnitudeScaleFactor
|
Scale factor applied to the magnitude of the vector for visualization.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
ReferenceAxis
|
Specifies the body axis to use for VectorType = 4(Body Axis).
|
VectorType
|
The type of vector.
|
VisualOffset
|
Positional offset of the origin of the vector for Visualization. The offset origin is measured from the MJ2000 Earth Equator reference frame.
|
|
Name
|
Description
|
BuildVector
|
Uses the specified input arguments to set the origin and pointing information for the Vector object. Returns a Variable that informs the user whether the Vector was built successfully.
|
ClearSavedStates
|
Clears previous saved states for this object.
|
ConvertFromCoordinateSystem
|
Converts the Vector object from the custom CoordinateSystem by applying the direction cosine matrix of the CoordinateSystem object as a rotation to the calling Vector object.
|
ConvertToCoordinateSystem
|
Converts the Vector object into the custom CoordinateSystem by applying the direction cosine matrix of the CoordinateSystem object as a rotation to the calling Vector object.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
IntersectionTimes
|
This method provides a sequential listing of events related to the intersection of two objects, where one object moves to at least partially intersect another object. The objects can be a ThreeDModel and a Vector or a ProximityZone and a Vector. The start times, end times, and duration of the intersection are returned. FreeFlyer uses a definitive analytical solution to evaluate this method.
|
Intersects
|
Determines if the Vector object intersects any of the objects supplied as arguments.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
ResetMethodStates
|
Resets any method states associated with the calling object.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
ToColumnMatrix
|
Returns a column matrix representation of the value.
|
ToRowMatrix
|
Returns a row matrix representation of the value.
|
VertexAngle
|
Returns the angle in degrees between two 3-element vectors.
|
|
Name
|
Description
|
VisualOffsetX
|
Positional offset in the X-Direction for the origin of the vector for Visualization.
This property has been Deprecated. Please use the VisualOffset vector instead.
|
VisualOffsetY
|
Positional offset in the Y-Direction for the origin of the vector for Visualization.
This property has been Deprecated. Please use the VisualOffset vector instead.
|
VisualOffsetZ
|
Positional offset in the Z-Direction for the origin of the vector for Visualization.
This property has been Deprecated. Please use the VisualOffset vector instead.
|
X
|
Cartesian x component of the vector.
This property has been Deprecated. Please use the Element vector property instead.
|
Y
|
Cartesian y component of the vector.
This property has been Deprecated. Please use the Element vector property instead.
|
Z
|
Cartesian z component of the vector.
This property has been Deprecated. Please use the Element vector property instead.
|
|
See also
Coverage and Contact Analysis Guide
Vectors and Coordinate Systems Guide
Matrix, Array, and Variable Math Guide
|