VertexDeclaration.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
 *                                                                           *
\*===========================================================================*/




#ifndef ACG_VERTEXDECLARATION_HH
#define ACG_VERTEXDECLARATION_HH

#include <vector>
#include <list>
#include <map>
#include <QString>
#include <ACG/Config/ACGDefines.hh>

namespace GLSL
{
  class Program;
}

namespace ACG
{

enum VERTEX_USAGE
{                               
  VERTEX_USAGE_POSITION = 0,    
  VERTEX_USAGE_NORMAL,          
  VERTEX_USAGE_TEXCOORD,        
  VERTEX_USAGE_COLOR,           
  VERTEX_USAGE_BLENDWEIGHTS,    
  VERTEX_USAGE_BLENDINDICES,    
  VERTEX_USAGE_SHADER_INPUT,    
  VERTEX_USAGE_FORCE_DWORD = 0xFFFFFFFF
};

struct ACGDLLEXPORT VertexElement
{
  VertexElement();

  unsigned int type_;           
  unsigned int numElements_;    
  VERTEX_USAGE usage_;          
  const char* shaderInputName_; 
  const void* pointer_;         
  unsigned int divisor_;        
  unsigned int vbo_;            

  void setByteOffset(unsigned int _offset);

  unsigned int getByteOffset() const;

  bool operator == (const VertexElement& _other) const;

  bool operator != (const VertexElement& _other) const {return !(*this == _other);}
};

class ACGDLLEXPORT VertexDeclaration
{
public:

  VertexDeclaration();
  ~VertexDeclaration();

  void addElement(const VertexElement* _pElement);

  void addElement(unsigned int _type, unsigned int _numElements, VERTEX_USAGE _usage, const void* _pointer, const char* _shaderInputName = 0, unsigned int _divisor = 0, unsigned int _vbo = 0);
  
  void addElement(unsigned int _type, unsigned int _numElements, VERTEX_USAGE _usage, size_t _byteOffset = 0, const char* _shaderInputName = 0, unsigned int _divisor = 0, unsigned int _vbo = 0);

  void addElements(unsigned int _numElements, const VertexElement* _pElements);

  void clear();

  void activateFixedFunction() const;

  void deactivateFixedFunction() const;


  void activateShaderPipeline(GLSL::Program* _prog) const;


  void deactivateShaderPipeline(GLSL::Program* _prog) const;


  void setVertexStride(unsigned int _stride);

  unsigned int getVertexStride(unsigned int i = 0) const;

  unsigned int getNumElements() const;

  const VertexElement* getElement(unsigned int i) const;

  int findElementIdByUsage(VERTEX_USAGE _usage) const;

  const VertexElement* findElementByUsage(VERTEX_USAGE _usage) const;

  static size_t getGLTypeSize(unsigned int _type);

  static size_t getElementSize(const VertexElement* _pElement);

  static bool supportsInstancedArrays();

  QString toString() const;


  bool operator ==(const VertexDeclaration& _other) const;

  bool operator !=(const VertexDeclaration& _other) const {return !(*this == _other);}

private:

  void updateOffsets();

  void updateShaderInputName(VertexElement* _pElem);


  std::vector<VertexElement> elements_;

  unsigned int vertexStride_;

  std::map<unsigned int, unsigned int> vertexStridesVBO_;

  int strideUserDefined_;
};


//=============================================================================
} // namespace ACG
//=============================================================================



#endif // ACG_VERTEXDECLARATION_HH defined