vrfObjectManipulationManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrlinkSimulatedEnvironmentProcess.h>
#include <vrfGuiCore/orderedEntityTypeList.h>
#include <vrfGuiCore/vrfObjectManipulationHandlerBaseClass.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtSelectionManager.h>
#include <vrvCore/DtElementEntry.h>
#include <vrvCore/DtElementAttributeManager.h>

namespace makVrv
{
   class DtDe;
   class DtInputDriver;
   class DtMouseEvent;
   class DtChannel;
   class DtKeyEvent;
   class DtObserver;
}

#define DtMultipleObjectEditorManipulationHandlerType DtEntityType(300, 300, 300, 300, 300, 300, 300)

namespace makVrf
{
   class DtVrfObjectManipulationHandlerBaseClass;
   class DtVrfEditManagerEventProcessor;

   static DtEntityType DtEditingMultipleObjectsType(256, 256, 256, 256, 256, 256, 256);

   class DT_DLL_VRFGUICORE DtVrfObjectManipulationManager : public makVrv::DtVirtualBaseClass
   {
   protected:
      typedef DtOrderedEntityTypeList<DtVrfObjectManipulationHandlerCreatorInterface*>  VrfObjectManipulationCreators;
      typedef DtOrderedEntityTypeList<DtEntityType*>  VertexEditingTypeMap;
      typedef boost::function< void ( DtEnvironmentStateView* )> ProcessEnvStateFunction;

   public:
      
      enum AllowEditingOf
      {
         AllowNone = 0,
         AllowLocalObjects = 0x00000001,
         AllowPublishedObjects = 0x00000002,
         AllowAll = AllowLocalObjects | AllowPublishedObjects
      };

   public:

      DtVrfObjectManipulationManager(makVrv::DtDe&);

      virtual ~DtVrfObjectManipulationManager();

      bool creatingObject() const;      

      DtVrfObjectManipulationHandlerBaseClass* currentObjectManipulationHandler();

   public:
      virtual void setAlwaysCreateLocal(bool);
      virtual bool alwaysCreateLocal() const;

      static DtVrfObjectManipulationManager& instance(makVrv::DtDe& de);

      virtual void addObjectManipulationHandler(const DtEntityType&, DtVrfObjectManipulationHandlerCreatorInterface*);
      virtual void removeObjectManipulationHandler(const DtEntityType&);

      virtual makVrv::DtElementEntry::ElementType mapKindToType(int) const;

      virtual void addKindToTypeMapping(int, const makVrv::DtElementEntry::ElementType&);

      virtual bool hasTypeToKindMapping(const makVrv::DtElementEntry::ElementType&) const;

      virtual void addObjectManipulationHandler(const makVrv::DtElementEntry::ElementType&, DtVrfObjectManipulationHandlerCreatorInterface*);
      virtual void removeObjectManipulationHandler(const makVrv::DtElementEntry::ElementType&);

      virtual bool isEditable(const makVrv::DtUniqueID&, const std::string& keywordsToCheck = "") const;
      virtual void setEditable(const makVrv::DtUniqueID&, bool);

      virtual bool hasKeyword(const std::string& keyword, makVrv::DtUniqueID id) const;

      virtual std::vector<DtVector> convertToLocal(const std::vector<DtVector>& geocentric) const;

      virtual bool isEditingOrCreating() const;
      virtual bool isBoxObject(const DtEntityType&, const std::string& keywords) const;


      virtual void createValidSelection(makVrv::DtSelectionManager::IdSet&, bool& changed) const;

      virtual DtVrfObjectManipulationHandlerBaseClass* manipulationHandlerFor(const DtEntityType&, const std::string& keywords) const;
      virtual DtVrfObjectManipulationHandlerBaseClass* manipulationHandlerFor(const makVrv::DtElementEntry::ElementType&) const;

      virtual bool isCreatingProp() const;

      virtual bool isDestroyingProp() const;
      virtual void setIsDestroyingProp(bool);

      virtual bool hasObjectFacade(makVrv::DtUniqueID) const;

   protected:

      virtual void slot_onCreationStopped(DtVrfObjectManipulationHandlerBaseClass*);

      virtual void slot_onEventProcessorRemoved(DtVrfObjectManipulationHandlerBaseClass*);

      virtual void slot_onTerrainPropCreationStopped(DtVrfObjectManipulationHandlerBaseClass*);

      virtual void slot_onCreateObject(const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&);

      virtual void slot_onCreateTerrainProp(const DtString& propType, const DtString& propModelDef);

      virtual void onInputDriverToBeDestroyed( makVrv::DtInputDriver* inputDriver );

      virtual void cleanup();

      virtual void onObjectFacadeCreated(DtVrfObjectFacadeInterface*, bool editing);

