2DRangeRingVisualizer.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/rangeRingVisualizer.h>
#include <vrvUtil/DtUnicode.h>
#include <vrfGuiCore/DtAttachableUpdaterWithLevelOrientationAgent.hpp>
#include <vrvUtil/DtUnitConverterCollection.h>
#include <matrix/vlVector.h>
#include <vrfGuiCore/vrfObjectDataState.h>

namespace makVrv
{
   class DtWidgetLabelAgent;
   class DtProjectedWidgetModelAgent;
   class DtVisualizerDefinition;
   class DtAttachableUpdaterAgent;
   class DtOverlaySegmentedLineModelAgent;
   class DtLineModelUpdaterAgent;
}

namespace makVrf
{
   class DtAttachableUpdaterWithLevelOrientationAgent;
   class DtVrfOverlayEllipseArcModelAgent;
   class DtAttackAnimationAgent;
   class DtRangeRingUpdaterAgent;

   class DT_DLL_VRFGUICORE Dt2DRangeRingVisualizer : public DtRangeRingVisualizer
   {
   protected:

      struct RingStructDrawingData2D : public RingStructDrawingData
      {
         RingStructDrawingData2D();
         virtual ~RingStructDrawingData2D();

         //This struct has separate instances of scene objects and updater agents for
         DtVrfOverlayEllipseArcModelAgent* myRangeRing;

         makVrv::DtSceneObjectAgent* myRingSceneObjectAgent;
         makVrv::DtSceneObjectAgent* myLineSceneObjectAgent;
         DtRangeRingUpdaterAgent* myRingUpdaterAgent;
         DtAttachableUpdaterWithLevelOrientationAgent* myLineUpdaterAgent;
         makVrv::DtOverlaySegmentedLineModelAgent* myVerticalLine;
         DtAttackAnimationAgent* myAttackAnimationAgent;

         //Label components
         makVrv::DtSceneObjectAgent* myLabelSceneObjectAgent;
         DtAttachableUpdaterWithLevelOrientationAgent* myLabelUpdaterAgent;
         makVrv::DtProjectedWidgetModelAgent* myLabelProjectedWidgetModelAgent;
         makVrv::DtWidgetLabelAgent* myLabel;
         std::vector<double> myWedgeSizes;
         unsigned int myStipplePattern;
      };

   public:

      Dt2DRangeRingVisualizer( makVrv::DtBaseConnection& connection,
         makVrv::DtStateListener& listener, int modelSet );

      virtual ~Dt2DRangeRingVisualizer();

      //connect method called in the creator class
      virtual void connect();
      
      //initialize method called in the creator class
      virtual void initialize_settings();

      virtual void setVisualizerDefinition( const makVrv::DtVisualizerDefinition& visDef );

      virtual void setWedgeSpacing(float);
      virtual float wedgeSpacing() const;
      //override of parent method - destroys all subordinate visualizers if turned off

      virtual const makVrv::DtStateVisualizer::TypeInfo& typeInfo() const;

      static const makVrv::DtStateVisualizer::TypeInfo& theTypeInfo();

      static const makVrv::DtVisualizerSchema& theDtRangeRingSchema();

   protected:
      virtual void updateRangeRingInformation(RingStruct& rangeItem);

      virtual void slot_displayUnitChanged(makVrv::DtUnitConverterCollection::DisplayUnitType, int, int);

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

      virtual void setRangeRingsLabels();

      virtual DtVrfOverlayEllipseArcModelAgent* create2DRingAgent(makVrv::DtSceneObjectAgent*);

      virtual void setAttackAnimationForRingEnabled(const std::string& ring, bool b);

      virtual void setRangeRingsFill( bool fill );
      virtual void destroyModelAgents();

   protected:
      virtual void updateRangeRingsCount(ShowFlags flags = ShowAll);

      virtual void updateScaleOfRings();

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

      virtual void destroyOuterRing(RingStruct&);

      virtual void setRangeRingGeometry(RingStruct&);

      virtual void setRangeRingColors(RingStruct&);

      virtual void setRangeRingLabels(RingStruct&);

      virtual void checkAndUpdateStipplePatternForRangeRing(const RingStruct&);
      virtual void updateStipplePatternsForRange(double);

   protected:
      std::string myFontFile;
      float myFontSizeUnscaled;

      float myWedgeSpacing;
      bool myFill;
   };
   //The creator class is normally templated in visualizers, but I want to split out the 

   class DT_DLL_VRFGUICORE DtRangeRingVisualizerCreator : public makVrv::DtStateVisualizerCreator
   {
   public:

      DtRangeRingVisualizerCreator();

      virtual ~DtRangeRingVisualizerCreator();

      virtual DtRangeRingVisualizerCreator* clone() const;

      virtual makVrv::DtStateVisualizer* create(makVrv::DtBaseConnection& simulation, makVrv::DtStateListener& listener, int modelSet) const;

      virtual const makVrv::DtStateVisualizer::TypeInfo& visualizerTypeInfo() const;

      virtual const std::string& tag();
  };

}