DrawModes.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 8638 $                                                       *
 *   $Author: kremer $                                                      *
 *   $Date: 2010-03-02 13:53:02 +0100 (Di, 02. Mär 2010) $                   *
 *                                                                           *
\*===========================================================================*/




//=============================================================================
//
//  CLASS DrawModes
//
//=============================================================================

#ifndef ACG_DRAWMODES_HH
#define ACG_DRAWMODES_HH


//== FORWARD DECLARATIONS =====================================================


namespace ACG 
{
  namespace SceneGraph 
  {
    class BaseNode;
  }
}


//== INCLUDES =================================================================

#include <string>
#include <vector>
#include "../Config/ACGDefines.hh"
#include <bitset>

// Avoid compiler warning in MSC
#if defined (_MSC_VER)
#   pragma warning (disable:4251)
#endif

//== NAMESPACES ===============================================================


namespace ACG {
namespace SceneGraph {

namespace DrawModes {

  typedef std::bitset<64> ModeFlagSet;

  class ACGDLLEXPORT DrawMode {
    public:
      
      DrawMode(); 
      
      DrawMode(unsigned int _index); 
      
      DrawMode( ModeFlagSet _flags );
      
      bool operator==(const DrawMode& _mode) const;
      
      DrawMode operator&(const DrawMode& _mode);
      
      DrawMode& operator++();
      
      DrawMode& operator|=( const DrawMode& _mode2  );
      
      DrawMode& operator&=( const DrawMode& _mode2  );
      
      bool operator!=( const DrawMode& _mode2  ) const;
      
      DrawMode operator|( const DrawMode& _mode2  ) const;
      
      DrawMode operator^( const DrawMode& _mode2  ) const;
      
      DrawMode operator~( ) const;
      
      unsigned int getIndex();
      
      std::string description();
      
      bool isAtomic();
      
      bool containsAtomicDrawMode( DrawMode _atomicDrawMode );
      
      std::vector< DrawMode > getAtomicDrawModes();
      
      unsigned int maxModes();
      
      operator bool();
      
    private:
      ModeFlagSet modeFlags_;
  };
  
  
  DrawMode const NONE           = ModeFlagSet(0);
  DrawMode const DEFAULT        = ModeFlagSet(1);
  
  //======================================================================
  //  Point Based Rendering Modes
  //======================================================================
  DrawMode const POINTS         = ModeFlagSet(1) << 1;
  DrawMode const POINTS_COLORED = ModeFlagSet(1) << 2;
  DrawMode const POINTS_SHADED  = ModeFlagSet(1) << 3;
  
  //======================================================================
  //  Edge Based Rendering Modes
  //======================================================================
  DrawMode const EDGES          = ModeFlagSet(1) << 4;
  
  DrawMode const WIREFRAME      = ModeFlagSet(1) << 5;
  
  //======================================================================
  //  Face Based Rendering Modes
  //======================================================================  
  DrawMode const FACES          = ModeFlagSet(1) << 6;



  DrawMode const HIDDENLINE     = ModeFlagSet(1) << 7;
  DrawMode const SOLID_FLAT_SHADED = ModeFlagSet(1) << 8;
  DrawMode const SOLID_SMOOTH_SHADED = ModeFlagSet(1) << 9;
  DrawMode const SOLID_PHONG_SHADED = ModeFlagSet(1) << 10;
  DrawMode const SOLID_FACES_COLORED = ModeFlagSet(1) << 11;
  DrawMode const SOLID_POINTS_COLORED = ModeFlagSet(1) << 12;
  DrawMode const SOLID_ENV_MAPPED = ModeFlagSet(1) << 13;
  DrawMode const SOLID_TEXTURED = ModeFlagSet(1) << 14;
  DrawMode const SOLID_TEXTURED_SHADED = ModeFlagSet(1) << 15;
  DrawMode const SOLID_1DTEXTURED = ModeFlagSet(1) << 16;
  DrawMode const SOLID_1DTEXTURED_SHADED = ModeFlagSet(1) << 17;
  DrawMode const SOLID_3DTEXTURED = ModeFlagSet(1) << 18;
  DrawMode const SOLID_3DTEXTURED_SHADED = ModeFlagSet(1) << 19;
  DrawMode const SOLID_FACES_COLORED_FLAT_SHADED = ModeFlagSet(1) << 20;
  DrawMode const SOLID_2DTEXTURED_FACE = ModeFlagSet(1) << 21;
  DrawMode const SOLID_2DTEXTURED_FACE_SHADED = ModeFlagSet(1) << 22;
  DrawMode const SOLID_SHADER = ModeFlagSet(1) << 23;
  DrawMode const UNUSED = ModeFlagSet(1) << 24;
  

  //=======================================================================
  // Non Member Functions
  //=======================================================================
  
  ACGDLLEXPORT 
  void initializeDefaultDrawModes( void );

  ACGDLLEXPORT 
  bool addDrawMode( const std::string & _name, DrawMode & _newId );

  ACGDLLEXPORT 
  bool getDrawMode( const std::string & _name, DrawMode & _Id  );
  
  ACGDLLEXPORT   
  bool drawModeExists(const std::string & _name);
  
  ACGDLLEXPORT 
  DrawMode getDrawModeFromIndex( unsigned int _index );

//=============================================================================
} // namespace DrawModes
} // namespace SceneGraph
} // namespace ACG
//=============================================================================
#endif // ACG_DRAWMODES_HH defined
//=============================================================================