CoordinateSystem.SetQuaternion(Variable, Variable, Variable, Variable) Method

Top

Description

Initializes the CoordinateSystem object using the orientation specified by the quaternion.

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

CoordinateSystem.SetQuaternion(	Variable q1,
	Variable q2,
	Variable q3,
	Variable q4)

Arguments

q1
Description:	The first vector component of the quaternion that specifies the orientation of the CoordinateSystem.
Valid Range:	-1 ≤ q1 ≤ 1

q2
Description:	The second vector component of the quaternion that specifies the orientation of the CoordinateSystem.
Valid Range:	-1 ≤ q2 ≤ 1

q3
Description:	The third vector component of the quaternion that specifies the orientation of the CoordinateSystem.
Valid Range:	-1 ≤ q3 ≤ 1

q4
Description:	The scalar component of the quaternion that specifies the orientation of the CoordinateSystem.
Valid Range:	-1 ≤ q4 ≤ 1

Return Value

Type:

number

Returns a 1 if the Coordinate System quaternions were set successfully. Returns a 0 if unsuccessful.

Syntax

myVariable1 = myCoordinateSystem1.SetQuaternion(myVariable2, myVariable3, myVariable4, myVariable5);