AnimationModel.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    <DgnPlatform\DgnFileIO\ElementRefBase.h>


#include    <Mstn\MdlApi\mssystem.fdf>

#include    <AnimCore\Timeinterval.h>
#include    <Mstn\MdlApi\mstmatrx.fdf>
#include    <AnimCore\AnimatedElement.h>       
#include    <DgnPlatform\Material.h>
#include    <DgnPlatform\Light.h>



BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE

typedef enum
    {
    ScriptEntry_preview                 = 0,
    ScriptEntry_canPreviewBackwards     = 1,
    } ScriptEntryAttributes;

typedef enum
    {
    Interpolation_Unused                 = -1,
    Interpolation_Linear                = 0,
    Interpolation_Cubic                 = 1,
    }AnimatorInterpolation;


typedef enum
    {
    TIMECODE_Second                     = 1,
    TIMECODE_Minute                     = 2,
    TIMECODE_Hour                       = 3,
    TIMECODE_Week                       = 4,

    TIMECODE_Smpte_30                   = 30,
    TIMECODE_Smpte_25                   = 25,
    TIMECODE_Smpte_24                   = 24,
    TIMECODE_Smpte_48                   = 48,
    TIMECODE_Smpte_50                   = 50,
    TIMECODE_Smpte_60                   = 60,
    }TimeCode;

typedef enum
    {
    Display_Frames                      = 1,
    Display_SMPTE                       = 2,
    Display_String                     = 3,
    Display_WindowsTime                = 4,
    Display_WindowsDate                = 5,
    Display_WindowsFormat              = 6,
    Display_Date                       = 7,


    } TimeDisplay;


typedef enum
    {
    Preview_Play                = 0,
    Preview_Rewind              = 1,
    Preview_Next                = 2,
    Preview_Previous            = 3,
    Preview_Current             = 4,
    Preview_Start               = 5,
    Preview_End                 = 6,
    } PreviewMode;

typedef enum
    {
    Calculate_Normal                            = 0x00000000,
    Calculate_AnimatedElementVector             = 0x00000001,
    Calculate_AnimatedElementVectorHierarchy    = 0x00000002,
    Calculate_AllAnimatedElements               = 0x00000004,
    Caclulate_Actor                             = 0x00000008,
    Caclulate_NonActors                         = 0x00000010,
    Calculate_Materials                         = 0x00000020,
    Calculate_Lights                            = 0x00000040,
    Calculate_View                              = 0x00000080,
    Calculate_ViewToCameraModel                 = 0x00000100,
    Calculate_RenderingSettings                 = 0x00000200,
    Caclulate_ActorMotion                       = 0x00000400,
    } AnimationCalculationOptions;


struct AnimatorValueDescr;


/*=================================================================================**/
struct AnimationCamera
    {
    DPoint3d    m_position;
    DPoint3d    m_origin;
    DPoint3d    m_delta;
    RotMatrix   m_rMatrix;
    DPoint2d    m_offset;
    double      m_size;
    double      m_frontClip;
    double      m_backClip;
    double      m_cameraAngle;
    double      m_focalLength;

    AnimationCamera () {Reset ();}

    ANIMATOR_EXPORTED void    GetCameraPosition (DPoint3dP position) {*position = m_position;}

    ANIMATOR_EXPORTED void    GetOrientation (RotMatrixP rMatrix) {*rMatrix = m_rMatrix;}

    ANIMATOR_EXPORTED void    GetOffset (DPoint2dP offset) {*offset = m_offset;}

    ANIMATOR_EXPORTED double  GetViewSize () {return m_size;}

    ANIMATOR_EXPORTED double  GetFocalLength () {return m_focalLength;}

    ANIMATOR_EXPORTED double  GetFrontClip () {return m_frontClip;}

    ANIMATOR_EXPORTED double  GetBackClip () {return m_backClip;}

    ANIMATOR_EXPORTED double  GetCameraAngle () {return m_cameraAngle;}

    ANIMATOR_EXPORTED void    GetOrigin (DPoint3dP origin) {*origin = m_origin;}

    ANIMATOR_EXPORTED void    GetDelta (DPoint3dP delta) {*delta = m_delta;}

    ANIMATOR_EXPORTED void    Reset ()
        {
        memset (&m_position, 0, sizeof (m_position));
        memset (&m_origin, 0, sizeof (m_origin));
        memset (&m_delta, 0, sizeof (m_delta));
        memset (&m_rMatrix, 0, sizeof (m_rMatrix));
        memset (&m_offset, 0, sizeof (m_offset));
        m_size          = 0.0;
        m_frontClip     = 0.0;
        m_backClip      = 0.0;
        m_cameraAngle   = 0.0;
        m_focalLength   = 0.0;
        }
    };

