Envelopes.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#ifndef DOCUMENTATION_GENERATOR

#if defined (__ANIMATOR_BUILD__)
#   define __ANIMATOR_DECLSPEC__         __declspec(dllexport)
#else
#   define __ANIMATOR_DECLSPEC__         __declspec(dllimport)
#endif

#define ANIMATOR_EXPORTED __ANIMATOR_DECLSPEC__

#else

#define ANIMATOR_EXPORTED

#endif


#include "TimeInterval.h"
#include "float.h"
#include "limits.h"


BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE

static const double     ENVELOPE_NoDouble   = DBL_MIN;
static const Int32      ENVELOPE_NoInt      = INT_MIN;
static const TimeVal    ENVELOPE_NoTime     = (TIME_Min + 1);
static const DPoint4d   ENVELOPE_NoQuat     = {1.0, 1.0, 1.0, 1.0};
static const WString    ENVELOPE_NoStr      = L"Invalid String";

/*=================================================================================**/
enum AnimatorVelocity
    {
    Velocity_Unused                     = -1,
    Velocity_Constant                   = 0,
    Velocity_Accelerate                 = 1,
    Velocity_Decelerate                 = 2,
    Velocity_AccelerateDecelerate       = 3,
    Velocity_Infinite                   = 4,
    Velocity_Custom                     = 5,
    };

/*=================================================================================**/
struct KeyDoubleValue
{
public:
    ANIMATOR_EXPORTED KeyDoubleValue ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED BentleyStatus Copy (KeyDoubleValueCR rhs);

    ANIMATOR_EXPORTED bool Equals (KeyDoubleValueCR rhs) const;

    ANIMATOR_EXPORTED void SetX (TimeVal x);

    ANIMATOR_EXPORTED void SetY (double y);

    ANIMATOR_EXPORTED TimeVal GetX () const;

    ANIMATOR_EXPORTED double GetY () const;

};

/*=================================================================================**/
struct KeyIntValue
{
public:
    ANIMATOR_EXPORTED KeyIntValue ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED BentleyStatus Copy (KeyIntValueCR rhs);

    ANIMATOR_EXPORTED bool Equals (KeyIntValueCR rhs) const;

    ANIMATOR_EXPORTED void SetX (TimeVal x);

    ANIMATOR_EXPORTED void SetY (Int32 y);

    ANIMATOR_EXPORTED TimeVal GetX () const;

    ANIMATOR_EXPORTED Int32 GetY () const;
};

/*=================================================================================**/
struct KeyTimeValue
{
public:
    ANIMATOR_EXPORTED KeyTimeValue ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED BentleyStatus Copy (KeyTimeValueCR rhs);

    ANIMATOR_EXPORTED bool Equals (KeyTimeValueCR rhs) const;

    ANIMATOR_EXPORTED void SetX (TimeVal x);

    ANIMATOR_EXPORTED void SetY (TimeVal y);

    ANIMATOR_EXPORTED TimeVal GetX () const;

    ANIMATOR_EXPORTED TimeVal GetY () const;
};


/*=================================================================================**/
struct KeyQuaternionValue
{
public:
    ANIMATOR_EXPORTED KeyQuaternionValue ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED BentleyStatus Copy (KeyQuaternionValueCR rhs);

    ANIMATOR_EXPORTED bool Equals (KeyQuaternionValueCR rhs) const;

    ANIMATOR_EXPORTED void SetX (TimeVal x);

    ANIMATOR_EXPORTED void SetY (DPoint4dCR y);

    ANIMATOR_EXPORTED TimeVal GetX () const;

    ANIMATOR_EXPORTED DPoint4dCR GetY () const;
};

/*=================================================================================**/
struct KeyWStringValue
{
public:
    ANIMATOR_EXPORTED KeyWStringValue ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED BentleyStatus Copy (KeyWStringValueCR rhs);

    ANIMATOR_EXPORTED bool Equals (KeyWStringValueCR rhs) const;

