Vector.BuildVector(Variable, RFLink, Variable) Method

Top

Description

When vectorType is "RFLink", the calling Vector will be initialized as the vector between the RFLink's Source and Target reference objects.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

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

Method Signature

Vector.BuildVector(	Variable vectorType,
	RFLink link,
	Variable direction)

Arguments

vectorType

Description:

Type of vector to create.

Valid Values:

Value	Label
0	Cartesian
1	Spherical
2	Cross Product
3	Normalized Vector
4	Body Axis
5	Body Angular Momentum
6	Body Position
7	Body Velocity Vector
8	Existing X-axis
9	Object-to-Object
10	Anti-Vector
11	Star
12	Object-to-Star
13	RFLink

link
Description:	A RFLink object to use for setting the ends of the calling Vector.

direction

Description:

Used to indicate the desired direction of the vector - setting direction to 0 goes from transmitter to receiver, while setting it to 1 goes from the receiver to the transmitter.

Valid Values:

Value	Label
0	Transmitter to Receiver
1	Receiver to Transmitter

Return Value

Type:

number

Informs the user whether the Vector was built successfully. (0 = Unsuccessful, 1 = Successful)

Syntax

myVariable1 = myVector1.BuildVector(myVariable2, myRFLink1, myVariable3);