/*=================================================================================**/
struct  TimeTransform
    {
    TimeVal                 time;
    Transform               transform;
    };


typedef RefCountedPtr <struct AnimationEvaluationContext>                   AnimationEvaluationContextPtr;

/*=================================================================================**/
struct AnimationEvaluationContext : public RefCountedBase, public NonCopyableClass
    {
private:
public:
    ANIMATOR_EXPORTED ~AnimationEvaluationContext ();

    ANIMATOR_EXPORTED void                                                      PushActiveContextTime (TimeVal time, ElementRefP timeRef);

    // Pop the current context from the stack. This must be paired with a push of the active context.
    ANIMATOR_EXPORTED void                                                      PopActiveContextTime ();
    ANIMATOR_EXPORTED TimeVal                                                   GetTime (ElementRefP timeRef) const;

    ANIMATOR_EXPORTED AnimatedElementP                                          GetAnimatedElement (ElementRefP  ref, DgnModelRefP modelRef = NULL);
    
    ANIMATOR_EXPORTED Bentley::MstnPlatform::Relationship::IGraphEvaluation*    GetGraph ();
    
    ANIMATOR_EXPORTED Bentley::MstnPlatform::Relationship::ElementRefVector&    GetActionRelationships ();

    ANIMATOR_EXPORTED AnimationCalculationOptions   GetCalculationOptions ();

    ANIMATOR_EXPORTED void      SetCalculationOptions (AnimationCalculationOptions options);

    ANIMATOR_EXPORTED void      SetParameters (ElementRefP  timeRef);

    ANIMATOR_EXPORTED AnimatedElementMapR    GetRootMap () const;

    ANIMATOR_EXPORTED static AnimationEvaluationContextPtr               Create (AnimationR animation, AnimationModelR model, TimeVal   time);
    };

/*=================================================================================**/
struct AnimationEventHandler 
{
public:
    void    OnAnimationModelChanged (DgnModelRefP oldModelRef, DgnModelRefP newModelRef);

    void    OnAnimationModelWrite (AnimationModelR model);

    void    OnAnimationModelLoaded (AnimationModelR model);

};


typedef AnimationEventHandler*          AnimationEventHandlerP;
typedef AnimationEventHandler&          AnimationEventHandlerR;


