vrfObjectFacadeInterface.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>

#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtIntersector.h>
#include <vrvCore/DtShowHideContext.h>
#include <vrvCore/DtModelSetEnums.h>

#include <matrix/vlVector.h>
#include <matrix/geodeticCoord.h>
#include <matrix/3dBoundingVolume.h>
#include <matrix/vlTaitBryan.h>
#include <string>
#include <vlpi/entityType.h>
#include <vrfutil/rwUUID.h>

#include <boost/signals2.hpp>
#include <set>
#include <vector>

class DtReferenceEllipsoid;

namespace makVrv
{
   class DtDe;
   class DtChannel;
   class DtWindow;
}

namespace makVrf
{
   enum DtAltitudeClampType
   {
      NoClamp = 0,
      AltitudeAboveSeaLevel = 1,
      AltitudeAboveTerrain = 2,
      ExactLocation = 3
   };

   class DtVrfObjectManipulationHandlerBaseClass;

   class DT_DLL_VRFGUICORE DtVrfObjectFacadeInterface
   {
   public:
      DtVrfObjectFacadeInterface( makVrv::DtDe& de, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified );
      
      virtual ~DtVrfObjectFacadeInterface();

      virtual const std::string& entityId() const
      {
         return myEntityId;
      }

      virtual void setEntityId(const std::string& i)
      {
         myEntityId = i;
      }

      virtual void setTopographicOffsetBetweenPoints(const DtGeodeticCoord& origin, const DtGeodeticCoord& originWithOffset, bool resetLocation = true);
      virtual void setTopographicOffsetFromPrincipal(const DtVector&, bool resetLocation = true);
      const DtVector& topographicOffsetFromPrincipal() const;

      virtual DtVector convertGeodeticOffsetFromOriginToTopographicOffsetFromOrigin(const DtGeodeticCoord&) const;
      virtual DtGeodeticCoord locationFromTopographicOffsetFromCenterPoint(const DtGeodeticCoord& origin) const;
      virtual DtVector convertGeodeticOffsetToTopographicOffset(const DtGeodeticCoord& origin, const DtGeodeticCoord& position) const;

      virtual double headingOffsetFromPrincipal() const;
      virtual void setHeadingOffsetFromPrincipal( double offset );

      virtual double pitchOffsetFromPrincipal() const;
      virtual void setPitchOffsetFromPrincipal( double offset );

      virtual const DtEntityType& entityType() const;
      virtual const DtEntityType& objectType() const;
      
      virtual Dt3dBoundingVolume boundingVolume(makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Models3D) const;

      virtual DtGeodeticCoord modifyPointByTopographicOffset(const DtGeodeticCoord& origin, const DtVector& topographicOffset) const;
      virtual double altitudeOffsetFromPrincipal() const;
      virtual void setAltitudeOffsetFromPrincipal( double offset, bool resetLocation = true );
      
      virtual makVrv::DtUniqueID uniqueIDForModelSet(makVrv::DtModelSetId set) const = 0;
      virtual makVrv::DtUniqueID uniqueID() const = 0;
      virtual std::vector<makVrv::DtUniqueID> modelUniqueIDs() const = 0;

      virtual void setOverrideIdsToIgnore(const std::vector<makVrv::DtUniqueID>& overrideIgnore);

      virtual const std::vector<makVrv::DtUniqueID>& idsToIgnore() const;

      virtual makVrv::DtUniqueID sceneObjectId() const;
      virtual void setSceneObjectId( const makVrv::DtUniqueID& id );
      
      virtual std::string displayName() const;
      virtual void setDisplayName( const std::string& displayName );
      
      virtual void setUUID(const DtUUID&);
      virtual const DtUUID& uuid() const;

      virtual DtGeodeticCoord currentGeodeticOrigin() const;

      virtual DtGeodeticCoord currentGeodeticPosition() const;

      virtual DtGeodeticCoord convertToGeodetic(const DtVector& v) const;

