include/vrvCore/DtChannelCompassInstance.h

Go to the documentation of this file.

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

#include <vrvCore/DtChannelCompass.h>
#include <vrvCore/DtSetVisibilityInterface.h>

 
namespace makVrv 
{
   class DT_DLL_VRVCORE DtChannelCompassInstance : public DtSetVisibilityInterface
   {
   public:
   
      DtChannelCompassInstance();
      
      virtual ~DtChannelCompassInstance();
      
      virtual void setChannelName( const std::string& deName, 
         const std::string& winName, const std::string& channelName );
         
      virtual void setCompassHeading( double heading );
      
      virtual void setModelDefinition( const std::string& modelDefinition );
      
      virtual void setLocation( DtChannelCompass::Locations location );
      
      DtChannelCompass::Locations location() const;

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

      virtual void showSmallTickMarks( bool show );

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

      virtual void setLightTickColor( float r, float g, float b, float a );

      virtual void updateCompass( bool force=false ) = 0;

      
   protected:
      std::string myModelDefinitionName;
      std::string myDisplayEngineName;
      std::string myWindowName;
      std::string myChannelName;
      DtChannelCompass::Locations myLocation;
      unsigned int myMargins[2];
      std::string myNorthLetterFilename;
      std::string mySouthLetterFilename;
      std::string myEastLetterFilename;
      std::string myWestLetterFilename;
      unsigned int myCompassRadius;
      double myCompassHeading;
      unsigned int myNorthLetterSize[2];
      unsigned int mySouthLetterSize[2];
      unsigned int myEastLetterSize[2];
      unsigned int myWestLetterSize[2];
      float myDarkTickColor[4];
      float myLightTickColor[4];
      bool myShowSmallTickMarks;
   }; 
}