      virtual void onObjectFacadeAboutToBeRemoved(DtVrfObjectFacadeInterface*);

   public:

      virtual void mapEntityTypeToVertexEditingType(const DtEntityType& from, const DtEntityType& to);
      virtual DtEntityType mapToVertexEditingType(const DtEntityType& from) const;
      virtual void removeToVertexEditingType(const DtEntityType& from);

      virtual void createObject(const DtEntityType&, int force,DtCreationSignalType creationSignal = DtNoCreationSignal,
         const std::string& keywords = "");

      virtual void setLocation(const DtVector& loc);

      virtual void createTerrainProp(const DtString& propType, const DtString& propModelDef);

      virtual void stop();

   public:
      boost::signals2::signal<void (bool&)> signal_deleteSelected;

      boost::signals2::signal<void ()> signal_selectionRestored;

      boost::signals2::signal<void (int, DtEnvironmentStateView*, DtVector)> signal_aboutToDeletePoint;

      boost::signals2::signal<void (int, DtEnvironmentStateView*, DtVector&)> signal_aboutToAddPoint;

      boost::signals2::signal<void ()> signal_stopped;
      boost::signals2::signal<void (const DtEntityType&, int, makVrf::DtCreationSignalType)> signal_creatingObject;
      boost::signals2::signal<void (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&)> signal_createObject;

      boost::signals2::signal<void ()> signal_creatingTerrainProp;
      boost::signals2::signal<void (const DtString&, const DtString&)> signal_createTerrainProp;
       
      boost::signals2::signal<void (DtVrfObjectFacadeInterface*, bool)> signal_objectFacadeCreated;
      boost::signals2::signal<void (DtVrfObjectFacadeInterface*)> signal_objectFacadeAboutToBeRemoved;

      //Sent by event processor when an item is double clicked that does not have an object type to edit
      boost::signals2::signal<void (makVrv::DtElementID)> signal_unhandledEdit;

      boost::signals2::signal<void ()> signal_eventProcessorRemoved;
      
    public:


      virtual void setAllowEditing(bool b);
      virtual void setAllowEditingOf(AllowEditingOf);

      virtual bool allowEditing() const;
      virtual bool allowLocalObjectsEditing() const;
      virtual bool allowPublishedObjectsEditing() const;

      AllowEditingOf allowEditingOf() const { return myAllowEditingOf; };

      virtual void editSelectedObjects( const makVrv::DtUniqueID& principalID,
         makVrv::DtChannel& initiatingChannel, const DtEditingType& edtype=Mouse );

      virtual void editSelectedObjects( const makVrv::DtSelectionManager::IdSet& objects,
         makVrv::DtChannel& initiatingChannel, const DtEditingType& edtype=Mouse );
         
      virtual void setEditStartedByDoubleClick(bool);

      virtual void setCreationEndedWithDoubleClick(bool creationEndedWithDoubleClick);
      
      virtual bool isDoubleClickSupportedForCurrentObject() const;

      virtual bool isCurrentObjectValidForCreation();

      virtual void deleteSelected();  
      virtual void deleteProp(makVrv::DtUniqueID id);
      
      virtual void deleteVertex( const makVrv::DtUniqueID& vertexId );
      virtual void deleteVertex( const makVrv::DtUniqueID& shapeId, 
         const DtVector& dbLocation );
      
      virtual void addVertexBefore( const makVrv::DtUniqueID& vertexId );
      
      virtual void addVertexBefore( const makVrv::DtUniqueID& shapeId, 
         const DtVector& dbLocation );
         
      virtual void addVertexBeforeSelected();
      
      virtual void addVertexAfter( const makVrv::DtUniqueID& vertexId );
    
      virtual void addVertexAfter( const makVrv::DtUniqueID& shapeId, 
         const DtVector& dbLocation );
         
      virtual void addVertexAfterSelected();
      
      virtual int indexOfVertex( const DtEnvironmentStateView* shapeStateView, 
         const DtVector& dbVtxLocation ) const;
      
      virtual bool getVertexLocation( const makVrv::DtUniqueID& vertexId, 
         DtVector& dbLocation ) const;
         
      virtual void requestAndProcessEnvState( const makVrv::DtUniqueID& sceneId,
       ProcessEnvStateFunction* processor );
         
      virtual void setWaitTimeAfterComplete(double);
      virtual double waitTimeAfterComplete() const;
         
      virtual void setLocalWaitTimeAfterComplete(double);
      virtual double localWaitTimeAfterComplete() const;

      virtual double waitTimeAfterComplete(makVrv::DtUniqueID) const;

      virtual bool isEditing(makVrv::DtUniqueID id) const;

