AGI STK VGT 11 Send comments on this topic.
IsTypeSupported Method (IAgCrdnPointFactory)
See Also  Example
Type
Specify a point type.





Description

Returns true if the type is supported.

Syntax

[Visual Basic .NET]
Public Function IsTypeSupported( _
   ByVal Type As AgECrdnPointType _
) As Boolean

[C#]
public bool IsTypeSupported(
AgECrdnPointType Type
);

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

[Java]
public bool isTypeSupported(
AgECrdnPointType Type
);

[Unmanaged C++]
public: HRESULT IsTypeSupported(
AgECrdnPointType Type,
VARIANT_BOOL * ReturnValue
);

Parameters

Type
Member Value Description
eCrdnPointTypeUnknown -1 Unknown or unsupported type.
eCrdnPointTypeBPlane 0 B-Plane point using the selected target body.
eCrdnPointTypeGrazing 1 The grazing point is the point of closest approach to the surface of the selected central body along a defined direction.
eCrdnPointTypeCovarianceGrazing 2 The point of closest approach to the surface of the specified position covariance ellipsoid surface along a defined direction. Position covariance must be available for a vehicle object to be considered a possible target for this option.
eCrdnPointTypeFromFile 3 This enumeration is deprecated. Use eCrdnPointTypeFile instead. Point specified by data from a file.
eCrdnPointTypeFixedInSystem 4 Point fixed in a reference coordinate system.
eCrdnPointTypeGlint 5 Point on central body surface that reflects from source to observer.
eCrdnPointTypePlaneIntersection 6 Point on a plane located along a given direction looking from a given origin.
eCrdnPointTypeModelAttachment 7 Point placed at the specified attachment point of the object's 3D model. The point follows the model as well as any articulations that affect the specified attachment point.
eCrdnPointTypePlaneProjection 8 The projection of a point onto a reference plane.
eCrdnPointTypeOnSurface 9 The detic subpoint of the reference point as projected onto the central body.
eCrdnPointTypeLagrangeLibration 10 Libration point using one primary and multiple secondary central bodies.
eCrdnPointTypeTemplate 11 Represents a VGT point created from a template. This type of point is not creatable.
eCrdnPointTypeCentralBodyIntersect 12 Point on central body surface along direction vector originating at source point.
eCrdnPointTypeAtTimeInstant 13 Point fixed relative to reference system based on another point evaluated at specified time instant.
eCrdnPointTypePlugin 14 A point plugin point.
eCrdnPointTypeFile 3 Point specified by data from a file.
eCrdnPointTypeFixedOnCentralBody 15 Point fixed on a central body.
Specify a point type.

Example

Determine if the specified point type is supported.
[C#] Copy Code
// Check if the specified point type is supported. 
if (provider.Points.Factory.IsTypeSupported(PointType)) 

    IAgCrdnPoint point = provider.Points.Factory.Create( 
        "PointName"string.Empty, PointType); 

 

Determine if the specified point type is supported.
[Visual Basic .NET] Copy Code
' Check if the specified point type is supported.
If provider.Points.Factory.IsTypeSupported(PointType) Then
    Dim point As IAgCrdnPoint = provider.Points.Factory.Create("PointName", String.Empty, PointType)
End If

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1