DtObserverAnimator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtObserverObject.h>

#include <vrvUtil/DtQuat.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <makArchives/DtObserverStateRecord.h>

#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>

#include <string>

namespace makVrv
{
   class DtDe;
   class DtObserver;
   class DtEaser;
   class DtCoordinateSystem;

   class DT_DLL_VRVCORE DtObserverAnimator
   {
      friend class DtObserverAnimatorCreator;

   public:

      virtual ~DtObserverAnimator();

   public:

      virtual void tick();

      virtual bool isDone() const;

      virtual DtObserver* observer() const;

   protected:

      struct EntityInfo
      {
         bool isValid;
         DtUniqueID elementId;
         DtVector geoPos;
         DtTaitBryan geoOri;
         DtVector cigPos;
         DtTaitBryan cigOri;
      };
   
   protected:

      DtObserverAnimator(DtDe& de, DtObserver& obs, DtVector geocEndPos,
         DtTaitBryan geocEndOri, double endZoom, float smoothTime = 3.0f);

      DtObserverAnimator(DtDe& de, DtObserver& obs, DtVector cigEndPos,
         DtQuat cigEndOri, double endZoom, float smoothTime = 3.0f);

      DtObserverAnimator(DtDe& de, DtObserver& obs, DtVector relativeEndPos,
         DtQuat relativeEndOri, double endZoom, DtUniqueID attachedTo,
         DtUniqueID secondaryAttachedTo,
         DtObserverObject::AttachType attachedType, float smoothTime = 3.0f);

      DtObserverAnimator(DtDe& de, DtObserver& obs,
         makArchives::DtObserverStateRecord& rec, float smoothTime = 3.0f);

   protected:

      virtual EntityInfo entityInfo(makVrv::DtDe& de, 
         const std::string& displayName);
      virtual EntityInfo entityInfo(makVrv::DtDe& de, DtUniqueID elementId);

      virtual void updateTargets();

      // onInit is not virtual, because it is called by the constructor
      void onInit();

      virtual void updateObserver();

      virtual DtVector calcTargetPosition();

      virtual DtQuat calcTargetOrientation();

      virtual void calculateUpVector();

      virtual void interpolatePosition(double t);

      virtual void interpolateOrientation(double t);

      virtual void interpolateZoom(double t);

      virtual void finish();

      virtual void slot_coordinateSystemChanged();

      virtual inline bool shouldLinearlyInterpolateOrientation() const;

      //helper functions to assist with the animation
      virtual double altitude(const DtVector& geoPos);
      virtual DtVector surfaceAt(const DtVector& geoPos);
      virtual DtVector clampAltitude(const DtVector& geoPos);
      virtual DtVector bounce(double dt, DtVector start, DtVector end);
      virtual double altitudeContrib();
      virtual double phase1Contrib(double t);
      virtual double phase3Contrib(double t);
      virtual double calculatePercentage(double s, double e, double t);
      virtual double calculateEasedPercent(double t);

      void initCoordinateSystem();

   protected:

      DtEaser* myEaser;

      makVrv::DtDe& myDe;
      makVrv::DtObserver& myObserver;
      float mySmoothTime;

      bool myIsDone;

      DtObserverObject::AttachType myAttachType;
      bool myIsAttached;
      DtUniqueID myAttachedTo;
      DtUniqueID mySecondaryAttachedTo;
      DtVector myLocationTrackAttachment;

      //these are all geocentric locations
      DtVector myStartPosition;
      DtVector myPreviousPosition;
      DtVector myCurrentPosition;
      DtVector myEndPosition;
      DtVector myOffsetPosition;

      DtVector myUpVector;

      //these are IG orientations
      DtQuat myStartOrientation;
      DtQuat myCurrentOrientation;
      DtQuat myEndOrientation;
      DtQuat myOffsetOrientation;

      //for trying to find a target location when the attachment point is on
      //a moving target
      DtVector myTargetPosition;
      DtQuat myTargetOrientation;

      //Animator needs to know if it is a 2D mode so it can use view resolution instead of zoom
      bool myIs2DObsMode;

      double myStartZoom;
      double myCurrentZoom;
      double myEndZoom;

      double myStartTime;
      double myCurrentTime;
      double myEndTime;

      double myTravelDistance;
      double myCurrentAltitude;

      bool myShouldUseLinearOrientationInterpolation;
      bool myShouldFaceEarth;

      DtSignalConnectionManager myConnections;

      DtCoordinateSystem* myCoordinateSystem = nullptr;
   };

   class DT_DLL_VRVCORE DtObserverAnimatorCreator : public DtVirtualBaseClass
   {
   public:

      static DtObserverAnimatorCreator& instance(DtDe& de);

      static void registerInstance(DtDe& de, DtObserverAnimatorCreator* anInstance);

   public:

      //functionality.
      virtual DtObserverAnimator* create(DtObserver& obs, DtVector geocEndPos,
         DtTaitBryan geocEndOri, double endZoom, float smoothTime = 3.0f);
      
      //functionality.
      virtual DtObserverAnimator* create(DtObserver& obs, DtVector cigEndPos,
         DtQuat cigEndOri, double endZoom, float smoothTime = 3.0f);

      //functionality.
      virtual DtObserverAnimator* create(DtObserver& obs, DtVector relativeEndPos,
         DtQuat relativeEndOri, double endZoom, DtUniqueID attachedTo,
         DtUniqueID secondaryAttachedTo,
         DtObserverObject::AttachType attachedType, float smoothTime = 3.0f);

      //functionality.
      virtual DtObserverAnimator* create(DtObserver& obs,
         makArchives::DtObserverStateRecord& rec, float smoothTime = 3.0f);

   protected:

      DtObserverAnimatorCreator(DtDe& de);

   protected:
      DtDe& myDe;
   };

} //makVrv::