include/vrfGuiCore/DtRangeSphereVisualizer.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvCore/DtStateVisualizer.h>
#include <vrvUtil/DtUnicode.h>

namespace makVrv
{
   class DtEllipsoidArcModelAgent;
   class DtOverlaySegmentedLineModelAgent;
   class DtAttachableUpdaterAgent;
   class DtWidgetLabelAgent;
   class DtProjectedWidgetModelAgent;
}

namespace makVrf
{
   class DtEntityStateListenerExtensions;

   class DT_DLL_VRFGUICORE DtRangeSphereVisualizer : public makVrv::DtStateVisualizer
   {
   protected:
      struct SphereStruct
      {
         int myType;
         makVrv::DtEllipsoidArcModelAgent* myRangeSphere;
         makVrv::DtSceneObjectAgent* mySceneObjectAgent;
         makVrv::DtAttachableUpdaterAgent* myUpdater;
         makVrv::DtSceneObjectAgent* mySphereSceneObjectAgent;
         makVrv::DtAttachableUpdaterAgent* mySphereUpdater;
         makVrv::DtOverlaySegmentedLineModelAgent* myHeightLine;
      };

   public:

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

      virtual ~DtRangeSphereVisualizer();

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

      //connect method called in the destructor
      virtual void disconnect();

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

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

      virtual void setModelDefinitionForAgents();

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

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

      static const makVrv::DtVisualizerSchema& theDtRangeSphereSchema();
      
      virtual bool setVisible( bool onOff, int contextInt );//Override of parent class to ensure agreement between entity scene object and range ring
      virtual void setShowRangeSphere(bool); //reflects whether "Draw 3d Rings" checkbox is active
      virtual void setScale(float); //Scale is used solely to determine the width of the height line

   protected:

      virtual void tryToDraw();//checks whether the appropriate flags are set and then creates or destroys model agents as appropriate
      virtual void createModelAgents(); //overrides the base class method and tries to draw spheres contingent on settings
      virtual void destroyModelAgents();

      virtual SphereStruct addNewRangeSphere();
      virtual void destroyLastRangeSphere();

      virtual void setRangeSphereColors();
      virtual void slot_entityRangeRingsEnabled(const std::string& markingText, int setting);
      virtual void setRangeSphereGeometry();
      virtual void setRangeSphereCount( int );

   protected:
      std::vector<SphereStruct> myRangeSpheres;
      DtEntityStateListenerExtensions* myExtensions;
      bool myShowRangeSphere;
      bool myEntityRangeRingsEnabled;
      float myScale;
   };
   //The creator class is normally templated in visualizers, but I want to split out the 
   class DtRangeSphereVisualizerCreator: public makVrv::DtStateVisualizerCreator
   {
   public:

      DtRangeSphereVisualizerCreator();

      virtual ~DtRangeSphereVisualizerCreator();

      virtual DtRangeSphereVisualizerCreator* 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();
   };
}