AGI STK Util 11 Send comments on this topic.
IAgDirection Interface





Description

Interface to set and retrieve direction options for aligned and constrained vectors.

Public Methods

Public Method Assign Assign a new direction.
Public Method AssignEuler Helper method to set direction using the Euler representation. Params B and C use Angle Dimension.
Public Method AssignPR Helper method to set direction using the Pitch Roll representation. Pitch and Roll use Angle Dimension.
Public Method AssignRADec Helper method to set direction using the Right Ascension and Declination representation. Param Dec uses Latitude. Param RA uses Longitude.
Public Method AssignXYZ Helper method to set direction using the Cartesian representation. Params X, Y and Z are dimensionless.
Public Method ConvertTo Method to changes the direction to the type specified.
Public Method QueryEuler Helper method to get direction using the Euler representation. Params B and C use Angle Dimension.
Public Method QueryEulerArray Returns the Euler elements in an array.
Public Method QueryPR Helper method to get direction using the Pitch Roll representation. Pitch and Roll use Angle Dimension.
Public Method QueryPRArray Returns the PR elements in an array.
Public Method QueryRADec Helper method to get direction using the Right Ascension and Declination representation. Param Dec uses Latitude. Param RA uses Longitude.
Public Method QueryRADecArray Returns the RADec elements in an array.
Public Method QueryXYZ Helper method to get direction using the Cartesian representation. Params X, Y and Z are dimensionless.
Public Method QueryXYZArray Returns the XYZ elements in an array.

Public Properties

Public Property DirectionType Returns the type of direction currently being used.

Example

Query direction as another representation
[C#] Copy Code
// Method 1 
object b = null, c = null
direction.QueryEuler(AgEEulerDirectionSequence.e12, out b, out c); 
Console.WriteLine("B = {0}, C = {1}", b, c); 
// Method 2 
// The Query functions returns a one dimension array 
// The number of column rows depends on the representation 
Array euler = direction.QueryEulerArray(AgEEulerDirectionSequence.e12); 
Console.WriteLine("B = {0}, C = {1}", euler.GetValue(0), euler.GetValue(1)); 
 

Query direction as another representation
[Visual Basic .NET] Copy Code
#If Not CSToJava Then
' Method 1
Dim b As Object = Nothing, c As Object = Nothing
direction.QueryEuler(AgEEulerDirectionSequence.e12, b, c)
Console.WriteLine("B = {0}, C = {1}", b, c)
#End If
' Method 2
' The Query functions returns a one dimension array
' The number of column rows depends on the representation
#If Not CSToJava Then
Dim euler As Array = direction.QueryEulerArray(AgEEulerDirectionSequence.e12)
#Else
#End If
Console.WriteLine("B = {0}, C = {1}", euler.GetValue(0), euler.GetValue(1))

CoClasses that Implement IAgDirection

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1