      virtual DtVrfObjectManipulationHandlerBaseClass* vertexEditingHandler(makVrv::DtUniqueID principalID) const;
      virtual DtVrfObjectManipulationHandlerBaseClass* editingHandlerFor(makVrv::DtUniqueID principalID) const;

      boost::signals2::signal<void (const makVrv::DtUniqueID&, DtEditingType)> signal_editingObject;
      boost::signals2::signal<void (DtEntityType, DtEditingType)> signal_editingObjectByEntityType;
      boost::signals2::signal<void (const makVrv::DtUniqueID&, DtEditingType)> signal_editingTerrainProp;
         
      boost::signals2::signal<void (const makVrv::DtSelectionManager::IdSet&, DtEditingType)> signal_editingObjects;
      boost::signals2::signal<void (const makVrv::DtSelectionManager::IdSet&, DtEditingType)> signal_editingTerrainProps;

      boost::signals2::signal<void ()> signal_editStopped;
      boost::signals2::signal<void ()> signal_editingNotAllowed;

   protected:
      
      virtual void slot_editStopped( DtVrfObjectManipulationHandlerBaseClass* );
      
      virtual void slot_stateReturned( DtEnvironmentStateView* shapeStateView, 
         const makVrv::DtUniqueID& shapeId, ProcessEnvStateFunction* processor  );
      
      virtual void deleteVertexUsingState( DtEnvironmentStateView* shapeStateView, 
         const makVrv::DtUniqueID& shapeId, const DtVector& dbVtxLocation );
         
      virtual void addVertexUsingState( DtEnvironmentStateView* shapeStateView, 
         const makVrv::DtUniqueID& shapeId, const DtVector& dbVtxLocation, bool before );
         
      virtual void sessionStatusChanged(int);

      virtual void restoreSelectionState( DtVrfObjectManipulationHandlerBaseClass* handler ); 
      
      virtual void slot_onTick();
      
      virtual void slot_onAttributesChanged( 
         const makVrv::DtElementAttributeManager::EntryAttributesList& signalList );
         
      virtual bool isOnIdList( makVrv::DtUniqueID id, 
         const makVrv::DtSelectionManager::IdSet& list );

      virtual void addHandlerToBeCleanedUp(DtVrfObjectManipulationHandlerBaseClass*);

      virtual void cacheVisibleObjects(const makVrv::DtSelectionManager::IdSet&);

   public:
      virtual bool canDeleteAPoint( DtEnvironmentStateView* shapeStateView ) const;
      virtual bool shapeAtMinimum( DtEnvironmentStateView* shapeStateView ) const;
      virtual bool shapeAtMaximum( DtEnvironmentStateView* shapeStateView ) const;

      virtual bool canEditVertex(const DtEntityType& t, makVrv::DtUniqueID parentID, makVrv::DtUniqueID vertexID) const;
      
   protected:
      makVrv::DtDe& myDe;
      VrfObjectManipulationCreators myManipulationHandlers;
      VertexEditingTypeMap myVertexEditingTypeMap;
      DtVrfObjectManipulationHandlerBaseClass* myCurrentObjectManipulationHandler;
      DtVrfEditManagerEventProcessor* myEventProcessor;
      bool myAlwaysCreateLocal;

      makVrv::DtSelectionManager::IdSet mySavedSelectionState;
      makVrv::DtSelectionManager::IdSet myRemainingSavedSelections;
      makVrv::DtSelectionManager::IdSet myObjectsEditing;
      makVrv::DtSelectionManager::IdSet myVisibleObjects;

      typedef boost::unordered_map<makVrv::DtUniqueID, bool> EditableMap;
      EditableMap myEditableMap;

      typedef boost::unordered_map<int, makVrv::DtElementEntry::ElementType> KindToTypeMap;
      KindToTypeMap myKindToTypeMap;

      typedef boost::unordered_map<makVrv::DtElementEntry::ElementType, DtVrfObjectManipulationHandlerCreatorInterface*> TypeCreatorMap;
      TypeCreatorMap myTypeCreators;

      double myWaitTimeAfterComplete;
      double myLocalWaitTimeAfterComplete;

      std::vector<DtVrfObjectManipulationHandlerBaseClass*> myHandlersToBeCleanedUp;

      AllowEditingOf myAllowEditingOf;

      makVrv::DtSignalConnectionManager myAnnouncerSignals;
      bool myIsDestroyingProp;
   };

   class DT_DLL_VRFGUICORE DtVrfObjectManipulationManagerCreator : 
      public makVrv::DtVirtualBaseClass
   {

   public:
      static DtVrfObjectManipulationManagerCreator& instance( makVrv::DtDe& de );

      static void registerInstance( makVrv::DtDe& de, 
         DtVrfObjectManipulationManagerCreator* instance);     
      
      virtual DtVrfObjectManipulationManager* create( makVrv::DtDe& de );
   };
}