rangeRingVisualizer.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/DtStateVisualizer.h>
#include <vrvUtil/DtUnicode.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrfGuiCore/DtAttachableUpdaterWithLevelOrientationAgent.hpp>
#include <vrvUtil/DtUnitConverterCollection.h>
#include <matrix/vlVector.h>
#include <vrfutil/rwUUID.h>
#include <vrfExtProtocol/rangeItem.h>

#include <boost/signals2.hpp>

#include <map>
#include <set>

namespace makVrf
{
   #define DtRangeRingKey(name, index)( DtString(name) + DtString("_") + DtString(index))

   class DtCommonStateListenerExtensions;

   class DT_DLL_VRFGUICORE DtRangeRingVisualizer : public makVrv::DtStateVisualizer
   {
   protected:
      enum ShowFlags
      {
         ShowNone = 0,
         ShowAll = 0x00000001,
         ShowPhysicalFootprintOnly = 0x00000002
      };

      struct RingStructDrawingData
      {
         RingStructDrawingData() {};
         virtual ~RingStructDrawingData() {};
      };

      struct RingStruct
      {
         RingStruct() : myExtensionIndex(0), myVisible(true), myRange(0.), myDrawingData(0)
         {
            myColor[0] = myColor[1] = myColor[2] = myColor[3] = 0.;
         };

         virtual ~RingStruct() {};

         int myExtensionIndex;
         bool myVisible;
         std::vector<double> myWedgeSizes;
         float myColor[4];
         double myRange;
         makVrv::DtUnicode myLabelText;
         DtVector myOffsetPosition;
         std::string myKey;

         RingStructDrawingData* myDrawingData;
      };

   public:

      DtRangeRingVisualizer( makVrv::DtBaseConnection& connection,
         makVrv::DtStateListener& listener, makVrv::DtSceneObjectAgent*, makVrv::DtModelSetId modelSet );

      virtual ~DtRangeRingVisualizer() override;
      
      //initialize method called in the creator class
      virtual void initialize_settings();

      virtual void setModelDefinitionForAgents() override;

      //override of parent method - destroys all subordinate visualizers if turned off
      virtual void implementVisibility(bool visible) override;

      virtual void destroyModelAgents() override;

   protected:
      virtual std::string rangeRingKey(const DtRangeItem& rangeItem, int extensionIndex) const;
      virtual void initialize() override;

      virtual void getColor(unsigned int color, float& r, float& g, float& b, float& a) const;

      virtual void createModelAgents() override;

      virtual void tryToDraw();

      virtual void updateRangeRingsCount(ShowFlags flags = ShowAll);

      virtual void setRangeRingsScale(float);

      virtual void updateRangeRingInformation(RingStruct&);
      virtual void updateRangeRingsInformation();

      virtual void setRangeRingsGeometry();
      virtual void setRangeRingsColors();

      virtual void slot_entityRangeRingsEnabled(const DtUUID&, int setting);
      virtual void slot_selectionDisplayAvailableChangedFor(int setting);

      virtual void slot_setSelected(bool) override;
      virtual void displayScaleChanged(double oldScale, double newScale);

   protected:

      virtual void updateScaleOfRings() = 0;

      //Creates a new set of ring visualizers, populates a struct and adds it to myRangeRings
      virtual void createRing(const DtRangeItem&, int extensionIndex) = 0;

      //After a ring is created, update the ring with options specific to this visualizer
      virtual void updateRingOptions(RingStruct&) = 0;

      virtual void destroyOuterRing(RingStruct&) = 0;

      virtual void setRangeRingGeometry(RingStruct&) = 0;

      virtual void setRangeRingColors(RingStruct&) = 0;

   protected:
      typedef std::map<std::string, RingStruct> RangeRings;
      RangeRings myRangeRings;

      DtCommonStateListenerExtensions* myExtensions;
      float myScale;

      bool myEntityRangeRingsEnabled;

      typedef std::map<double, std::set<std::string> > RangeRingRanges;
      RangeRingRanges myRangeRingRanges;

      typedef std::map<int, makVrv::DtUnicode> LabelText;
      LabelText myLabelText;

      bool mySettingsInitialized;
      boost::signals2::scoped_connection myTurnOffIfSelectedConnection;
   };
}