    ANIMATOR_EXPORTED void SetX (TimeVal x);

    ANIMATOR_EXPORTED void SetY (WStringCR y);

    ANIMATOR_EXPORTED TimeVal GetX () const;

    ANIMATOR_EXPORTED WStringCR GetY () const;
};

/*=================================================================================**/
enum VelocityDataType
    {
    VELOCITYDATATYPE_Unknown    = 0,
    VELOCITYDATATYPE_Bezier     = 1,
    };

typedef RefCountedPtr <struct VelocityData>                                 VelocityDataPtr;

/*=================================================================================**/
struct VelocityData : public RefCountedBase, public NonCopyableClass
{
public:

    ANIMATOR_EXPORTED BentleyStatus Copy (VelocityDataCR rhs);

    ANIMATOR_EXPORTED bool Equals (VelocityDataCR rhs) const;

    ANIMATOR_EXPORTED VelocityDataType GetType () const;

    ANIMATOR_EXPORTED void SetType (VelocityDataType type);

};


/*=================================================================================**/
struct BezierVelocity : public VelocityData
{
    DEFINE_T_SUPER(VelocityData)
public:

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED void InitConstant ();

    ANIMATOR_EXPORTED void InitAccelerate ();

    ANIMATOR_EXPORTED void InitDecelerate ();

    ANIMATOR_EXPORTED void InitAccelerateDecelerate ();

    ANIMATOR_EXPORTED BentleyStatus Copy (VelocityDataCR rhs);

    ANIMATOR_EXPORTED bool Equals (VelocityDataCR rhs) const;

    ANIMATOR_EXPORTED void AddArray (bvector<DPoint3d> const& pts);

    ANIMATOR_EXPORTED bvector<DPoint3d> const& GetArray () const;

    ANIMATOR_EXPORTED void Add (DPoint3dCR pt);

    ANIMATOR_EXPORTED bool IsValid () const;

    ANIMATOR_EXPORTED void Validate ();

    ANIMATOR_EXPORTED double ComputeBezierY (double tVal) const;

    ANIMATOR_EXPORTED static  VelocityDataPtr Create ();
};

/*=================================================================================**/
struct KeyComponent 
{
public:
    ANIMATOR_EXPORTED KeyComponent ();
    ANIMATOR_EXPORTED explicit KeyComponent (AnimatorVelocity velocity);

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED VelocityDataCP GetData () const;

    ANIMATOR_EXPORTED VelocityDataP  GetDataP ();

    ANIMATOR_EXPORTED BentleyStatus Copy (KeyComponentCR rhs);

    ANIMATOR_EXPORTED bool          Equals (KeyComponentCR rhs) const;

    ANIMATOR_EXPORTED void DeleteData ();

    ANIMATOR_EXPORTED VelocityDataP AddData (VelocityDataType type);

    ANIMATOR_EXPORTED AnimatorVelocity GetVelocityType () const;

    ANIMATOR_EXPORTED void SetVelocityType (AnimatorVelocity velType);

    ANIMATOR_EXPORTED Bentley::DgnPlatform::ElementId GetElementId () const;

    ANIMATOR_EXPORTED void SetElementId (Bentley::DgnPlatform::ElementId elId);
};

/*=================================================================================**/
struct KeyDoubleComponent : public KeyComponent
{
   DEFINE_T_SUPER(KeyComponent)    
public:
    ANIMATOR_EXPORTED KeyDoubleComponent ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED KeyDoubleValueCR    GetKeyValue () const;

    ANIMATOR_EXPORTED KeyDoubleValueR     GetKeyValueR ();
};

/*=================================================================================**/
struct KeyDoubleComponentComparator
{
public:

    ANIMATOR_EXPORTED bool operator() (KeyDoubleComponentCR l, KeyDoubleComponentCR r) const;
};