/*=================================================================================**/
struct AnimationModel : public RefCountedBase, public NonCopyableClass, public AnimationEventHandler
    {

private:
public:

    ANIMATOR_EXPORTED DgnModelRefP                  GetModelRef () const;

    ANIMATOR_EXPORTED DgnModelRefP                  GetTargetDesignModelRef ();

    ANIMATOR_EXPORTED DgnModelRefP                  GetAnimationModelToDesignModel () const;

    ANIMATOR_EXPORTED ElementRefP                   GetCurrentTimeRef () const;

    ANIMATOR_EXPORTED ElementRefP                   GetCurrentTimeActionRef () const;

    ANIMATOR_EXPORTED TimeVal                       GetStartTime () const;

    ANIMATOR_EXPORTED void                          SetStartTime (TimeVal beginTime);

    ANIMATOR_EXPORTED TimeVal                       GetEndTime () const;

    ANIMATOR_EXPORTED void                          SetEndTime (TimeVal endTime);

    ANIMATOR_EXPORTED TimeVal                       GetTickIncrementPerFrame () const;

    ANIMATOR_EXPORTED void                          SetTickIncrementPerFrame (TimeVal time, bool bWriteToFile = true);

    ANIMATOR_EXPORTED TimeCode                      GetTimeCode () const;

    ANIMATOR_EXPORTED void                          SetTimeCode (TimeCode code, bool bWriteToFile = true);

    ANIMATOR_EXPORTED void                          SetTimeFromFrameNumber (double frameNumber);

    ANIMATOR_EXPORTED TimeDisplay                   GetTimeDisplayFormat () const;

    ANIMATOR_EXPORTED void                          SetTimeDisplayFormat (TimeDisplay timeFormat);

    ANIMATOR_EXPORTED void                          GetTimeDisplayFormatString (WChar *pString) const;

    ANIMATOR_EXPORTED void                          SetTimeDisplayFormatString (WCharCP pString);

    ANIMATOR_EXPORTED int                           GetCameraView () const;

    ANIMATOR_EXPORTED void                          SetCameraView (int view);

    ANIMATOR_EXPORTED double                        GetCameraViewAspectRatio () const;

    ANIMATOR_EXPORTED void                          SetCameraViewAspectRatio (double aspectRatio);

    ANIMATOR_EXPORTED StatusInt                     WriteCameraViewAspectRatio (double aspectRatio);

    ANIMATOR_EXPORTED void                          GetViewMask (int views[Bentley::DgnPlatform::MAX_VIEWS]) const;

    ANIMATOR_EXPORTED void                          SetViewMask (int views[Bentley::DgnPlatform::MAX_VIEWS]) ;

    ANIMATOR_EXPORTED StatusInt                     WriteViewMask (int views[Bentley::DgnPlatform::MAX_VIEWS]);

    ANIMATOR_EXPORTED AnimationCalculationOptions   GetAnimationCalculationOption () const;

    ANIMATOR_EXPORTED void                          SetAnimationCalculationOption (AnimationCalculationOptions option);

    ANIMATOR_EXPORTED AnimationCameraP              GetAnimatedCamera ();

    ANIMATOR_EXPORTED ScriptAnimationParameterMapP  GetParameterMap ();

    ANIMATOR_EXPORTED TimeValueMap*                 GetTimeMap ();

    ANIMATOR_EXPORTED Bentley::MstnPlatform::Relationship::ElementRefVector& GetActionVector ();

    ANIMATOR_EXPORTED StatusInt                     GetTimeActionDuration (TimeIntervalP pDuration);

    ANIMATOR_EXPORTED ElementRefP                   GetTimeRef (DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED ElementRefP                   GetTimeActionRef (DgnModelRefP modelRef);

    ANIMATOR_EXPORTED double                        GetNFrames (TimeVal startTime,TimeVal endTime,TimeVal startFrameTimeIncrement) const;

    ANIMATOR_EXPORTED TimeVal                       FramesToTicks (double nFrames,TimeVal startTime,TimeVal startFrameTimeIncrement) const;

    ANIMATOR_EXPORTED StatusInt                     WriteTimeDisplayFormat (TimeDisplay format,WCharCP pFormatString);

    ANIMATOR_EXPORTED StatusInt                     SetActiveAnimationView (int view);

    ANIMATOR_EXPORTED void                          DoAnimation (AnimationEvaluationContextR   aeContext);

    ANIMATOR_EXPORTED TimeVal                       GetTime (ElementRefP timeElRef);

    ANIMATOR_EXPORTED void                          SetTime (TimeVal time, ElementRefP timeElRef);

    ANIMATOR_EXPORTED void                          GetTimeInNewStringFormat     (WCharP pString, WCharCP pFormatString, TimeVal time, TimeVal animationStartTime) const;

    ANIMATOR_EXPORTED StatusInt                     GetTimeFromNewFormattedString     (TimeVal *pTime, WCharCP pString, WCharCP pFormatString, TimeVal animationStartTime) const;

    ANIMATOR_EXPORTED void                          GetTimeInDisplayFormat (WCharP pBuffer, TimeVal time) const;

    ANIMATOR_EXPORTED StatusInt                     GetTimeFromFormattedString (TimeValP pTime, WCharCP   pString) const;

    ANIMATOR_EXPORTED void                          InitializeParametersForPreview (PreviewMode mode);

    ANIMATOR_EXPORTED void                          SetParameters (ElementRefP  timeRef = NULL);

    ANIMATOR_EXPORTED StatusInt                     AddExpressionToModel (WCharP pName, WCharP pDescription,WCharP pValue);

    ANIMATOR_EXPORTED StatusInt                     GetExpressionFromModel (WCharP pDescription, WCharP pValue,WCharP pName) const;

    ANIMATOR_EXPORTED StatusInt                     DeleteExpressionFromModel (WCharP pName);

    ANIMATOR_EXPORTED StatusInt                     UpdateExpression (WCharCP     pNewName, WCharCP     pDescription, WCharCP     pValue, WCharCP     pOldName);

    ANIMATOR_EXPORTED StatusInt                     GetExpressionListModel (ListModel **ppListModel);

    ANIMATOR_EXPORTED StatusInt                     SetActionNameDescriptionAndType     (WCharCP pName, WCharCP pDescription, WCharCP pType, Bentley::DgnPlatform::ElementId elID, Int32 propBlockIndex = -1);

    ANIMATOR_EXPORTED StatusInt                     GetActionNameDescriptionAndType    (WCharP pName, WCharP  pDescription, WCharP pType, Bentley::DgnPlatform::ElementId elID, DgnModelRefP modelRef, Int32 propBlockIndex = -1);

    ANIMATOR_EXPORTED StatusInt                     DeleteActionNameDescriptionAndType (Bentley::DgnPlatform::ElementId elID, Int32 propBlockIndex = -1);

    ANIMATOR_EXPORTED void                          ClearModel ();

    ANIMATOR_EXPORTED void                          ScaleModel (double scaleFactor);

    ANIMATOR_EXPORTED bool                          IsAnimationModel (DgnModelP cache);

    ANIMATOR_EXPORTED static StatusInt              ImportScript (AnimationModelP& animationModel, TimeIntervalP pInterval, WCharCP fileNameP, DgnModelRefP activeModel, TimeVal previewSkipTime, TimeCode timeCode, bool alwaysCreateNewModel = true);

    ANIMATOR_EXPORTED StatusInt                     CreateTimeAction (TimeIntervalP pInterval, TimeVal previewSkipTime, TimeCode timeCode, bool  bEnabled);

    ANIMATOR_EXPORTED StatusInt                     CreateIncludeAction (DgnModelRefP modelRef, TimeVal startTime, int repeatCount, double scale, bool bEnabled, DgnModelRefP modelRefAnimationModelIsFor = NULL);

    ANIMATOR_EXPORTED StatusInt                     CreateCollisionAction (DisplayPathSet* pDynamicDisplayPathSet, DisplayPathSet* pStaticDisplayPathSet, TimeInterval* pInterval,bool bEnabled,int  collisionType, RgbFactor* pDynamicColor, RgbFactor* pStaticColor, WChar* pwCharName);

    ANIMATOR_EXPORTED StatusInt                     CreateSavedViewAction  (ElementRefP viewRef, TimeVal time, bool bEnabled, AnimatorVelocity velocity, AnimatorInterpolation  interpolation, DPoint3d* customPosCurvePts, int customPosCurvePtCount, DPoint3d* customRotCurvePts, int customRotCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     CreateCameraScriptAction     (ActorElementP camera, TimeVal time, AnimatorVelocity velocity, AnimatorInterpolation interpolation, bool  enabled, bool interpolatePos, bool interpolateViewPlane, bool interpolateAngle, bool cameraUseWorldUp, DPoint3d* customPosCurvePts, int customPosCurvePtCount, DPoint3d* customRotCurvePts, int customRotCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     CreateTargetAction     (ActorElementP targetActor, ActorElementP *pSourceActors, Int32 numActors, TimeVal startTime, bool bOn, bool bEnabled, AnimatorVelocity velocity, DPoint3d* customRotCurvePts, int customRotCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     CreateCameraTransformScriptAction (WChar* cameraName, int count, TimeVal* time, AnimatorInterpolation interpolation, Int32 bEnabled, DPoint3d* viewOrigins, RotMatrix* viewRotations, double* viewSizes, DPoint3d* viewOffsets, double* focalLengths, double* frontClips, double* backClips, double* cameraAngles);

    ANIMATOR_EXPORTED StatusInt                     AddTargetDataBlockToTargetAction     (Bentley::MstnPlatform::Relationship::Relation* pTargetAction, TimeVal startTime, bool bOn, bool bEnabled, AnimatorVelocity velocity, DPoint3d* customRotCurvePts, int customRotCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     AddViewActionRelationToViewController  (ElementRefP      viewActionRef, Bentley::DgnPlatform::ElementId       *pRefAttachElID,  Bentley::DgnPlatform::ElementId       *pActorCoordSysID);

    ANIMATOR_EXPORTED ViewControllerCP              GetViewController () const;

    ANIMATOR_EXPORTED KeyFrameP                     AddKeyFrame (ElementRefP  ref);

    ANIMATOR_EXPORTED KeyFrameP                     FindKeyFrame (WCharCP pName,DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED KeyFrameP                     GetKeyFrame (ElementRefP ref);

    ANIMATOR_EXPORTED StatusInt                     DeleteKeyFrame (KeyFrameP pKeyFrame);

    ANIMATOR_EXPORTED StatusInt                     DeleteKeyFrame (WCharCP pName);

    ANIMATOR_EXPORTED StatusInt                     ScriptKeyFrame (KeyFrame *pKeyFrame, TimeVal time, AnimatorVelocity velocity, AnimatorInterpolation interpolation, bool enabled, DPoint3d *customPosCurvePts, int customPosCurvePtCount, DPoint3d *customRotCurvePts, int customRotCurvePtCount, DPoint3d *customScaleCurvePts, int customScaleCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     CreateScriptAction (ActorElementP actor, TimeInterval* pInterval, bool bEnabled, WCharCP pXPosExpression, WCharCP pYPosExpression, WCharCP pZPosExpression, WCharCP pXRotExpression, WCharCP pYRotExpression, WCharCP pZRotExpression, WCharCP pXScaleExpression, WCharCP pYScaleExpression, WCharCP pZScaleExpression, DisplayPathCP actorPath);

    ANIMATOR_EXPORTED StatusInt                     CreatePathAction (ActorElementP actor, MSElementDescrP pathEd, TimeIntervalP pInterval, bool bEnabled, AnimatorVelocity velocity, DPoint3d* customCurvePts, int customCurvePtCount,    Transform *pTrans, double startParam, double endParam, WCharCP pDistanceExpression, bool maintainActorOrientation, DisplayPathCP actorPath);

    ANIMATOR_EXPORTED StatusInt                     CreateAttachActorAction (ActorElementP parentActor, ActorElementP actorToAttach, TimeVal time, bool bEnabled, DisplayPathCP  parentActorPath, DisplayPathCP actorToAttachPath);

    ANIMATOR_EXPORTED StatusInt                     CreateDetachActorAction (ActorElementP parentActor, ActorElementP actorToDetach, TimeVal  time, bool bEnabled, DisplayPathCP parentActorPath, DisplayPathCP actorToDetachPath);

    ANIMATOR_EXPORTED StatusInt                     CreateElementAttributeAction (DisplayPathSet* pDisplayPathSet, TimeVal time, bool bEnabled, AnimatorVelocity vel, AnimatorInterpolation interp, bool* pVisibility, RgbFactor* pColor, double* pTransparency, UInt32* pTaskId, bool bTaskStart, DPoint3d* customCurvePts, int customCurvePtCount, bool undoable);

    ANIMATOR_EXPORTED ElementRefP                   AddAnimatedElementController (ElementRefP aRef, DgnModelRefP modelRefFromActiveModel = NULL,Bentley::DgnPlatform::ElementId refAttachID = 0, DisplayPathCP path = NULL);

    ANIMATOR_EXPORTED ElementRefP                   FindAnimatedElementController (Bentley::DgnPlatform::ElementId elID,Bentley::DgnPlatform::ElementId  refAttachID = 0,DgnModelRefP animationModelRef = NULL, DisplayPathCP path = NULL);

    ANIMATOR_EXPORTED StatusInt                     AddAnimatedElementRelationToAnimatedElementController (ElementRefP actionRef, ElementRefP subjectRef,DisplayPathCP pathToSubject = NULL);

    ANIMATOR_EXPORTED StatusInt                     DeleteAnimatedElementRelationFromAnimatedElementController (ElementRefP actionRef, ElementRefP subjectRef, DisplayPathCP pathToSubject = NULL);

    ANIMATOR_EXPORTED StatusInt                     CreateSourceLightAction (LightElementR light, TimeVal time, bool bEnabled, AnimatorVelocity vel,    AnimatorInterpolation interp, WCharCP pSettingName, AnimatorValueDescr* pValue, DPoint3d* customCurvePts, int customCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     AddLightActionRelationToLightController (ElementRefP lightActionRef, ElementRefP lightRef);

    ANIMATOR_EXPORTED LightControllerCP             GetLightController (ElementRefP lightRef);

    ANIMATOR_EXPORTED void                          AddLightController (ElementRefP lightRef, ElementRefP lightControllerRef);

    ANIMATOR_EXPORTED StatusInt                     CreateMaterialAction     (WCharCP materialName, TimeVal time, bool bEnabled, AnimatorVelocity vel,    AnimatorInterpolation   interp, WChar *pSettingName,  AnimatorValueDescr *pValue, DPoint3d* customCurvePts, int customCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     AddMaterialActionRelationToMaterialContoller (ElementRefP materialActionRef, WCharCP materialName);

    ANIMATOR_EXPORTED void                          AddMaterialController (WStringCR name, ElementRefP ref);

    ANIMATOR_EXPORTED void                          RemoveMaterialController (WStringCR name);

    ANIMATOR_EXPORTED MaterialControllerMapCR       GetMaterialControllerMap ();

    ANIMATOR_EXPORTED MaterialControllerCP          GetMaterialController (WStringCR materialName) const;

    ANIMATOR_EXPORTED StatusInt                     CreateRenderAction     (TimeVal time, bool bEnabled, AnimatorVelocity vel, AnimatorInterpolation interp, WChar *pSettingName, AnimatorValueDescr  *pValue, DPoint3d* customCurvePts, int customCurvePtCount);

    ANIMATOR_EXPORTED StatusInt                     AddRenderActionRelationToRenderController (ElementRefP renderActionRef);

    ANIMATOR_EXPORTED RenderControllerCP            GetRenderController () const;

    ANIMATOR_EXPORTED StatusInt                     CreateTimeTransformAction (TimeTransformArrayCR transforms, DisplayPathSetCR  elements, WStringCR scriptName, WStringCP description, bool addToAnimatedElementController);

    ANIMATOR_EXPORTED AnimatedElementControllerCP   GetAnimatedElementContoller     (ElementRefP animElRef);

    ANIMATOR_EXPORTED AnimatedElementControllerCP   GetAnimatedElementContoller (ElementRefP subjectRef,DgnModelRefP modelRef);

    ANIMATOR_EXPORTED StatusInt                     RenameKeyFrame (KeyFrameP keyframe, WCharP newName);

    ANIMATOR_EXPORTED StatusInt                     RenameActor (ActorElementP actor, WCharP newName);

    ANIMATOR_EXPORTED bool                          IsValidRelationForModel (Bentley::MstnPlatform::Relationship::Relation* pRel);

    ANIMATOR_EXPORTED bool                          IsValidAttachmentForTime (ActorElementP parentActor, ActorElementP actorToAttach, TimeVal time);

    ANIMATOR_EXPORTED bool                          IsValidDetachmentForTime (ActorElementP parentActor, ActorElementP actorToDetach, TimeVal time);

    ANIMATOR_EXPORTED ElementRefP                   FindControllerRefForAction (ElementRefP action);

    ANIMATOR_EXPORTED ControllerActionQueryCP       GetControllerActionQueryForAction (ElementRefP action);

    ANIMATOR_EXPORTED StatusInt                     ImportParametersFromMSA (WCharCP   fileNameP);

    ANIMATOR_EXPORTED StatusInt                     ImportParametersFromDGN (WCharCP   fileNameP);

    ANIMATOR_EXPORTED StatusInt                     GetTaskIdsForAnimatedElement (UInt32SetP pUInt32SetOut, AnimatedElementP   pAnimEl);

    ANIMATOR_EXPORTED DgnPlatform::MaterialPtr     GetAnimatedMaterial (MaterialCR  material);

    ANIMATOR_EXPORTED DgnPlatform::LightElementPtr ApplyAnimatedSourceLightSettings (LightElementCR light);

    ANIMATOR_EXPORTED DgnPlatform::SolarLightPtr   ApplyAnimatedSolarLightSettings (SolarLightCR light);

    ANIMATOR_EXPORTED DgnPlatform::FlashLightPtr   ApplyAnimatedFlashLightSettings (FlashLightCR light);

    ANIMATOR_EXPORTED DgnPlatform::AmbientLightPtr ApplyAnimatedAmbientLightSettings (AmbientLightCR light);



    }; //AnimationModel


/*=================================================================================**/
struct ControllerActionQuery 
{
public:
    ANIMATOR_EXPORTED StatusInt                       GetInitialValueForAction (AnimatorValueDescr* pDescr, UInt32 parameterId) const;

    ANIMATOR_EXPORTED StatusInt                       GetCurrentValueForAction (AnimatorValueDescr& descr, bool& hasChanged, UInt32 parameterId) const;

    ANIMATOR_EXPORTED ElementRefP                     FindSettingForTime (TimeVal time, WCharCP pSetting = NULL) const;

    ANIMATOR_EXPORTED bool                            WillScriptEntryConflict (ElementRefP* conflictElement, TimeVal startTime, TimeVal endTime, UInt32 relationPrivID, WCharP propertyName, ElementRefP currentEntryRef ) const;

}; // ControllerActionQuery



/*=================================================================================**/
struct ScriptAnimationParameters
    {
    double                  m_beginFrameParameter;
    double                  m_endFrameParameter;
    double                  m_frameParameter;
    double                  m_tSecondsParameter;
    double                  m_tSecondsSequenceParameter;
    double                  m_piParameter;
    double                  m_maxFrameParameter;
    double                  m_minFrameParameter;
    double                  m_pathLengthParameter;
    double                  m_beginSequenceParameter;
    double                  m_endSequenceParameter;
    double                  m_sequenceLengthParameter;
    };


/*=================================================================================**/
enum    AnimatorValueType
    {
    ANIMFMT_INVALID         = 0,
    ANIMFMT_DPFP            = 1,
    ANIMFMT_INT             = 2,
    ANIMFMT_DPNT3D          = 3,
    ANIMFMT_LOCALESTRING    = 4,        // Should never be used, but other values must remain the same.
    ANIMFMT_DATE            = 5,
    ANIMFMT_INT64           = 6,
    ANIMFMT_RMTX            = 7,
    ANIMFMT_WCHARSTRING     = 8,
    ANIMFMT_BOOL            = 9,
    };

/*=================================================================================**/
union   AnimatorValueUnion
    {
    double      doubleFormat;
    int         sIntFormat;
    DPoint3d    pntFormat;
    int         dateFormat[6];
    Int64       longIntFormat;
    RotMatrix   rMatrixFormat;
    DPoint2d    pnt2dFormat;
    WCharP      wCharPFormat;
    bool        boolFormat;
    };

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

    ANIMATOR_EXPORTED ~AnimatorValueDescr ();

    ANIMATOR_EXPORTED void SetWCharString (WCharCP pString);

    ANIMATOR_EXPORTED WCharCP GetWCharCP () const;

    ANIMATOR_EXPORTED void SetDouble (double value);

    ANIMATOR_EXPORTED double GetDouble () const;

    ANIMATOR_EXPORTED double* GetDoubleP ();

    ANIMATOR_EXPORTED double const * GetDoubleCP () const;

    ANIMATOR_EXPORTED void SetInt (int value);

    ANIMATOR_EXPORTED int GetInt () const;

    ANIMATOR_EXPORTED void SetInt64 (Int64 value);

    ANIMATOR_EXPORTED Int64 GetInt64 () const;

    ANIMATOR_EXPORTED Int64* GetInt64P ();

    ANIMATOR_EXPORTED void SetDPoint (DPoint3dCR value);

    ANIMATOR_EXPORTED void SetDPoint (RgbFactor const & value);

    ANIMATOR_EXPORTED void SetRgbFactor (RgbFactor const & value);

    ANIMATOR_EXPORTED void GetRgbFactor (RgbFactor& value) const;

    ANIMATOR_EXPORTED void GetDPoint (DPoint3d& value) const;

    ANIMATOR_EXPORTED DPoint3dCP  GetDPoint3dCP () const;

    ANIMATOR_EXPORTED DPoint3dP  GetDPoint3dP ();

    ANIMATOR_EXPORTED void SetRotMatrix (RotMatrix& value);

    ANIMATOR_EXPORTED void GetRotMatrix (RotMatrix& value) const;

    ANIMATOR_EXPORTED RotMatrixCP GetRotMatrixCP () const;

    ANIMATOR_EXPORTED void SetBoolean (bool value);

    ANIMATOR_EXPORTED bool GetBoolean () const;

    ANIMATOR_EXPORTED bool* GetBooleanP ();

    ANIMATOR_EXPORTED AnimatorValueType GetFormatType() const;

    ANIMATOR_EXPORTED void Copy (AnimatorValueDescr& descr);

    ANIMATOR_EXPORTED bool Equals (AnimatorValueDescr const& other) const;

    ANIMATOR_EXPORTED void SetFromParameterQuery (Bentley::MstnPlatform::Relationship::ParameterQuery& aRQuery, AnimatorValueType formatType);

    };


END_BENTLEY_MSTNPLATFORM_NAMESPACE