      virtual double currentHeading() const;
      virtual void setCurrentHeading( double currentHeading );
      virtual void setHeadingChanged(bool b);

      virtual double currentPitch() const;
      virtual void setCurrentPitch( double currentPitch );
      virtual void setPitchChanged(bool b);

      virtual void setSelected(bool);

      virtual void setAttachedTo(DtVrfObjectFacadeInterface*, const DtVector& offset, const DtTaitBryan& offsetOrientation);
      const DtVector& attachedPoint() const
      {
         return myAttachPoint;
      }

      const DtTaitBryan& attachedOrientation()
      {
         return myAttachOrientation;
      }

      DtVrfObjectFacadeInterface* attachedToObject() const
      {
         return myAttachedTo;
      }

      virtual bool attachedTo() const;
      virtual void detach();

      virtual std::string overlayName() const;

      virtual double currentAltitude() const;

      virtual DtVector centerOfMass() const;

      virtual DtVector geocentricLocation() const;
      virtual DtVector localLocation() const;
      virtual DtVector localLocation(const DtGeodeticCoord& geodLocation) const;

      virtual double initialAltitudeAboveTerrain() const;

      virtual DtVector reviseLocation(const DtVector& loc, int clampType = -1) const;
      
      virtual DtTaitBryan localOrientation() const;

      virtual void setExtendedData(const std::map<std::string, std::string>&)
      {
      }

      virtual void setExtendedData(const std::map<DtString, DtString>&);

      virtual void mergeExtendedData(const std::map<std::string, std::string>&)
      {
      }

      virtual std::map<std::string, std::string> extendedData() const
      {
         return std::map<std::string, std::string>();
      }
      virtual std::map<int, DtString> extendedLabels() const
      {
         return std::map<int, DtString>();
      }

      boost::signals2::signal<void (DtVrfObjectFacadeInterface*)> signal_visualized;
      boost::signals2::signal<void (DtVrfObjectFacadeInterface*)> signal_originChanged;
      boost::signals2::signal<void (DtVrfObjectFacadeInterface*, bool)> signal_selected;

   public:
      
      virtual void setOrigin(const DtGeodeticCoord&);
      virtual void setOrigin(const DtVector&);

      virtual void setSymbolNameVisible(bool, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Icons2D) = 0;

      virtual void setPickable(bool) = 0;
      virtual void setIndicatorVisible(bool) = 0;
      virtual void setWidgetEventsEnabled(bool) = 0;
      virtual void setHatLineVisible(bool) = 0;

      virtual void setVisible(bool, makVrv::DtShowHideContext::ShowHideContext, bool updateOffsets = true) = 0;
      virtual bool isVisible() const = 0;

      virtual void setVisible(bool show, bool updateOffsets = true);

      virtual void setTopographicOrientation(const DtTaitBryan&) = 0;
      virtual void setLocalOrientation(const DtTaitBryan&) = 0;

      virtual void unrealizeFacades(bool willRecreate = false) = 0;

      virtual void realizeFacades() = 0;

      virtual void clearHeadingChanged()
      {
         myHeadingChanged = false;
      }

      virtual void clearPitchChanged()
      {
         myPitchChanged = false;
      }

      virtual bool hasNameChange() const
      {
         return myDisplayNameChanged;
      }

      virtual void clearLocationChange()
      {
         myLocationChanged = false;
      }

      virtual bool hasLocationChange() const
      {
         return myLocationChanged;
      }

      virtual bool hasAltitudeChange() const
      {
         return myAltitudeChanged;
      }

      virtual bool hasHeadingChange() const
      {
         return myHeadingChanged;
      }

      virtual bool hasPitchChange() const
      {
         return myPitchChanged;
      }

      virtual void clearFlags();

      virtual void setAltitudeClampType(DtAltitudeClampType t);
      virtual DtAltitudeClampType altitudeClampType() const
      {
         return myAltitudeClampType;
      }

      virtual void setAltitudeAboveTerrain(double);
      virtual double altitudeAboveTerrain() const
      {
         return myAltitudeAboveGL;
      }

