AnimationCollections.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    <Mstn\basetype.h>
#include    <Mstn\MdlApi\mselems.h>
#include    <DgnPlatform\PersistentElementPath.h>

#include    "TimeInterval.h"


MSTNPLATFORM_TYPEDEFS (ScriptParameters)
MSTNPLATFORM_TYPEDEFS (AnimatedElementEventHandler)
MSTNPLATFORM_TYPEDEFS (AnimatedElementEventHandlerList)
MSTNPLATFORM_TYPEDEFS (AnimationEventHandler)
MSTNPLATFORM_TYPEDEFS (AnimationEventHandlerList)
MSTNPLATFORM_TYPEDEFS (AdvancedRenderSettingsHost)
MSTNPLATFORM_TYPEDEFS (Animation)
MSTNPLATFORM_TYPEDEFS (ControllerActionQuery)
MSTNPLATFORM_TYPEDEFS (AnimatedRenderOrchestrator)
MSTNPLATFORM_TYPEDEFS (AnimatedLightOrchestrator)
MSTNPLATFORM_TYPEDEFS (AnimatedMaterialOrchestrator)
MSTNPLATFORM_TYPEDEFS (AnimatedViewOrchestrator)
MSTNPLATFORM_TYPEDEFS (AnimationScheduleData)
MSTNPLATFORM_TYPEDEFS (AnimatedElementData)
MSTNPLATFORM_TYPEDEFS (AnimatorValueDescr)
MSTNPLATFORM_TYPEDEFS (AnimationCamera)
MSTNPLATFORM_TYPEDEFS (ScriptAnimationParameters)
MSTNPLATFORM_TYPEDEFS (AnimationModel)
MSTNPLATFORM_TYPEDEFS (AnimatedElementTransientElementRef)
MSTNPLATFORM_TYPEDEFS (AnimatedElement)
MSTNPLATFORM_TYPEDEFS (ActorElement)
MSTNPLATFORM_TYPEDEFS (KeyFrame)
MSTNPLATFORM_TYPEDEFS (ScriptParameters)
MSTNPLATFORM_TYPEDEFS (IAnimatorHandler)
MSTNPLATFORM_TYPEDEFS (IControllerElementRefAppData)
MSTNPLATFORM_TYPEDEFS (AnimatedElementController)
MSTNPLATFORM_TYPEDEFS (MultiActionSetCompare)
MSTNPLATFORM_TYPEDEFS (KeyDoubleValue)
MSTNPLATFORM_TYPEDEFS (KeyIntValue)
MSTNPLATFORM_TYPEDEFS (KeyTimeValue)
MSTNPLATFORM_TYPEDEFS (KeyQuaternionValue)
MSTNPLATFORM_TYPEDEFS (KeyWStringValue)
MSTNPLATFORM_TYPEDEFS (VelocityData)
MSTNPLATFORM_TYPEDEFS (BezierVelocity)
MSTNPLATFORM_TYPEDEFS (KeyComponent)
MSTNPLATFORM_TYPEDEFS (KeyDoubleComponent)
MSTNPLATFORM_TYPEDEFS (KeyIntComponent)
MSTNPLATFORM_TYPEDEFS (KeyQuaternionComponent)
MSTNPLATFORM_TYPEDEFS (KeyWStringComponent)
MSTNPLATFORM_TYPEDEFS (KeyTimeComponent)
MSTNPLATFORM_TYPEDEFS (KeyComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (KeyDoubleComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (KeyIntComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (KeyTimeComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (KeyQuaternionComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (KeyFileIncrementComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (KeyWStringComponentEnvelope)
MSTNPLATFORM_TYPEDEFS (InterpolatedTransform)
MSTNPLATFORM_TYPEDEFS (TransformStack)
MSTNPLATFORM_TYPEDEFS (InterpolatedDPoint3d)
MSTNPLATFORM_TYPEDEFS (DPoint3dStack)
MSTNPLATFORM_TYPEDEFS (InterpolatedDouble)
MSTNPLATFORM_TYPEDEFS (DoubleStack)
MSTNPLATFORM_TYPEDEFS (InterpolatedInt)
MSTNPLATFORM_TYPEDEFS (IntStack)
MSTNPLATFORM_TYPEDEFS (InterpolatedTimeVal)
MSTNPLATFORM_TYPEDEFS (TimeValStack)
MSTNPLATFORM_TYPEDEFS (InterpolatedQuaternion)
MSTNPLATFORM_TYPEDEFS (QuaternionStack)
MSTNPLATFORM_TYPEDEFS (MaterialController)
MSTNPLATFORM_TYPEDEFS (LightController)
MSTNPLATFORM_TYPEDEFS (RenderController)
MSTNPLATFORM_TYPEDEFS (ViewController)
MSTNPLATFORM_TYPEDEFS (AnimatorValueDescr)
MSTNPLATFORM_TYPEDEFS (AnimationEvaluationContext)
MSTNPLATFORM_TYPEDEFS (TimeTransform)
MSTNPLATFORM_TYPEDEFS (AnimatedElementViewUpdater)



BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE





/*=================================================================================**/
struct UniqueID
    {
    DgnFileP        m_dgnFile;
    Bentley::DgnPlatform::ElementId       m_elID;
    DgnModelRefP    m_modelRef;
    
    UniqueID () {}
    UniqueID (DgnFileP dgnFile, Bentley::DgnPlatform::ElementId elID, DgnModelRefP modelRef) : m_dgnFile (dgnFile), m_elID (elID), m_modelRef (modelRef){;}
    UniqueID (DgnFileP dgnFile, Bentley::DgnPlatform::ElementId elID) : m_dgnFile (dgnFile), m_elID (elID), m_modelRef (NULL){;}
    };

/*=================================================================================**/
struct UniqueIDCompare
    {
    bool operator() (UniqueID  const& id1, UniqueID  const& id2) const
        {
        if ((uintptr_t) id1.m_dgnFile < (uintptr_t)id2.m_dgnFile)
            return  true;
        else if ((uintptr_t) id1.m_dgnFile == (uintptr_t)id2.m_dgnFile)
            {
            if ((uintptr_t) id1.m_modelRef < (uintptr_t)id2.m_modelRef)
                return  true;
            else if ((uintptr_t) id1.m_modelRef == (uintptr_t)id2.m_modelRef)
                return  id1.m_elID < id2.m_elID;
            }

        return false;
        }
    };

/*=================================================================================**/
struct CollisionUID
    {
    Bentley::DgnPlatform::ElementId       m_elID;
    TimeVal         m_startTime;
    TimeVal         m_endTime;

    CollisionUID () {}
    CollisionUID (Bentley::DgnPlatform::ElementId elID, TimeVal startTime, TimeVal endTime) : m_elID (elID), m_startTime (startTime), m_endTime (endTime) {;}
    };

/*=================================================================================**/
struct TimeCompare
    {
    bool operator() (CollisionUID const& id1, CollisionUID const& id2) const
        {
        // First check for the start time of a script
        if (id1.m_startTime < id2.m_startTime)
            return true;
        else if (id1.m_startTime == id2.m_startTime)
            {
            if (id1.m_endTime < id2.m_endTime)
                return true;
            else if (id1.m_endTime == id2.m_endTime)
                return  id1.m_elID < id2.m_elID;
            }
        return false;
        }
    };

/*=================================================================================**/
struct MonikerPathEntry
    {
    Bentley::DgnPlatform::PersistentElementPath   path;
    Bentley::DgnPlatform::ElementId               refAttachID;

    MonikerPathEntry () {}
    };

/*=================================================================================**/
struct MultiActionSetCompare
    {
    bool operator() (const ElementRefP a, const ElementRefP b) const;
    };

/*=================================================================================**/
struct ViewDataSetCompare
    {
    bool operator() (const ElementRefP a, const ElementRefP b) const;
    };

/*=================================================================================**/
struct KeyFrameEntrySetCompare
    {
    bool operator() (const ElementRefP a,  const ElementRefP b) const;
    };
 
/*=================================================================================**/
struct MultiDataSetCompare
    {
    bool operator() (const ElementRefP a, const ElementRefP b) const;
    };
/*=================================================================================**/
struct DataSetCompare
    {
    ANIMATOR_EXPORTED bool operator() (const ElementRefP a, const ElementRefP b) const;
    };

typedef RefCountedPtr <struct AnimatedElement>                       AnimatedElementPtr;

typedef bmap<UniqueID, AnimatedElementPtr, UniqueIDCompare>          AnimatedElementMap;
typedef AnimatedElementMap*                                          AnimatedElementMapP;
typedef AnimatedElementMap const*                                    AnimatedElementMapCP;
typedef AnimatedElementMap&                                          AnimatedElementMapR;
typedef AnimatedElementMap const&                                    AnimatedElementMapCR;

typedef bmap<UniqueID, AnimatedElementP, UniqueIDCompare>            AnimatedElementPMap;
typedef AnimatedElementPMap*                                         AnimatedElementPMapP;
typedef AnimatedElementPMap const*                                   AnimatedElementPMapCP;
typedef AnimatedElementPMap&                                         AnimatedElementPMapR;
typedef AnimatedElementPMap const&                                   AnimatedElementPMapCR;

typedef bmap<TimeVal, AnimatedElementMap>                        TimeAnimatedElementMap;
typedef TimeAnimatedElementMap*                                      TimeAnimatedElementMapP;
typedef TimeAnimatedElementMap const*                                TimeAnimatedElementMapCP;
typedef TimeAnimatedElementMap&                                      TimeAnimatedElementMapR;
typedef TimeAnimatedElementMap const&                                TimeAnimatedElementMapCR;

typedef bmap<UniqueID, ActorElement*, UniqueIDCompare>          ActorElementMap;
typedef ActorElementMap*                                            ActorElementMapP;
typedef ActorElementMap const*                                      ActorElementMapCP;
typedef ActorElementMap&                                            ActorElementMapR;
typedef ActorElementMap const&                                      ActorElementMapCR;

typedef bmap<UniqueID, KeyFrame*, UniqueIDCompare>                  KeyFrameMap;
typedef KeyFrameMap*                                                KeyFrameMapP;
typedef KeyFrameMap const*                                          KeyFrameMapCP;
typedef KeyFrameMap&                                                KeyFrameMapR;
typedef KeyFrameMap const&                                          KeyFrameMapCR;

typedef bmap<UniqueID, ElementRefP, UniqueIDCompare>                ElementRefModelMap;
typedef ElementRefModelMap*                                         ElementRefModelMapP;
typedef ElementRefModelMap const*                                   ElementRefModelMapCP;
typedef ElementRefModelMap&                                         ElementRefModelMapR;
typedef ElementRefModelMap const&                                   ElementRefModelMapCR;

typedef bvector<ActorElement *>                           ActorElementVector;
typedef ActorElementVector*                               ActorElementVectorP;
typedef ActorElementVector const*                         ActorElementVectorCP;
typedef ActorElementVector&                               ActorElementVectorR;
typedef ActorElementVector const&                         ActorElementVectorCR;

typedef bvector<AnimatedElement *>                        AnimatedElementVector;
typedef AnimatedElementVector*                            AnimatedElementVectorP;
typedef AnimatedElementVector const*                      AnimatedElementVectorCP;
typedef AnimatedElementVector&                            AnimatedElementVectorR;
typedef AnimatedElementVector const&                      AnimatedElementVectorCR;

typedef bvector<TimeInterval>                             TimeIntervalVector;
typedef TimeIntervalVector*                               TimeIntervalVectorP;
typedef TimeIntervalVector const*                         TimeIntervalVectorCP;
typedef TimeIntervalVector&                               TimeIntervalVectorR;
typedef TimeIntervalVector const&                         TimeIntervalVectorCR;

typedef bvector<DPoint3d>                                 DPoint3dVec;
typedef DPoint3dVec*                                      DPoint3dVecP;
typedef DPoint3dVec const*                                DPoint3dVecCP;
typedef DPoint3dVec&                                      DPoint3dVecR;
typedef DPoint3dVec const&                                DPoint3dVecCR;

typedef bmap<ElementRefP, UInt64>                         TimeValueMap;
typedef TimeValueMap*                                     TimeValueMapP;
typedef TimeValueMap const*                               TimeValueMapCP;
typedef TimeValueMap&                                     TimeValueMapR;
typedef TimeValueMap const&                               TimeValueMapCR;

typedef bmap<UInt64, UInt32>                              TimeFrameMap;
typedef TimeFrameMap*                                     TimeFrameMapP;
typedef TimeFrameMap const*                               TimeFrameMapCP;
typedef TimeFrameMap&                                     TimeFrameMapR;
typedef TimeFrameMap const&                               TimeFrameMapCR;

typedef bvector <Transform>                               TransformVector;
typedef TransformVector*                                  TransformVectorP;
typedef TransformVector const*                            TransformVectorCP;
typedef TransformVector&                                  TransformVectorR;
typedef TransformVector const&                            TransformVectorCR;

typedef bvector <MSElementDescrP>                         MSElementDescrVector;
typedef MSElementDescrVector*                             MSElementDescrVectorP;
typedef MSElementDescrVector const*                       MSElementDescrVectorCP;
typedef MSElementDescrVector&                             MSElementDescrVectorR;
typedef MSElementDescrVector const&                       MSElementDescrVectorCR;

typedef bvector<DgnModelRefP>                             ModelRefVec;
typedef ModelRefVec*                                      ModelRefVecP;
typedef ModelRefVec const*                                ModelRefVecCP;
typedef ModelRefVec&                                      ModelRefVecR;
typedef ModelRefVec const&                                ModelRefVecCR;

typedef bvector<DgnModelP>                                DgnModelList;
typedef DgnModelList*                                     DgnModelListP;
typedef DgnModelList const*                               DgnModelListCP;
typedef DgnModelList&                                     DgnModelListR;
typedef DgnModelList const&                               DgnModelListCR;

typedef bset<UInt32>                                  UInt32Set;
typedef UInt32Set*                                        UInt32SetP;
typedef UInt32Set const*                                  UInt32SetCP;
typedef UInt32Set&                                        UInt32SetR;
typedef UInt32Set const&                                  UInt32SetCR;

typedef bset<DisplayPathCP>                           DisplayPathSet;
typedef DisplayPathSet*                                   DisplayPathSetP;
typedef DisplayPathSet const*                             DisplayPathSetCP;
typedef DisplayPathSet&                                   DisplayPathSetR;
typedef DisplayPathSet const&                             DisplayPathSetCR;


typedef bmap<UInt32, MonikerPathEntry>                MonikerPathMap;
typedef MonikerPathMap*                                   MonikerPathMapP;
typedef MonikerPathMap const*                             MonikerPathMapCP;
typedef MonikerPathMap&                                   MonikerPathMapR;
typedef MonikerPathMap const&                             MonikerPathMapCR;

typedef bmap<DgnModelP, ScriptParametersP>           ScriptParameterMap;
typedef ScriptParameterMap*                          ScriptParameterMapP;
typedef ScriptParameterMap const*                    ScriptParameterMapCP;
typedef ScriptParameterMap&                          ScriptParameterMapR;
typedef ScriptParameterMap const&                    ScriptParameterMapCR;


typedef bmultiset <ElementRefP, MultiActionSetCompare>       MultiActionSet;

typedef bmap<UInt32, MultiActionSet>                       ActionPriorityMap;
typedef ActionPriorityMap*                                  ActionPriorityMapP;
typedef ActionPriorityMap const*                            ActionPriorityMapCP;
typedef ActionPriorityMap&                                  ActionPriorityMapR;
typedef ActionPriorityMap const&                            ActionPriorityMapCR;

typedef bmap<DgnModelP, ScriptAnimationParametersP>       ScriptAnimationParameterMap;

typedef ScriptAnimationParameterMap*                          ScriptAnimationParameterMapP;
typedef ScriptAnimationParameterMap const*                    ScriptAnimationParameterMapCP;
typedef ScriptAnimationParameterMap&                          ScriptAnimationParameterMapR;
typedef ScriptAnimationParameterMap const&                    ScriptAnimationParameterMapCR;

typedef RefCountedPtr <struct AnimationModel>               AnimationModelPtr;

typedef bvector<AnimationModelPtr>                          AnimationModelVector;
typedef AnimationModelVector*                               AnimationModelVectorP;
typedef AnimationModelVector const*                         AnimationModelVectorCP;
typedef AnimationModelVector&                               AnimationModelVectorR;
typedef AnimationModelVector const&                         AnimationModelVectorCR;

typedef bmap<WString, ElementRefP>                      MaterialControllerMap;
typedef MaterialControllerMap*                          MaterialControllerMapP;
typedef MaterialControllerMap const*                    MaterialControllerMapCP;
typedef MaterialControllerMap&                          MaterialControllerMapR;
typedef MaterialControllerMap const&                    MaterialControllerMapCR;

typedef bmap<UniqueID, ElementRefP, UniqueIDCompare>    LightControllerMap;
typedef LightControllerMap*                             LightControllerMapP;
typedef LightControllerMap const*                       LightControllerMapCP;
typedef LightControllerMap&                             LightControllerMapR;
typedef LightControllerMap const&                       LightControllerMapCR;


typedef bvector<TimeTransform>                      TimeTransformArray;

typedef TimeTransformArray*                          TimeTransformArrayP;
typedef TimeTransformArray const*                    TimeTransformArrayCP;
typedef TimeTransformArray&                          TimeTransformArrayR;
typedef TimeTransformArray const&                    TimeTransformArrayCR;



END_BENTLEY_MSTNPLATFORM_NAMESPACE