LineNode.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.              *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                       *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/




//=============================================================================
//
//  CLASS LineNode
//
//=============================================================================


#ifndef ACG_LINENODE_HH
#define ACG_LINENODE_HH


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

#include <ACG/Scenegraph/MaterialNode.hh>
#include "DrawModes.hh"
#include <ACG/GL/VertexDeclaration.hh>
#include <vector>
#include <limits>

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

namespace ACG {
namespace SceneGraph {

//== CLASS DEFINITION =========================================================



class ACGDLLEXPORT LineNode : public MaterialNode
{
public:

  // typedefs
  typedef ACG::Vec3uc                    Color;
  typedef ACG::Vec4f                     Color4f;
  typedef std::vector<Vec3d>             PointVector;
  typedef PointVector::iterator          PointIter;
  typedef PointVector::const_iterator    ConstPointIter;
  typedef std::vector<ACG::Vec3uc>       ColorVector;
  typedef ColorVector::iterator          ColorIter;
  typedef ColorVector::const_iterator    ConstColorIter;
  typedef std::vector<Color4f>           Color4fVector;
  typedef Color4fVector::iterator        Color4fIter;
  typedef Color4fVector::const_iterator  ConstColor4fIter;

  enum LineMode { LineSegmentsMode, PolygonMode };



  LineNode( LineMode     _mode,
                  BaseNode*    _parent=0,
                  std::string  _name="<LineNode>" );

  ~LineNode();

  void set_line_mode(LineMode _mode);


  ACG_CLASSNAME(LineNode);

  DrawModes::DrawMode  availableDrawModes() const;

  void boundingBox(Vec3d& _bbMin, Vec3d& _bbMax);
  
  
  void enter(GLState& _state, const DrawModes::DrawMode& _drawMode);

  void draw(GLState& _state, const DrawModes::DrawMode& _drawMode);
  
  void leave(GLState& _state, const DrawModes::DrawMode& _drawMode);

  void pick(GLState&  _state , PickTarget _target);

  void reserve_lines(unsigned int _n) { points_.reserve(2*_n); }

  void reserve_points(unsigned int _n) { points_.reserve(_n); }

  void clear();

  void clear_points();

  void clear_colors();
  
  void set_color(const Vec4f& _c);

  void add_point(const Vec3d& _v);

  void add_line(const Vec3d& _v0, const Vec3d& _v1);

  void add_color(const ACG::Vec3uc& _c);

  void add_color(const Color4f _c);

  void set_picking_line_width(float _width) { picking_line_width_ = _width; }
  float picking_line_width() const
  {
      return (picking_line_width_ != std::numeric_limits<float>::infinity()) ? picking_line_width_ : line_width();
  }

  size_t n_points() const { return points_.size(); }

  const PointVector& points() const { return points_; }

  ColorVector& colors() { return colors_; }
  
  bool& alwaysOnTop() { updateVBO_ = true; return draw_always_on_top;  }

  void updateVBO() { updateVBO_ = true; };

  void push_back(const Vec3d& _v) { points_.push_back(_v); updateVBO_ = true; }
  typedef Vec3d         value_type;
  typedef Vec3d&        reference;
  typedef const Vec3d&  const_reference;

  void getRenderObjects(IRenderer* _renderer, GLState&  _state , const DrawModes::DrawMode&  _drawMode , const ACG::SceneGraph::Material* _mat);

protected:

  void pick_vertices(GLState& _state);
  void pick_edges (GLState& _state, unsigned int _offset);

  void createVBO();

  float picking_line_width_;

  PointVector   points_;
  ColorVector   colors_;
  Color4fVector colors4f_;

  LineMode     line_mode_;
  
  bool         draw_always_on_top;
  GLint        prev_depth_;

  // Vertex buffer object used in this node
  unsigned int vbo_;

  // True if points changed and the vbo has to be updated
  bool         updateVBO_;

  ACG::VertexDeclaration vertexDecl_;

  std::string lineNodeName_;

};


//=============================================================================
} // namespace SceneGraph
} // namespace ACG
//=============================================================================
#endif // ACG_LINENODE_HH defined
//=============================================================================