include/vrvCore/DtChannelCompass.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2010 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
/****************************************************************************** 
** $RCSfile: DtChannelCompass.h,v $ $Revision: 1.0 $ $State: Exp $ 
******************************************************************************/ 
 
 
#pragma once
 
#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>

#include <string>
 
namespace makVrv 
{
   class DtDe;
   class DtChannelCompassInstance;

   class DT_DLL_VRVCORE DtChannelCompass
   {
   public:

      DtChannelCompass(DtDe& de, DtUniqueID id);

      virtual ~DtChannelCompass();
      
      enum Locations
      {
         Top = 0,
         TopRight,
         Right,
         BottomRight,
         Bottom,
         BottomLeft,
         Left,
         TopLeft,
         Center
      };
      
      virtual void setInstance(DtChannelCompassInstance* instance);

      virtual DtChannelCompassInstance* instance();

      virtual void setVisible(bool isVisible);
      
      void setChannelName( const std::string& deName, 
         const std::string& winName, const std::string& channelName );
      
      void setCompassHeading( double heading );

      void setModelDefinition( const std::string& modelDefinition );
      
      void setLocation( unsigned int location );
      
      unsigned int location() const;
      
      void setMargins( unsigned int xMargin, unsigned int yMargin );
      
      void setNorthLetterFilename( const std::string& filename );
      
      void setSouthLetterFilename( const std::string& filename );
      
      void setEastLetterFilename( const std::string& filename );
      
      void setWestLetterFilename( const std::string& filename );
      
      void setCompassRadius( unsigned int radius );
      
      void setNorthLetterSize( unsigned int width, unsigned int height );
      
      void setSouthLetterSize( unsigned int width, unsigned int height );
      
      void setEastLetterSize( unsigned int width, unsigned int height );
      
      void setWestLetterSize( unsigned int width, unsigned int height );

      void showSmallTickMarks( bool show );

      void setDarkTickColor( float r, float g, float b, float a );

      void setLightTickColor( float r, float g, float b, float a );
     
   protected:
      DtChannelCompassInstance* myInstance;
   }; 
}