AGI STK VGT 11 Send comments on this topic.
Create Method (IAgCrdnVectorFactory)
See Also  Example
VectorName
Specify a component name.
Description
Specify a component description.
VectorType
Specify a component type.





Description

Creates a VGT vector using specified name, description and type.

Syntax

[Visual Basic .NET]
Public Function Create( _
   ByVal VectorName As String, _
   ByVal Description As String, _
   ByVal VectorType As AgECrdnVectorType _
) As IAgCrdnVector

[C#]
public IAgCrdnVector Create(
string VectorName,
string Description,
AgECrdnVectorType VectorType
);

[Managed C++]
public: IAgCrdnVector^ Create(
String __gc ^ VectorName,
String __gc ^ Description,
AgECrdnVectorType VectorType
);

[Java]
public IAgCrdnVector create(
String VectorName,
String Description,
AgECrdnVectorType VectorType
);

[Unmanaged C++]
public: HRESULT Create(
BSTR VectorName,
BSTR Description,
AgECrdnVectorType VectorType,
IAgCrdnVector ** ReturnValue
);

Parameters

VectorName
Specify a component name.
Description
Specify a component description.
VectorType
Member Value Description
eCrdnVectorTypeUnknown -1 Unknown or unsupported vector type.
eCrdnVectorTypeDisplacement 0 Vector defined by its start and end points.
eCrdnVectorTypeApoapsis 1 Vector from the center of the specified central body to the farthest point of an elliptical orbit created from the motion of the specified point.
eCrdnVectorTypeFixedAtEpoch 2 Based on another vector fixed at a specified epoch.
eCrdnVectorTypeAngularVelocity 3 Angular velocity vector of one set of axes computed with respect to the reference set.
eCrdnVectorTypeConing 4 Vector created by revolving the Reference vector around the About vector with the specified rate. The vector is aligned with Reference vector at specified epoch. After that it revolves between start/stop angles using either uni- or bi-directional mode.
eCrdnVectorTypeCrossProduct 5 The vector cross product of two vectors.
eCrdnVectorTypeCustomScript 6 Customized vector components defined with respect to reference axes.
eCrdnVectorTypeDerivative 7 Derivative of a vector computed with respect to specified axes.
eCrdnVectorTypeAngleRate 8 Angle rate vector perpendicular to the plane in which the angle is defined.
eCrdnVectorTypeEccentricity 9 Vector directed from the center of the specified central body toward the nearest point of an elliptical orbit created from the motion of the specified point.
eCrdnVectorTypeFixedInAxes 10 Vector fixed in reference axes.
eCrdnVectorTypeTwoPlanesIntersection 12 Defined along the intersection of two planes.
eCrdnVectorTypeLineOfNodes 13 Unit vector along the line of nodes - the line of intersection of the osculating orbit plane and the inertial equator of the specified central body.
eCrdnVectorTypeModelAttachment 14 Unit vector along the specified pointable element of the object's 3D model. The vector's direction follows the model as well as any articulations that affect the specified pointable element.
eCrdnVectorTypeOrbitAngularMomentum 15 Vector perpendicular to the plane of an elliptical orbit created from the motion of the specified point with respect to the center of the specified central body.
eCrdnVectorTypeOrbitNormal 16 Unit vector perpendicular to the plane of an elliptical orbit created from the motion of the specified point with respect to the center of the specified central body.
eCrdnVectorTypePeriapsis 17 Vector from the center of the specified central body to the nearest point of an elliptical orbit created from the motion of the specified point.
eCrdnVectorTypeProjection 18 A projection of a vector computed with respect to a reference plane.
eCrdnVectorTypeReflection 19 Incident vector reflected using a plane whose normal is the normal vector, scaled by a factor. The selected vector or its opposite can be reflected on just one or on both sides of the plane.
eCrdnVectorTypeScaled 20 Scaled version of the input vector.
eCrdnVectorTypeDirectionToStar 21 Defined with respect to a star object.
eCrdnVectorTypeTemplate 22 Represents a VGT vector created from a template. This type of vector is not creatable.
eCrdnVectorTypeAtTimeInstant 23 Vector fixed relative to reference axes based on another vector evaluated at specified time instant.
eCrdnVectorTypeLinearCombination 24 Linear combination of two input vectors.
eCrdnVectorTypeProjectAlong 25 A projection of a source vector in the direction of another vector.
eCrdnVectorTypeScalarLinearCombination 26 Linear combination of two input vectors using scalars.
eCrdnVectorTypeScalarScaled 27 Scaled version of the input vector using scalar.
eCrdnVectorTypeVelocity 28 Velocity vector of a point in a coordinate system.
eCrdnVectorTypePlugin 29 A vector plugin point.
Specify a component type.

Remarks

Spaces and most punctuation ( except for "-_().") cannot be used as a part of a component name when creating new components via VGT API.

Example

Create a vector.perpendicular to the plane in which the angle is defined.
[C#] Copy Code
// Create a vector.perpendicular to the plane in which the angle is defined. 
IAgCrdnVectorAngleRate vector = (IAgCrdnVectorAngleRate)provider.Vectors.Factory.Create( 
    "myVector"
    "a vector.perpendicular to the plane in which the angle is defined.", AgECrdnVectorType.eCrdnVectorTypeAngleRate); 
 

Create a vector.perpendicular to the plane in which the angle is defined.
[Visual Basic .NET] Copy Code
' Create a vector.perpendicular to the plane in which the angle is defined.
Dim vector As IAgCrdnVectorAngleRate = DirectCast(provider.Vectors.Factory.Create("myVector", "a vector.perpendicular to the plane in which the angle is defined.", AgECrdnVectorType.eCrdnVectorTypeAngleRate), IAgCrdnVectorAngleRate)

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1