      virtual void setAltitudeAboveSeaLevel(double);
      virtual double altitudeAboveSeaLevel() const
      {
         return myAltitudeAboveSL;
      }

      virtual void setIsAnchor(bool);
      virtual bool isAnchor() const
      {
         return myAnchor;
      }

      virtual void setUserData(const std::string& userData);
      virtual std::string userData() const;
      bool userDataChanged() const
      {
         return myUserDataChanged;
      }

      makVrv::DtModelSetId modelSet() const
      {
         return myModelSetOnly;
      }

      bool supportsModelSet(makVrv::DtModelSetId i) const
      {
         return ((myModelSetOnly == makVrv::DtModelSetId::Unspecified) || (i == myModelSetOnly));
      }

      virtual makVrv::DtIntersector::IntersectProperties intersectorPickMask() const;

      virtual DtVector clampToLowestNonOceanPolygon( const DtVector& lp, makVrv::DtIntersector::IntersectProperties props ) const;
      virtual DtVector clampToGround( const DtVector& localPosition, makVrv::DtIntersector::IntersectProperties props =
         makVrv::DtIntersector::SupportNodes, int clampType = -1, bool* foundClamp = nullptr ) const;
      virtual DtGeodeticCoord clampToGround( const DtGeodeticCoord& localPosition, makVrv::DtIntersector::IntersectProperties props =
         makVrv::DtIntersector::SupportNodes, int clampType = -1, bool* foundClamp = nullptr ) const;

      virtual void setEmbarkationAllowed(bool);
      bool embarkationAllowed() const;

      virtual void setDoNotClamp(bool b)
      {
         if (b)
         {
            myAltitudeClampType = NoClamp;
         }
         else
         {
            myAltitudeClampType = AltitudeAboveTerrain;
         }
      }

      bool doNotClamp() const
      {
         return (myAltitudeClampType == NoClamp);
      }

      virtual void setClampToClosestPolygon(bool b)
      {
         myClampToClosestPolygon = b;
      }

      bool clampToClosestPolygon() const
      {
         return myClampToClosestPolygon;
      }

   protected:
      virtual void setCurrentGroundLocation( const DtGeodeticCoord& currentGroundLocation );

   protected:
      makVrv::DtDe& myDe;
      makVrv::DtUniqueID mySceneObjectId;
      std::string myDisplayName;
      std::string myEntityId;

      DtTaitBryan myOrientationOffset;
      double myAltitudeOffsetFromPrincipal;
      
      DtGeodeticCoord myCurrentGroundLocation;   
      DtTaitBryan myOrientation;

      bool myDisplayNameChanged;
      bool myLocationChanged;
      bool myAltitudeChanged;
      bool myHeadingChanged;
      bool myPitchChanged;
      bool myUserDataChanged;

      mutable DtAltitudeClampType myAltitudeClampType;
      double         myAltitudeAboveSL;
      double         myAltitudeAboveGL;
      bool           myAnchor;
      std::string    myUserData;

      makVrv::DtModelSetId myModelSetOnly;
      DtEntityType myEntityType;
      bool myClampToClosestPolygon;
      DtUUID myUUID;
      bool myEmbarkationAllowed;

      DtVrfObjectFacadeInterface* myAttachedTo;
      DtVector myAttachPoint;
      DtTaitBryan myAttachOrientation;

      mutable std::vector<makVrv::DtElementID> myUnifiedIgnoreList;
      mutable std::set<makVrv::DtUniqueID> myDIGuyIdsIgnored;
      mutable std::vector<makVrv::DtUniqueID> myModelIds;

      std::vector<makVrv::DtUniqueID> myOverrideIdsToIgnore;

      DtVector myTopographicOffsetFromPrincipal;
      typedef std::map<makVrv::DtModelSetId, bool> ModelSetVisualizationMap;
      ModelSetVisualizationMap myModelSetVisualizationMap;
   };
}