//////////////////////////////////////////////////////////////////////////////
//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
/// \file Matrix3VertexAttribute.h
/// \brief Header file for Matrix3VertexAttribute.
///
//
//////////////////////////////////////////////////////////////////////////////
#ifndef __MATRIX3VERTEXATTRIBUTE_H__
#define __MATRIX3VERTEXATTRIBUTE_H__

#include <H3D/X3DVertexAttributeNode.h>
#include <H3D/MFMatrix3f.h>
#include <GL/glew.h>

namespace H3D {

  /// \ingroup X3DNodes
  /// \class Matrix3VertexAttribute
  /// Defines a set of per-vertex 3*3 matrix attributes.
  /// 
  /// The value field specifies an arbitrary collection of matrix values that 
  /// will be passed to the shader as per-vertex information.
  ///
  /// <b>Examples:</b>
  ///   - <a href="../../../H3DAPI/examples/All/VertexAttributes1.x3d">VertexAttributes1.x3d</a>
  ///     ( <a href="examples/VertexAttributes1.x3d.html">Source</a> )
  class H3DAPI_API Matrix3VertexAttribute: public X3DVertexAttributeNode {
  public:
    /// Constructor.
    Matrix3VertexAttribute( Inst< SFNode     > _metadata = 0,
                            Inst< SFString   > _name     = 0,
                            Inst< MFMatrix3f > _value    = 0);

    /// Destructor
    virtual ~Matrix3VertexAttribute();
   
    /// Perform the OpenGL commands to set the vertex attribute
    /// with the given index. value_index is the index of the 
    /// value in the value field that is to be used.
    virtual void render( int value_index );

    /// Perform the OpenGL commands to set the vertex attributes
    /// as a an vertex attribute array on the attribute with the 
    /// given index.
    virtual void renderArray();

    /// Disable the array state enabled in renderArray().
    virtual void disableArray();

    /// Implement the method to specify data and releated information
    virtual void setAttributeData ( );

    /// VBO rendering implementation
    virtual void renderVBO ( );

    /// VBO disabling implementation
    virtual void disableVBO ( );

    /// Check if this vertex attribute needs to be rendered
    virtual bool preRenderCheckFail ( );

    /// The value field specifies an arbitrary collection of Matrix3f values 
    /// that will be passed to the shader as per-vertex information.
    /// 
    /// <b>Access type:</b> inputOutput \n
    auto_ptr< MFMatrix3f >  value;

    /// The H3DNodeDatabase for this node.
    static H3DNodeDatabase database;
  };
}

#endif
