Animation.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    <AnimCore\Relationship.h>
#include    <AnimCore\RelationshipMoniker.h>
#include    <AnimCore\RelationshipRelation.h>
#include    <AnimCore\RelationshipCollections.h>
#include    <AnimCore\Envelopes.h>
#include    <AnimCore\TimeInterval.h>
#include    <AnimCore\AnimationCollections.h>
#include    <AnimCore\AnimationModel.h>

#include    <Mstn\MdlApi\mssystem.fdf>
#include    <Mstn\MdlApi\msview.fdf>
#include    <Mstn\MdlApi\mstmatrx.fdf>



BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
#define ANIMATOR_ERROR_BASE                     0x21000
#define ANIMERR_DUPLICATENAME                   ANIMATOR_ERROR_BASE + 0x01
#define ANIMERR_ELEMENTINACTOR                  ANIMATOR_ERROR_BASE + 0x02
#define ANIMERR_ACTORCREATE                     ANIMATOR_ERROR_BASE + 0x03
#define ANIMERR_CANNOTFINDACTORNAMEDGROUP       ANIMATOR_ERROR_BASE + 0x04
#define ANIMERR_CANNOTADDACTORTONAMEDGROUP      ANIMATOR_ERROR_BASE + 0x05
#define ANIMERR_DROPACTOR                       ANIMATOR_ERROR_BASE + 0x06
#define ANIMERR_ACTORMUSTHAVENOCHILDRENTODROP   ANIMATOR_ERROR_BASE + 0x07
#define ANIMERR_NAMEDGROUP                      ANIMATOR_ERROR_BASE + 0x08
#define ANIMERR_KEYFRAMEEXISTS                  ANIMATOR_ERROR_BASE + 0x09
#define ANIMERR_DUPLICATECALLBACKFUNCITON       ANIMATOR_ERROR_BASE + 0x0a
#define ANIMERR_NOANIMATIONFILE                 ANIMATOR_ERROR_BASE + 0x0b
#define ANIMERR_ANIMATEDELEMENTEXISTS           ANIMATOR_ERROR_BASE + 0x0c
#define ANIMERR_CANNOTOPENFILETOCONVERTACTORS   ANIMATOR_ERROR_BASE + 0x0d
#define ANIMERR_CANNOTCONVERTV7ACTORS           ANIMATOR_ERROR_BASE + 0x0e
#define ANIMERR_EXITING                         ANIMATOR_ERROR_BASE + 0x0f
#define ANIMERR_CANNOTSCRIPTATTACHACTOR         ANIMATOR_ERROR_BASE + 0x10
#define ANIMERR_ACTORALREADYATTACHEDATTIME      ANIMATOR_ERROR_BASE + 0x11
#define ANIMERR_CANNOTCREATEPATHTOACTOR         ANIMATOR_ERROR_BASE + 0x12
#define ANIMERR_INVALIDDETACHTIME               ANIMATOR_ERROR_BASE + 0x13
#define ANIMERR_INCLUDEDSCRIPTCYCLE             ANIMATOR_ERROR_BASE + 0x14
#define ANIMERR_ACTORALREADYATTACHED            ANIMATOR_ERROR_BASE + 0x15
#define ANIMERR_INVALIDMODELREF                 ANIMATOR_ERROR_BASE + 0x16

struct  AnimatorProgressBar;