typedef bset<KeyDoubleComponent, KeyDoubleComponentComparator>      KeyDoubleComponentSet;
typedef KeyDoubleComponentSet*                                      KeyDoubleComponentSetP;
typedef KeyDoubleComponentSet const*                                KeyDoubleComponentSetCP;
typedef KeyDoubleComponentSet&                                      KeyDoubleComponentSetR;
typedef KeyDoubleComponentSet const&                                KeyDoubleComponentSetCR;

/*=================================================================================**/
struct KeyIntComponent : public KeyComponent
{
   DEFINE_T_SUPER(KeyComponent)    
public:
    ANIMATOR_EXPORTED KeyIntComponent ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED KeyIntValueCR    GetKeyValue () const;

    ANIMATOR_EXPORTED KeyIntValueR     GetKeyValueR ();
};

/*=================================================================================**/
struct KeyIntComponentComparator
{
public:

ANIMATOR_EXPORTED bool operator() (KeyIntComponentCR l, KeyIntComponentCR r) const;
};

typedef bset<KeyIntComponent, KeyIntComponentComparator>         KeyIntComponentSet;
typedef KeyIntComponentSet*                                      KeyIntComponentSetP;
typedef KeyIntComponentSet const*                                KeyIntComponentSetCP;
typedef KeyIntComponentSet&                                      KeyIntComponentSetR;
typedef KeyIntComponentSet const&                                KeyIntComponentSetCR;

/*=================================================================================**/
struct KeyQuaternionComponent : public KeyComponent
{
   DEFINE_T_SUPER(KeyComponent)    
public:
    ANIMATOR_EXPORTED KeyQuaternionComponent ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED KeyQuaternionValueCR    GetKeyValue () const;

    ANIMATOR_EXPORTED KeyQuaternionValueR     GetKeyValueR ();
};

/*=================================================================================**/
struct KeyQuaternionComponentComparator
{
public:

ANIMATOR_EXPORTED bool operator() (KeyQuaternionComponentCR l, KeyQuaternionComponentCR r) const;
};

typedef bset<KeyQuaternionComponent, KeyQuaternionComponentComparator>  KeyQuaternionComponentSet;
typedef KeyQuaternionComponentSet*                                      KeyQuaternionComponentSetP;
typedef KeyQuaternionComponentSet const*                                KeyQuaternionComponentSetCP;
typedef KeyQuaternionComponentSet&                                      KeyQuaternionComponentSetR;
typedef KeyQuaternionComponentSet const&                                KeyQuaternionComponentSetCR;


/*=================================================================================**/
struct KeyWStringComponent : public KeyComponent
{
   DEFINE_T_SUPER(KeyComponent)    
public:
    ANIMATOR_EXPORTED KeyWStringComponent ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED KeyWStringValueCR    GetKeyValue () const;

    ANIMATOR_EXPORTED KeyWStringValueR     GetKeyValueR ();
};

/*=================================================================================**/
struct KeyWStringComponentComparator
{
public:

ANIMATOR_EXPORTED bool operator() (KeyWStringComponentCR l, KeyWStringComponentCR r) const;
};

typedef bset<KeyWStringComponent, KeyWStringComponentComparator>  KeyWStringComponentSet;
typedef KeyWStringComponentSet*                                      KeyWStringComponentSetP;
typedef KeyWStringComponentSet const*                                KeyWStringComponentSetCP;
typedef KeyWStringComponentSet&                                      KeyWStringComponentSetR;
typedef KeyWStringComponentSet const&                                KeyWStringComponentSetCR;


/*=================================================================================**/
struct KeyTimeComponent : public KeyComponent
{
   DEFINE_T_SUPER(KeyComponent)    
public:
    ANIMATOR_EXPORTED KeyTimeComponent ();

    ANIMATOR_EXPORTED void InitDefaults ();

    ANIMATOR_EXPORTED KeyTimeValueCR    GetKeyValue () const;

    ANIMATOR_EXPORTED KeyTimeValueR     GetKeyValueR ();
};

