AGI STK VGT 11 Send comments on this topic.
IsTypeSupported Method (IAgCrdnAxesFactory)
See Also  Example
Type
Specify an axes type.





Description

Returns true if the type is supported.

Syntax

[Visual Basic .NET] 
Public Function IsTypeSupported( _
   ByVal Type As AgECrdnAxesType _
) As Boolean
[C#] 
public bool IsTypeSupported(

   AgECrdnAxesType Type

);
[Managed C++] 
public: bool IsTypeSupported(

   AgECrdnAxesType Type

);
[Java] 
public bool isTypeSupported(

   AgECrdnAxesType Type

);
[Unmanaged C++] 
public: HRESULT IsTypeSupported(

   AgECrdnAxesType Type, 

   VARIANT_BOOL * ReturnValue

);

Parameters

Type
Member Value Description
eCrdnAxesTypeUnknown -1 Unknown or unsupported type.
eCrdnAxesTypeLagrangeLibration 0 Libration point axes using one primary and multiple secondary central bodies. Set primary and secondary bodies, and point type.
eCrdnAxesTypeAngularOffset 1 Axes created by rotating the Reference axes about the Spin vector through the specified rotation angle plus the additional rotational offset.
eCrdnAxesTypeFixedAtEpoch 2 Axes based on another set fixed at a specified epoch.
eCrdnAxesTypeBPlane 3 B-Plane axes using the selected target body and reference vector.
eCrdnAxesTypeCustomScript 4 Customized axes offset with respect to a set of reference Axes.
eCrdnAxesTypeFromFile 5 This enumeration is deprecated. Use eCrdnAxesTypeFile instead. Axes specified by data from a file.
eCrdnAxesTypeFixed 6 Axes fixed in reference axes.
eCrdnAxesTypeAlignedAndConstrained 7 Axes aligned using two pairs of vectors. One vector in each pair is fixed in these axes and the other vector serves as an independent reference.
eCrdnAxesTypeModelAttachment 8 Axes aligned with the specified pointable element of the object's 3D model. The axes follow the model as well as any articulations that affect the specified pointable element.
eCrdnAxesTypeSpinning 9 Axes created by spinning the Reference axes about the Spin vector with the specified rate. The axes are aligned with the Reference axes at the specified epoch plus the additional rotational offset.
eCrdnAxesTypeOnSurface 10 Projection of the reference point onto the central body.
eCrdnAxesTypeTrajectory 11 Axes based on trajectory of the point relative to the reference coordinate system.
eCrdnAxesTypeTemplate 12 Represents a VGT axes created from a template. This type of axes is not creatable.
eCrdnAxesTypeAtTimeInstant 13 Axes orientation fixed relative to reference axes based on orientation of another set of axes evaluated at specified time instant.
eCrdnAxesTypePlugin 14 An axes plugin point.
eCrdnAxesTypeFile 5 Axes specified by data from a file.
Specify an axes type.

Example

Determine if the specified axes type is supported.
[C#] Copy Code
if (provider.Axes.Factory.IsTypeSupported(axesType)) 
{ 
    IAgCrdnAxes axes = provider.Axes.Factory.Create( 
        "AxesName", string.Empty, axesType); 
} 
 
Determine if the specified axes type is supported.
[Visual Basic .NET] Copy Code
If provider.Axes.Factory.IsTypeSupported(axesType) Then
    Dim axes As IAgCrdnAxes = provider.Axes.Factory.Create("AxesName", String.Empty, axesType)
End If

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1