/*=================================================================================**/
struct Animation : public RefCountedBase
    {

    ANIMATOR_EXPORTED AnimationModelVector*             GetAnimationModels ();

    ANIMATOR_EXPORTED double                            GetFrameParameter ();

    ANIMATOR_EXPORTED double                            GetBeginFrameParameter ();

    ANIMATOR_EXPORTED double                            GetEndFrameParameter ();

    ANIMATOR_EXPORTED double                            GetMinFrameParameter ();

    ANIMATOR_EXPORTED double                            GetMaxFrameParameter ();

    ANIMATOR_EXPORTED AnimationModelP                   GetAnimationModelParameter ();

    ANIMATOR_EXPORTED ScriptParameterMapP               GetParameterMap ();

    ANIMATOR_EXPORTED SymbolSet*                        GetSymbolSet ();

    ANIMATOR_EXPORTED void                              AddAnimatedElementEventHandler (AnimatedElementEventHandlerP handler);

    ANIMATOR_EXPORTED void                              RemoveAnimatedElementEventHandler (AnimatedElementEventHandlerP handler);

    ANIMATOR_EXPORTED void                              AddAnimationEventHandler (AnimationEventHandlerP handler);

    ANIMATOR_EXPORTED void                              RemoveAnimationEventHandler (AnimationEventHandlerP handler);

    ANIMATOR_EXPORTED DgnModelRefP                      GetUpdateModelRef ();

    ANIMATOR_EXPORTED void                              SetUpdateModelRef (DgnModelRefP modelRef);

    ANIMATOR_EXPORTED ElementRefP                       GetTimeRef();

    ANIMATOR_EXPORTED ElementRefP                       GetTimeRef (DgnModelRefP animationModel);

    ANIMATOR_EXPORTED ElementRefP                       GetTimeActionRef (DgnModelRefP animationModel);

    ANIMATOR_EXPORTED AnimationModelP                   GetEditorAnimationModel ();

    ANIMATOR_EXPORTED AnimationModelP                   GetAnimationModel (DgnModelRefP modelRef);

    ANIMATOR_EXPORTED AnimationModelP                   FindAnimationModelForCache (DgnModelP cache);

    ANIMATOR_EXPORTED StatusInt                         CreateAnimationModel (AnimationModelP& animationModel, WCharCP pName, WCharCP pDescription, bool isDefaultAnimationModel);

    ANIMATOR_EXPORTED void                              SetDefaultAnimationModel (DgnModelRefP modelRef);

    ANIMATOR_EXPORTED DgnModelRefP                      FindAnimationModel (WCharP pModelName, DgnFileP dgnFileObj);

    ANIMATOR_EXPORTED StatusInt                         AddToAnimationModelListModel (ListModelP pListModel,WCharP pModelName,WCharP pModelDescription, UInt32 modelVersion, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED StatusInt                         GetAnimationModelListModel (ListModelP* ppListModel,DgnFileP dgnFileObj, bool isForIncludeScript, DgnModelRefP targetModel = NULL);

    ANIMATOR_EXPORTED StatusInt                         DestroyAnimationModelListModel (ListModelP pListModel);

    ANIMATOR_EXPORTED DgnModelRefP                      GetDefaultAnimationModel (DgnModelRefP modelRef, bool ignoreVersion = false, bool load = true);


    ANIMATOR_EXPORTED AdvancedRenderSettingsHostP       GetAdvancedRenderSettingsHost  ();

    ANIMATOR_EXPORTED void                              SetAdvancedRenderSettingsHost  (AdvancedRenderSettingsHostP host);

    ANIMATOR_EXPORTED StatusInt                         AttachAnimationModelToModel     (DgnModelRefP* pAnimationModelToDesignModelRef, DgnModelRefP designModel, DgnModelRefP animationModel);

    ANIMATOR_EXPORTED StatusInt                         AttachAnimationModelToModel     (DgnModelRefP* pAnimationModelToDesignModelRef, WCharCP designModelName, WCharCP designFileName, DgnModelRefP animationModel);

    ANIMATOR_EXPORTED bool                              IsAnimationModelAttachedToModel (DgnModelRefP *pAnimationModelToDesignModelRef, DgnModelRefP designModel, DgnModelRefP animationModel);

    ANIMATOR_EXPORTED bool                              IsAnimationModelAttachedToModel  (DgnModelRefP *pAnimationModelToDesignModelRef, WChar* modelName, DgnFileP dgnFileP, DgnModelRefP animationModel);

    ANIMATOR_EXPORTED StatusInt                         DetachAnimationModelToModel (DgnModelRefP animationModelToDesignModelRef);

    ANIMATOR_EXPORTED AnimationModelP                   LoadAnimationModel (WCharP pModelName, DgnModelRefP parentModelRef = NULL);

    ANIMATOR_EXPORTED StatusInt                         UnloadAnimationModel (WCharP pModelName);

    ANIMATOR_EXPORTED StatusInt                         UnloadAnimationModel(AnimationModelP model);

    ANIMATOR_EXPORTED AnimatedElementP                  GetAnimatedElement (ElementRefP ref, DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED AnimatedElementP                  GetAnimatedElement (Bentley::DgnPlatform::ElementId elID, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED AnimatedElementP                  AddAnimatedElement (ElementRefP ref, DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED StatusInt                         DropAnimatedElement (AnimatedElementP *animEl, DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED ActorElementP                     FindActor (WCharCP pName, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED ActorElementP                     FindActorForCoordSysElementID (Bentley::DgnPlatform::ElementId coordSysID, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED ActorElementP                     FindActorForCoordSysElementRef (ElementRefP  ref);

    ANIMATOR_EXPORTED ActorElementP                     GetActor(Bentley::DgnPlatform::ElementId actorID, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED ActorElementP                     GetActor (ElementRefP  ref,DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED StatusInt                         CreateActorFromEdP     (MSElementDescrP actorEdP, WCharCP pActorName, DPoint3dCP originP, RotMatrixCP rMatrixP, UInt32 actorMovableMask);

    ANIMATOR_EXPORTED void                              SynchActorToNamedGroup (Bentley::DgnPlatform::ElementId namedGroupID, Bentley::DgnPlatform::ElementId coordSysID, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED bool                              IsActorNamedGroup (NamedGroupP group);

    ANIMATOR_EXPORTED StatusInt                         DropActorByCoordSysID (Bentley::DgnPlatform::ElementId elID, DgnModelRefP modelRef);

    ANIMATOR_EXPORTED StatusInt                         DropActorByCoordSysRef (ElementRefP  ref);

    ANIMATOR_EXPORTED void                              GetAllRootActors (ActorElementMap* pMap, DgnModelRefP modelRef,bool includeStationaryActors = true);

    ANIMATOR_EXPORTED ElementRefP                       GetActorNamedGroupForMember (ElementRefP  ref);

    ANIMATOR_EXPORTED StatusInt                         ConvertNamedGroupToActor (NamedGroupP pNamedGroup, UInt32 taskId, ElementRefP* pCoordSysRefOut = NULL);

    ANIMATOR_EXPORTED StatusInt                         DropActorToNamedGroup (ActorElementP pActor, AnimationModelP pModel = NULL);

    ANIMATOR_EXPORTED UInt32                            GetActorNamedGroupsForMember (ElementRefP *pGroups, ElementRefP ref);

    ANIMATOR_EXPORTED StatusInt                         CreateTargetActor (WCharP name, Transform* transform);

    ANIMATOR_EXPORTED StatusInt                         CreateCameraActor
    (
    WCharP              name,
    WCharP              description,
    Transform*          transform,
    DPoint3d*           target,
    double              lensAngle,
    double              lensDiameter,
    double              frontClip,
    double              backClip,
    DPoint3d*           delta,
    DPoint3d*           offset
    );

    ANIMATOR_EXPORTED void                              AttachAnimatedElementViewUpdater ();

    ANIMATOR_EXPORTED void                              DetachAnimatedElementViewUpdater ();


    ANIMATOR_EXPORTED void                              PrintParameters ();

    ANIMATOR_EXPORTED static AnimationP                 GetManager ();

    ANIMATOR_EXPORTED static void                       RegisterManager ();

    ANIMATOR_EXPORTED static void                       UnregisterManager ();

    }; //Animation


/*=================================================================================**/
struct AnimatedElementEventHandler 
{
public:
    void    OnAnimatedElementAdded (AnimatedElementP animEl);

    void    OnAnimatedElementModified (AnimatedElementP animEl);

    void    OnAnimatedElementDelete (AnimatedElementP animEl);
};


/*=================================================================================**/
struct AnimMdlSaver
{
    ANIMATOR_EXPORTED static MdlDescP GetCurrMdlDescr ();

    ANIMATOR_EXPORTED static void SetCurrMdlDescr (MdlDescP descr);
};

/*=================================================================================**/
struct AnimatedElementEventHandlerList : DgnPlatform::AbstractEventHandlerList<AnimatedElementEventHandler, AnimMdlSaver>
{
};


/*=================================================================================**/
struct AdvancedRenderSettingsHost 
    {
public:
    AdvancedRenderSettingsHost () {}
    ANIMATOR_EXPORTED virtual ~AdvancedRenderSettingsHost () {}

    ANIMATOR_EXPORTED void          SetAnimatedFogColor (RgbFactor const & color);

    ANIMATOR_EXPORTED void          SetAnimatedDepthOfField (double dof);

    ANIMATOR_EXPORTED void          SetAnimatedBackgroundFileName (WStringCR fileName);
    };

/*=================================================================================**/
struct  ScriptParameters
    {
    ElementRefP      m_ref;
    double*         m_pParameterValues;
    };

END_BENTLEY_MSTNPLATFORM_NAMESPACE