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





Description

Returns true if the type is supported.

Syntax

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

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

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

[Java]
public bool isTypeSupported(
AgECrdnPlaneType Type
);

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

Parameters

Type
Member Value Description
eCrdnPlaneTypeUnknown -1 Unknown or unsupported type.
eCrdnPlaneTypeNormal 0 A plane normal to a vector at a given point.
eCrdnPlaneTypeQuadrant 1 A plane is defined by the quadrant from a Reference System (e.g., XY, XZ, YZ, YX, ZX, ZY). The reference point in all cases is the origin of the coordinate system.
eCrdnPlaneTypeTrajectory 2 A plane is defined on the basis of a trajectory of a selected point with respect to a reference point.
eCrdnPlaneTypeTriad 3 A plane is defined by the three points.
eCrdnPlaneTypeTemplate 4 Represents a VGT plane created from a template. This type of plane is not creatable.
Specify a VGT plane type.

Example

Determine if the specified plane type is supported.
[C#] Copy Code
// Check if the specified plane type is supported. 
if (provider.Planes.Factory.IsTypeSupported(planeType)) 

    IAgCrdnPlane p = provider.Planes.Factory.Create( 
        "PlaneName"string.Empty, 
        planeType); 

 

Determine if the specified plane type is supported.
[Visual Basic .NET] Copy Code
' Check if the specified plane type is supported.
If provider.Planes.Factory.IsTypeSupported(planeType) Then
    Dim p As IAgCrdnPlane = provider.Planes.Factory.Create("PlaneName", String.Empty, planeType)
End If

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1