/*=================================================================================**/
struct KeyTimeComponentComparator
{
public:

ANIMATOR_EXPORTED bool operator() (KeyTimeComponentCR l, KeyTimeComponentCR r) const;
};

typedef bset<KeyTimeComponent, KeyTimeComponentComparator>        KeyTimeComponentSet;
typedef KeyTimeComponentSet*                                      KeyTimeComponentSetP;
typedef KeyTimeComponentSet const*                                KeyTimeComponentSetCP;
typedef KeyTimeComponentSet&                                      KeyTimeComponentSetR;
typedef KeyTimeComponentSet const&                                KeyTimeComponentSetCR;


/*=================================================================================**/
struct KeyComponentEnvelope :  public RefCountedBase, public NonCopyableClass
{
public:
    //=======================================================================================
    // Defines an enumerator for the end behavior of the envelope
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================
    enum EndBehavior
        {
        ENDBEHAVIOR_Reset        = 0,
        ENDBEHAVIOR_Constant     = 1,
        ENDBEHAVIOR_Repeat       = 2,
        ENDBEHAVIOR_Oscillate    = 3,
        ENDBEHAVIOR_OffsetRepeat = 4,
        ENDBEHAVIOR_Linear       = 5,
        ENDBEHAVIOR_None         = 6,
        };

    ANIMATOR_EXPORTED EndBehavior GetPreBehavior () const;

    ANIMATOR_EXPORTED EndBehavior GetPostBehavior () const;

    ANIMATOR_EXPORTED UInt32 GetTaskId () const;

    ANIMATOR_EXPORTED bool HasComponentAtTime (TimeVal t) const;

    ANIMATOR_EXPORTED TimeVal GetResetPreTime () const;

    ANIMATOR_EXPORTED TimeVal GetResetPostTime () const;


    ANIMATOR_EXPORTED bool Equals (KeyComponentEnvelopeCR rhs) const;

    ANIMATOR_EXPORTED BentleyStatus InterpolationData (KeyComponentCP* lhs, KeyComponentCP* rhs, double& interp, TimeVal t) const;

    ANIMATOR_EXPORTED TimeInterval GetDuration (bool ignoreEndBehavior) const;

    ANIMATOR_EXPORTED BentleyStatus Serialize (DataExternalizer& out) const;
};

typedef RefCountedPtr <struct KeyDoubleComponentEnvelope>                                 KeyDoubleComponentEnvelopePtr;

/*=================================================================================**/
struct KeyDoubleComponentEnvelope : public KeyComponentEnvelope
{
   DEFINE_T_SUPER(KeyComponentEnvelope)    

    
    ANIMATOR_EXPORTED KeyDoubleComponentSetCR   GetComponents () const;

    ANIMATOR_EXPORTED bool  HasLimits () const;

    ANIMATOR_EXPORTED double GetLowerLimit () const;

    ANIMATOR_EXPORTED double GetUpperLimit () const;

    ANIMATOR_EXPORTED double GetInitialValue () const;

    ANIMATOR_EXPORTED double GetResetValue () const;


    ANIMATOR_EXPORTED double Interpolate (TimeVal t) const;

    ANIMATOR_EXPORTED double CubicInterpolate (TimeVal t) const;
};

typedef RefCountedPtr <struct KeyIntComponentEnvelope>                                 KeyIntComponentEnvelopePtr;

/*=================================================================================**/
struct KeyIntComponentEnvelope : public KeyComponentEnvelope
{
   DEFINE_T_SUPER(KeyComponentEnvelope)    

    
    ANIMATOR_EXPORTED KeyIntComponentSetCR   GetComponents () const;

    ANIMATOR_EXPORTED bool  HasLimits () const;

    ANIMATOR_EXPORTED Int32 GetLowerLimit () const;

    ANIMATOR_EXPORTED Int32 GetUpperLimit () const;

    ANIMATOR_EXPORTED Int32 GetInitialValue () const ;

    ANIMATOR_EXPORTED Int32 GetResetValue () const;

