STK AgCrdnPlugin	Send comments on this topic.
CurrentValue Method (IAgCrdnConfiguredAxesWithRate)
See Also

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

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.

Wx: X component of the angular velocity at the current time.

Wy: Y component of the angular velocity at the current time.

Wz: Z component of the angular velocity at the current time.

Description

Computes the quaternion representing the Axes and its angular rate in reference components at the interface's current time.

Syntax

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

[Visual Basic .NET]

Public Function CurrentValue( _
    ByVal DispInterface As Object, _
    ByRef Q1 As Double, _
    ByRef Q2 As Double, _
    ByRef Q3 As Double, _
    ByRef Q4 As Double, _
    ByRef Wx As Double, _
    ByRef Wy As Double, _
    ByRef Wz As Double _
) As Boolean

[C#]
public bool CurrentValue( Object DispInterface, ref double Q1, ref double Q2, ref double Q3, ref double Q4, ref double Wx, ref double Wy, ref double Wz );

[C#]

public bool CurrentValue(
    Object DispInterface,
    ref double Q1,
    ref double Q2,
    ref double Q3,
    ref double Q4,
    ref double Wx,
    ref double Wy,
    ref double Wz
);

[Managed C++]
public: bool CurrentValue( IUnknown ^ DispInterface, double ^ Q1, double ^ Q2, double ^ Q3, double ^ Q4, double ^ Wx, double ^ Wy, double ^ Wz );

[Managed C++]

public: bool CurrentValue(
    IUnknown ^ DispInterface,
    double ^ Q1,
    double ^ Q2,
    double ^ Q3,
    double ^ Q4,
    double ^ Wx,
    double ^ Wy,
    double ^ Wz
);

[Unmanaged C++]
public: HRESULT CurrentValue( IUnknown * DispInterface, double * Q1, double * Q2, double * Q3, double * Q4, double * Wx, double * Wy, double * Wz, VARIANT_BOOL * pResult );

[Unmanaged C++]

public: HRESULT CurrentValue(
    IUnknown * DispInterface,
    double * Q1,
    double * Q2,
    double * Q3,
    double * Q4,
    double * Wx,
    double * Wy,
    double * Wz,
    VARIANT_BOOL * pResult
);

[Python - STK API ]
def CurrentValue(self, DispInterface:"IDispatch", Q1:float, Q2:float, Q3:float, Q4:float, Wx:float, Wy:float, Wz:float) -> typing.Tuple[float, float, float, float, float, float, float, bool]:

[Python - STK API

]

def CurrentValue(self, DispInterface:"IDispatch", Q1:float, Q2:float, Q3:float, Q4:float, Wx:float, Wy:float, Wz:float) -> typing.Tuple[float, float, float, float, float, float, float, bool]:

Parameters

DispInterface: An interface supporting IAgEpoch. This is the interface that is passed to the plugin component method call.
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.
Wx: X component of the angular velocity at the current time.
Wy: Y component of the angular velocity at the current time.
Wz: Z component of the angular velocity 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.

Description

Syntax

Parameters

Return Type

Remarks

See Also