AGI AgCrdnPlugin 11 Send comments on this topic.
CurrentValue Method (IAgCrdnConfiguredSystem)
See Also 
DispInterface

An interface supporting IAgEpoch. This is the interface that is passed to the plugin component method call.

X
X component of the vector at the current time
Y
Y component of the vector at the current time
Z
Z component of the vector at the current time
Q1
Q1 component of the quaternion at the current time
Q2
Q2 component of the quaternion at the current time
Q3
Q3 component of the quaternion at the current time
Q4
Q4 component of the quaternion at the current time





Description

Computes the System position (in internal units) and quaternion at the interface's current time.

Syntax

[Visual Basic .NET]
Public Function CurrentValue( _
   ByVal DispInterface As Object, _
   ByRef X As Double, _
   ByRef Y As Double, _
   ByRef Z As Double, _
   ByRef Q1 As Double, _
   ByRef Q2 As Double, _
   ByRef Q3 As Double, _
   ByRef Q4 As Double _
) As Boolean

[C#]
public bool CurrentValue(
Object DispInterface,
ref double X,
ref double Y,
ref double Z,
ref double Q1,
ref double Q2,
ref double Q3,
ref double Q4
);

[Managed C++]
public: bool CurrentValue(
IUnknown ^ DispInterface,
double ^ X,
double ^ Y,
double ^ Z,
double ^ Q1,
double ^ Q2,
double ^ Q3,
double ^ Q4
);

[Java]
public bool currentValue(
Object DispInterface,
double X,
double Y,
double Z,
double Q1,
double Q2,
double Q3,
double Q4
);

[Unmanaged C++]
public: HRESULT CurrentValue(
IUnknown * DispInterface,
double * X,
double * Y,
double * Z,
double * Q1,
double * Q2,
double * Q3,
double * Q4,
VARIANT_BOOL * ReturnValue
);

Parameters

DispInterface

An interface supporting IAgEpoch. This is the interface that is passed to the plugin component method call.

X
X component of the vector at the current time
Y
Y component of the vector at the current time
Z
Z component of the vector at the current time
Q1
Q1 component of the quaternion at the current time
Q2
Q2 component of the quaternion at the current time
Q3
Q3 component of the quaternion at the current time
Q4
Q4 component of the quaternion at the current time

Return Type

Returns false if an error occurred, else returns true.

Remarks

Plugin components that know a current time use interface arguments supporting this interface. See IAgAsHpopPluginResult and IAgGatorPluginResultState for examples.

See Also

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1