    ANIMATOR_EXPORTED void  SetResetValue (Int32 value);

    ANIMATOR_EXPORTED Int32 Interpolate (TimeVal t) const;

    ANIMATOR_EXPORTED Int32 InterpolateAsBoolean (TimeVal t) const;

    ANIMATOR_EXPORTED static  KeyIntComponentEnvelopePtr Create ();

};

typedef RefCountedPtr <struct KeyFileIncrementComponentEnvelope>                                 KeyFileIncrementComponentEnvelopePtr;

/*=================================================================================**/
struct KeyFileIncrementComponentEnvelope : public KeyIntComponentEnvelope
{
   DEFINE_T_SUPER(KeyIntComponentEnvelope)    

    
    ANIMATOR_EXPORTED Int32 GetInitialValue () const ;

    ANIMATOR_EXPORTED WStringR Increment (WStringR file, TimeVal t, Int32 frameNumber) const;

    ANIMATOR_EXPORTED static  KeyFileIncrementComponentEnvelopePtr Create ();
};

typedef RefCountedPtr <struct KeyTimeComponentEnvelope>                                 KeyTimeComponentEnvelopePtr;

/*=================================================================================**/
struct KeyTimeComponentEnvelope : public KeyComponentEnvelope
{
   DEFINE_T_SUPER(KeyComponentEnvelope)    

    
    ANIMATOR_EXPORTED KeyTimeComponentSetCR   GetComponents () const;

    ANIMATOR_EXPORTED bool  HasLimits () const;

    ANIMATOR_EXPORTED TimeVal GetLowerLimit () const;

    ANIMATOR_EXPORTED TimeVal GetUpperLimit () const;

    ANIMATOR_EXPORTED bool HasChangedForTime (TimeVal t) const;

    ANIMATOR_EXPORTED TimeVal GetInitialValue () const ;

    ANIMATOR_EXPORTED TimeVal GetResetValue () const;

    ANIMATOR_EXPORTED void  SetResetValue (TimeVal value);

    ANIMATOR_EXPORTED TimeVal Interpolate (TimeVal t) const;
};

typedef RefCountedPtr <struct KeyQuaternionComponentEnvelope>                                 KeyQuaternionComponentEnvelopePtr;


/*=================================================================================**/
struct KeyQuaternionComponentEnvelope : public KeyComponentEnvelope
{
   DEFINE_T_SUPER(KeyComponentEnvelope)    

    
    ANIMATOR_EXPORTED DPoint4dR GetInitialValue (DPoint4dR pt) const;

    ANIMATOR_EXPORTED DPoint4dR GetResetValue (DPoint4dR pt) const;

    ANIMATOR_EXPORTED void  SetResetValue (DPoint4dCR pt);

    ANIMATOR_EXPORTED KeyQuaternionComponentSetCR   GetComponents () const;

    ANIMATOR_EXPORTED DPoint4dR Interpolate (DPoint4dR pt, TimeVal t) const;

    ANIMATOR_EXPORTED DPoint4dR CubicInterpolate (DPoint4dR pt, TimeVal t) const;
};


typedef RefCountedPtr <struct KeyWStringComponentEnvelope>                                 KeyWStringComponentEnvelopePtr;

/*=================================================================================**/
struct KeyWStringComponentEnvelope : public KeyComponentEnvelope
{
   DEFINE_T_SUPER(KeyComponentEnvelope)    


    
    ANIMATOR_EXPORTED WStringR GetInitialValue (WStringR str) const;

    ANIMATOR_EXPORTED WStringR GetResetValue (WStringR str) const;

    ANIMATOR_EXPORTED void  SetResetValue (WStringCR str);

    ANIMATOR_EXPORTED KeyWStringComponentSetCR   GetComponents () const;

    ANIMATOR_EXPORTED WStringR Interpolate (WStringR str, TimeVal t) const;
};


END_BENTLEY_MSTNPLATFORM_NAMESPACE