DtEntityList.h

Go to the documentation of this file.

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

//\file DtEntityList.h
//\brief Contains makVrf::makVrfEntityListExample::DtEntityList class.

#pragma once

#include <vrvUtil/signalslib.h>

#include "entityListUi.hpp"

#include <vrvCoreQt/DtDockable.h>
#include <vrvCoreQt/DtPage.h>
#include <vrvCore/DtUserInterfaceAssembler.h>
#include <vrvCore/DtStateViewCollection.h>
#include <vrfGuiCore/DtVrfStateViewCollectionManager.h>
#include <vrftasks/simTask.h>

namespace makVrv
{
   class DtDe;
}

namespace makVrfEntityListExample
{

   //A widget class that displays all existing entities
   //as well as their current task and, if available, their destination.
   class DtEntityList
      : public makVrv::DtPage
      , public makVrv::DtDockable
   {
   public:
      DtEntityList( makVrv::DtDe& de, QWidget* parent = 0, Qt::WindowFlags flags = 0);

      virtual ~DtEntityList();

      //Get the icon of the page.
      virtual QIcon icon();

      //Get the title of the page.
      virtual QString title();

      //Get the class name of the page.
      virtual const std::string& pageClassName() const;

      //Called when the page is displayed.
      virtual void activate();

      //Called when the page is hidden.
      virtual void deactivate();

      static std::string thePageClassName();

      //Goes through the entire list of entities and populates the tree
      virtual void populateEntityList();

   protected:
      //Sets up the contents of the widget onto the supplied parent
      void setupUi(QWidget* p);

      //Clears out widget
      virtual void clear();


   protected:
      virtual void slot_onObjectAdded(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>&);
      virtual void slot_onObjectUpdated(makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>*);
      virtual void slot_onObjectAboutToBeRemoved(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>&);
      virtual void slot_onCurrentTaskChanged(const std::string& entityName);

      //Using the known task, fill in the destination line in the entity list
      void fillDestinationLine(DtSimTask* task,QTreeWidgetItem* displayEntityItem);

   public:
      Ui_DtEntityListUi myUi;

      //A list of all simulated entities.
      //Each State View is a collection of similar objects
      //that the VR-Forces front end knows about. This particular view
      //keeps a list of all simulated entities.
      makVrf::DtVrfSimulatedEntityStateViewCollection* mySimulatedEntityStateView;

      //This maps keeps track of each line in the target list
      std::map<const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>*, QTreeWidgetItem*> myLineToStateViewMap;
   };

   //Create a "creator" helper class using the template.
   typedef makVrv::DtPageCreatorTemplate<DtEntityList> DtEntityListWidgetCreator;
}