AnimatedElement.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\AnimationCollections.h>
#include <AnimCore\Envelopes.h>
#include <AnimCore\Modifiers.h>

USING_NAMESPACE_BENTLEY_DGNPLATFORM

BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================
struct AnimatedElement : public RefCountedBase, public NonCopyableClass
{
public:

    //=======================================================================================
    //=======================================================================================
    enum    ModifierType
        {
        MODIFIERTYPE_Transform = 0,
        MODIFIERTYPE_Color,
        MODIFIERTYPE_Transparency,
        MODIFIERTYPE_Visiblity,
        };

public:

    ANIMATOR_EXPORTED virtual ~AnimatedElement ();

    ANIMATOR_EXPORTED TransformP          GetTransformation (TransformP pTrans);

    ANIMATOR_EXPORTED void                SetTransformation (Transform *pTrans, StackPriority priority, double blend = 1.0);

    ANIMATOR_EXPORTED MSElementDescrCP    GetCurrentElementRepresentation ();

    ANIMATOR_EXPORTED void                SetCurrentElementRepresentation (MSElementDescrP pEd);

    ANIMATOR_EXPORTED ActorElementP       GetActor ();

    ANIMATOR_EXPORTED void                SetActor (ActorElementP pActor);

    ANIMATOR_EXPORTED ElementId           GetElementID ();

    ANIMATOR_EXPORTED ElementRefP         GetElementRef ();

    ANIMATOR_EXPORTED bool                ToElementColor ();

    ANIMATOR_EXPORTED bool                FromElementColor ();

    ANIMATOR_EXPORTED void                SetToElementColor (bool toElementColor);

    ANIMATOR_EXPORTED void                SetFromElementColor (bool fromElementColor);

    ANIMATOR_EXPORTED void                SetColorInterParam (double colorInterParam);

    ANIMATOR_EXPORTED double              GetColorInterParam ();

    ANIMATOR_EXPORTED bool                Invisible ();

    ANIMATOR_EXPORTED void                SetInvisible (bool invisible, StackPriority priority, double blend = 1.0);

    ANIMATOR_EXPORTED bool                UseColor ();

    ANIMATOR_EXPORTED void                SetUseColor (bool bVal);

    ANIMATOR_EXPORTED UInt32              GetColor ();

    ANIMATOR_EXPORTED void                SetColor (UInt32 color, StackPriority priority, double blend = 1.0);

    ANIMATOR_EXPORTED bool                UseTransparency ();

    ANIMATOR_EXPORTED void                SetUseTransparency (bool bVal);

    ANIMATOR_EXPORTED double              GetTransparency ();

    ANIMATOR_EXPORTED void                SetTransparency (double transparency, StackPriority priority, double blend = 1.0);

    ANIMATOR_EXPORTED bool                RepresentsAllReferencesOfThisInstance ();

    ANIMATOR_EXPORTED DgnModelRefP        GetModelRef ();

    ANIMATOR_EXPORTED ActorElementVector* GetStationaryActors ();

    ANIMATOR_EXPORTED void                AddStationaryActor (ActorElementP  actor);

    ANIMATOR_EXPORTED bool                IsColorChangeInterference ();

    ANIMATOR_EXPORTED void                SetColorChangeInterference (bool colorChangeInterference);

    ANIMATOR_EXPORTED UInt32              GetLastUsedColor () ;

    ANIMATOR_EXPORTED void                SetLastUsedColor (UInt32 color);

    ANIMATOR_EXPORTED DgnModelRefP        GetStoredModelRef ();

    ANIMATOR_EXPORTED bool                IsInfiniteMotionTransition ();

    ANIMATOR_EXPORTED void                SetIsInfiniteMotionTransition (bool infiniteMotionTransition);

    ANIMATOR_EXPORTED BentleyStatus       SetBlendValueForType (ModifierType type, StackPriority priority, double blend);

    ANIMATOR_EXPORTED void                ResetAnimation ();

    ANIMATOR_EXPORTED bool                IsTransformed ();
};

//=======================================================================================
//=======================================================================================
struct ActorElement : public AnimatedElement
{

public:
    ANIMATOR_EXPORTED virtual ~ActorElement () {}

    ANIMATOR_EXPORTED ActorElementP          GetCurrentTarget ();

    ANIMATOR_EXPORTED void                   SetCurrentTarget (ActorElementP   target);

    ANIMATOR_EXPORTED void                   TransformActorHierarchy (TransformP pTrans, StackPriority priority, DgnModelP cache = NULL);

    ANIMATOR_EXPORTED void                   TransformActorChildren (TransformP pTrans, StackPriority priority, DgnModelP cache = NULL) ;

    ANIMATOR_EXPORTED void                   TransformActor (TransformP pTrans, StackPriority priority);

    ANIMATOR_EXPORTED ActorElementMapP       GetChildren ();

    ANIMATOR_EXPORTED StatusInt              AttachActor (ActorElementP child);

    ANIMATOR_EXPORTED StatusInt              DetachActor (ActorElementP child);

    ANIMATOR_EXPORTED Bentley::DgnPlatform::ElementId              GetCoordSysElementID();

    ANIMATOR_EXPORTED void                   Display (Bentley::DgnPlatform::DgnDrawMode displayMode, Bentley::DgnPlatform::DrawPurpose drawPurpose, int viewMask, bool bIncludeChildren, DgnModelRefP modelRef = NULL);

    ANIMATOR_EXPORTED StatusInt              DropActor ();

    ANIMATOR_EXPORTED StatusInt              DropHierarchy();

    ANIMATOR_EXPORTED ActorElementP          FindChild(Bentley::DgnPlatform::ElementId elID) ;

    ANIMATOR_EXPORTED bool                   ContainsCamera();

    ANIMATOR_EXPORTED StatusInt              GetName (WCharP pBuf,UInt32 bufChars);

    ANIMATOR_EXPORTED StatusInt              GetNamedGroup (NamedGroupP* actorGroupP, DgnModelRefP modelRef = NULL);


    ANIMATOR_EXPORTED UInt32                 GetMoveableMask ();

    ANIMATOR_EXPORTED ActorElementP          GetParent ();

    ANIMATOR_EXPORTED void                   GetForwardInverseTransform (TransformP pForward, TransformP pInverse);

    ANIMATOR_EXPORTED Bentley::DgnPlatform::ElementId              GetCameraCellElementID ();

    ANIMATOR_EXPORTED ElementRefP            GetCameraCellElementRef ();

    ANIMATOR_EXPORTED ElementRefP            GetCoordSysRef ();

    ANIMATOR_EXPORTED void                   GetActorElements (AnimatedElementMapP pMap);

    ANIMATOR_EXPORTED double                 GetTargetInterpolationParameter ();

    ANIMATOR_EXPORTED void                   SetTargetInterpolationParameter (double  interp);

    ANIMATOR_EXPORTED void                   GetOriginAndRotation (DPoint3dP origin, RotMatrixP rMatrix);

    ANIMATOR_EXPORTED bool                   IsAncestorOf (ActorElementP  parent);

    ANIMATOR_EXPORTED Bentley::DgnPlatform::ElementAgenda  GetAgenda (bool includeChildren);

    ANIMATOR_EXPORTED StatusInt               FindChildByElementRef (int *memberIndex, ElementRefP ref, DgnModelRefP modelRef = NULL) ;

    ANIMATOR_EXPORTED bool                    IsStationaryActor ();

    ANIMATOR_EXPORTED bool                    IsTaskActor ();

    ANIMATOR_EXPORTED UInt32                  GetTaskId ();


};

END_BENTLEY_MSTNPLATFORM_NAMESPACE