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




//=============================================================================
//
// CLASS PolyLineT
//
// Author:  David Bommes <bommes@cs.rwth-aachen.de>
//
//=============================================================================


#ifndef ACG_POLYLINET_HH
#define ACG_POLYLINET_HH


//== INCLUDES =================================================================
#include <vector>
#include <iostream>
#include <ACG/Config/ACGDefines.hh>
#include <OpenMesh/Core/Utils/PropertyManager.hh>
#include <OpenMesh/Core/Utils/Property.hh>

//== FORWARDDECLARATIONS ======================================================

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

namespace ACG {

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




template <class PointT>
class PolyLineT
{
public:

  // internal relevant Types
  typedef PointT                      Point;
  typedef typename Point::value_type  Scalar;

  explicit PolyLineT(bool _closed = false );

  PolyLineT(const PolyLineT& _line);

  ~PolyLineT() {clear();}

  bool is_closed() const         { return closed_;}

  void set_closed(const bool _c) { closed_ = _c;}

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

  size_t n_edges() const;

  void clear();

  void resize( unsigned int _n);

  void add_point(const Point& _p);

  void insert_point(int _idx, const Point& _p);

  void delete_point(int _idx);


  Point& point(unsigned int _i)       { return points_[_i];}

  const Point& point(unsigned int _i) const { return points_[_i];}

  std::vector<Point>& points()       { return points_;}

  const std::vector<Point>& points() const { return points_;}

  Point& front()       { return points_.front();}

  const Point& front() const { return points_.front();}

  Point& back()       { return points_.back();}

  const Point& back() const { return points_.back();}

  Point edge_vector(unsigned int _i) const 
  { return(point((_i+1)%n_vertices())-point(_i));}

  Scalar length() const;

  Point position(const Scalar _t) const;

  Point position_arclength(const Scalar _t) const;

  void resample_arclength_uniform(const unsigned int _n);

  void subdivide( Scalar _largest  );

  void collapse ( Scalar _smallest );

  void invert();

  void append(const PolyLineT<PointT>& _pl);

  void prepend(const PolyLineT<PointT>& _pl);

  void split_closed( unsigned int _split_idx);

  void split( unsigned int _split_idx, PolyLineT<PointT>& _new_pl);

  void remove_subsequent_identical_points( const bool _keep_edge_vertices = false, const double _epsilon = 1e-6 );

  void smooth_uniform_laplace();

  void smooth_uniform_laplace2();

  void smooth_uniform_laplace3();


  void set_to_circle(const PointT _center, const PointT _normal, double _radius, unsigned int _n_samples = 100);

  template <class MeshT, class SpatialSearchT>
  void project_to_mesh( const MeshT&     _mesh,
                        SpatialSearchT*  _ssearch = 0);

  template <class MeshT, class SpatialSearchT>
  void project_to_mesh( const std::vector<MeshT*>&    _mesh,
                                          std::vector<SpatialSearchT*>* _ssearch = 0);

  template <class MeshT, class SpatialSearchT>
  bool on_multiple_components(MeshT &_mesh,
                              SpatialSearchT &_ssearch);

  template <class MeshT, class SpatialSearchT>
  void split_into_one_per_component(MeshT &_mesh,
                                    SpatialSearchT &_ssearch,
                                    std::vector<PolyLineT> &out_polylines);

  // This Block is used to pull in extended PolyLine features such as integration of
  // a PolyLine into a Mesh. Currently this code is not included in the free version.
  #ifdef EXTENDED_POLY_LINE
    #include <libs/MeshIntegration/PolyLineIntegrationT.hh>
  #endif


  Scalar total_gaussian_curvature();

  template <class LineNodeT>
  LineNodeT* get_line_node( LineNodeT*& _line_node, int _mode = 0);

  template <class LineNodeT>
  void set_line_node( LineNodeT*& _line_node, int _mode = 0);

  void print() const;

  Scalar vertex_radius() const { return vertex_radius_;}

  void set_vertex_radius(const Scalar _r) { vertex_radius_ = _r;}

  Scalar edge_radius() const { return edge_radius_;}

  void set_edge_radius(const Scalar _r) { edge_radius_ = _r;}


  //  ############################### Standard Property Handling #############################

  // request properties
  void request_vertex_normals()    { request_prop( ref_count_vnormals_   , vnormals_);}
  void request_vertex_binormals()  { request_prop( ref_count_vbinormals_ , vbinormals_);}
  void request_vertex_colors()     { request_prop( ref_count_vcolors_    , vcolors_ );}
  void request_vertex_scalars()    { request_prop( ref_count_vscalars_   , vscalars_);}
  void request_vertex_selections() { request_prop( ref_count_vselections_, vselections_);}
  void request_vertex_vhandles()   { request_prop( ref_count_vvhandles_  , vvhandles_);}
  void request_vertex_ehandles()   { request_prop( ref_count_vehandles_  , vehandles_);}
  void request_vertex_fhandles()   { request_prop( ref_count_vfhandles_  , vfhandles_);}

  void request_edge_normals()      { request_prop( ref_count_enormals_   , enormals_);}
  void request_edge_colors()       { request_prop( ref_count_ecolors_    , ecolors_ );}
  void request_edge_scalars()      { request_prop( ref_count_escalars_   , escalars_);}
  void request_edge_selections()   { request_prop( ref_count_eselections_, eselections_);}
  void request_preimage_directions()   { request_prop( ref_count_epreimage_direction_, epreimage_direction_);}

  // release properties
  void release_vertex_normals()    { release_prop( ref_count_vnormals_   , vnormals_);}
  void release_vertex_binormals()  { release_prop( ref_count_vbinormals_ , vbinormals_);}
  void release_vertex_colors()     { release_prop( ref_count_vcolors_    , vcolors_ );}
  void release_vertex_scalars()    { release_prop( ref_count_vscalars_   , vscalars_);}
  void release_vertex_selections() { release_prop( ref_count_vselections_, vselections_);}
  void release_vertex_vhandles()   { release_prop( ref_count_vvhandles_  , vvhandles_);}
  void release_vertex_ehandles()   { release_prop( ref_count_vehandles_  , vehandles_);}
  void release_vertex_fhandles()   { release_prop( ref_count_vfhandles_  , vfhandles_);}

  void release_edge_normals()      { release_prop( ref_count_enormals_   , enormals_);}
  void release_edge_colors()       { release_prop( ref_count_ecolors_    , ecolors_ );}
  void release_edge_scalars()      { release_prop( ref_count_escalars_   , escalars_);}
  void release_edge_selections()   { release_prop( ref_count_eselections_, eselections_);}
  void release_preimage_directions()   { release_prop( ref_count_epreimage_direction_, epreimage_direction_);}

  // property availability
  bool vertex_normals_available()    const {return (ref_count_vnormals_    != 0 ); }
  bool vertex_binormals_available()  const {return (ref_count_vbinormals_  != 0 ); }
  bool vertex_colors_available()     const {return (ref_count_vcolors_     != 0 ); }
  bool vertex_scalars_available()    const {return (ref_count_vscalars_    != 0 ); }
  bool vertex_selections_available() const {return (ref_count_vselections_ != 0 ); }
  bool vertex_vhandles_available()   const {return (ref_count_vvhandles_   != 0 ); }
  bool vertex_ehandles_available()   const {return (ref_count_vehandles_   != 0 ); }
  bool vertex_fhandles_available()   const {return (ref_count_vfhandles_   != 0 ); }

  bool edge_normals_available()      const {return (ref_count_enormals_    != 0 ); }
  bool edge_colors_available()       const {return (ref_count_ecolors_     != 0 ); }
  bool edge_scalars_available()      const {return (ref_count_escalars_    != 0 ); }
  bool edge_selections_available()   const {return (ref_count_eselections_ != 0 ); }
  bool edge_preimage_directions_available()   const {return (ref_count_epreimage_direction_ != 0 ); }

  // property access ( no range or availability check! )
        Point& vertex_normal(unsigned int _i)       { return vnormals_[_i];}
  const Point& vertex_normal(unsigned int _i) const { return vnormals_[_i];}
  
        Point& vertex_binormal(unsigned int _i)       { return vbinormals_[_i];}
  const Point& vertex_binormal(unsigned int _i) const { return vbinormals_[_i];}

        Point & vertex_color(unsigned int _i)       { return vcolors_[_i];}
  const Point & vertex_color(unsigned int _i) const { return vcolors_[_i];}

        Scalar& vertex_scalar(unsigned int _i)       { return vscalars_[_i];}
  const Scalar& vertex_scalar(unsigned int _i) const { return vscalars_[_i];}

        unsigned char& vertex_selection(unsigned int _i)       {return vselections_[_i];}
  const unsigned char& vertex_selection(unsigned int _i) const {return vselections_[_i];}

        int& vertex_vhandle(unsigned int _i)       {return vvhandles_[_i];}
  const int& vertex_vhandle(unsigned int _i) const {return vvhandles_[_i];}

        int& vertex_ehandle(unsigned int _i)       {return vehandles_[_i];}
  const int& vertex_ehandle(unsigned int _i) const {return vehandles_[_i];}

        int& vertex_fhandle(unsigned int _i)       {return vfhandles_[_i];}
  const int& vertex_fhandle(unsigned int _i) const {return vfhandles_[_i];}

        Point& edge_normal(unsigned int _i)       { return enormals_[_i];}
  const Point& edge_normal(unsigned int _i) const { return enormals_[_i];}

        Point & edge_color(unsigned int _i)       { return ecolors_[_i];}
  const Point & edge_color(unsigned int _i) const { return ecolors_[_i];}

        Scalar& edge_scalar(unsigned int _i)       { return escalars_[_i];}
  const Scalar& edge_scalar(unsigned int _i) const { return escalars_[_i];}

        unsigned char& edge_selection(unsigned int _i)       {return eselections_[_i];}
  const unsigned char& edge_selection(unsigned int _i) const {return eselections_[_i];}

        Point & preimage_direction(unsigned int _i)       { return epreimage_direction_[_i];}
  const Point & preimage_direction(unsigned int _i) const { return epreimage_direction_[_i];}


  //  ############################### Custom Property Handling #############################

  /* 
  A custom property is identified by its name and requires the size in bytes of one property element (example: float3 prop has size 12).
  PolyLine allocates an internal buffer for properties, so no buffer management is required.
  On resize/add_point, custom properties of the newly inserted vertices are filled with 0.
  Optionally, it is possible to use properties in vertex shaders by defining a shader binding.
  If rendered via PolyLineNode, these properties are then automatically available in vertex shaders (no additional management required).
  However, it is still necessary to trigger a vbo update function whenever data of properties is changed.


  Example: add float3 data to each vertex and use these in a vertex shader
  
  // request new property with name "myCustomData", that stores 3 * sizeof(float) = 12 bytes
  PolyLine::CustomPropertyHandle myPropHandle = line->request_custom_property("myCustomData", 12);

  // bind property to a vertex shader as input id "a2v_UserData" with coordinates of type GL_FLOAT
  line->bind_custom_property_to_shader(myPropHandle, "a2v_UserData", GL_FLOAT);

  // set property data
  for each vertex i:
    Vec3f x = computeCustomData(i);

    line->set_custom_property(myPropHandle, x.data());

  // trigger vbo update in rendering node of the polyline (ie. PolyLineNode)
  lineNode->update();



  these vertex properties are then available in any vertex shader used to render the polyline:

  in vec3 a2v_UserData;

  void main()
  {
    ...
  }
  */

  typedef int CustomPropertyHandle;

  // request properties,  returns handle of custom property
  CustomPropertyHandle request_custom_property(const std::string& _name, unsigned int _prop_size);

  // release properties
  void release_custom_property(const std::string& _name);
  void release_custom_property(CustomPropertyHandle _prop_handle);

  // property availability
  bool custom_property_available(CustomPropertyHandle _property_handle) const;
  bool custom_property_available(const std::string& _name) const;

  // property access by handle  (byte-wise)
  void set_custom_property(CustomPropertyHandle _property_handle, unsigned int _vertex, const void* _data);
  void get_custom_property(CustomPropertyHandle _property_handle, unsigned int _vertex, void* _dst) const;

  // property access by name (byte-wise),  (slower than by handle)
  void set_custom_property(const std::string& _name, unsigned int _vertex, const void* _data);
  void get_custom_property(const std::string& _name, unsigned int _vertex, void* _dst) const;


  void bind_custom_property_to_shader(CustomPropertyHandle _property_handle, const std::string& _shader_input_name, unsigned int _datatype);

  bool get_custom_property_shader_binding(CustomPropertyHandle _property_handle, unsigned int* _propsize, const char** _input_name, unsigned int* _datatype) const;

  // helper functions:

  // get property handle by name, returns 0 if unavailable
  CustomPropertyHandle get_custom_property_handle(const std::string& _name) const;

  // get name of property by handle
  const std::string get_custom_property_name(CustomPropertyHandle _property_handle) const;

  // get number of custom properties
  unsigned int get_num_custom_properties() const;

  // get pointer to buffer that stores property data for all vertices
  const void* get_custom_property_buffer(CustomPropertyHandle _property_handle) const;


  // enumerate custom property handles via indices in range [0, get_num_custom_properties() - 1]
  CustomPropertyHandle enumerate_custom_property_handles(unsigned int _i) const;


  // ############################### SelectionWrappers  ############################
  
  bool vertex_selected(unsigned int _i) { return (_i < vselections_.size() ? vertex_selection(_i) == 1 : false); }
  bool edge_selected(unsigned int _i) { return (_i < eselections_.size() ? edge_selection(_i) == 1 : false); }
  
  void select_vertex(unsigned int _i) { if(_i < vselections_.size()) vertex_selection(_i) = 1; }
  void select_edge(unsigned int _i) { if(_i < eselections_.size()) edge_selection(_i) = 1; }
  
  void deselect_vertex(unsigned int _i) { if(_i < vselections_.size()) vertex_selection(_i) = 0; }
  void deselect_edge(unsigned int _i) { if(_i < eselections_.size()) edge_selection(_i) = 0; }


  // ############################### Helper Functions  #############################

  // copy this[_j] = _pl[_i] WITH all vertex properties
  void copy_vertex_complete(const PolyLineT<PointT>& _pl, unsigned int _i, unsigned int _j);


  // copy this[_j] = _pl[_i] WITH all edge properties
  void copy_edge_complete(const PolyLineT<PointT>& _pl, unsigned int _i, unsigned int _j);

private:

  template <class MeshT, class SpatialSearchT>
  Point find_nearest_point( const MeshT&                _mesh,
                                              const Point&                _point,
                                              typename MeshT::FaceHandle &_fh,
                                              SpatialSearchT *            _ssearch = 0,
                                              double*                     _dbest   = 0);

  template<class MeshT, class SpatialSearchT>
  unsigned int component_of(
          const OpenMesh::PropertyManager<
              OpenMesh::FPropHandleT<unsigned int>,
              MeshT> &component,
          const PointT &pt,
          SpatialSearchT &_ssearch);

  template <class MeshT>
  void mark_components(
          OpenMesh::PropertyManager<
              OpenMesh::FPropHandleT<unsigned int>,
              MeshT> &component);


  template <class PropT>
  void request_prop( unsigned int& _ref_count, PropT& _prop);
  template <class PropT>
  void release_prop( unsigned int& _ref_count, PropT& _prop);

  template <class IPoint>
  bool plane_line_intersection( const IPoint& _p_plane,
                                const IPoint& _n_plane,
                                const IPoint& _p0,
                                const IPoint& _p1,
                                      IPoint& _p_int);

  template<class MeshT>
  void edge_points_in_segment( const MeshT&                             _mesh,
                                                 const Point&                             _p0,
                                                 const Point&                             _p1,
                               const typename MeshT::FaceHandle&        _fh0,
                               const typename MeshT::FaceHandle&        _fh1,
                                                 std::vector<Point> &                     _points,
                                                 std::vector<typename MeshT::EdgeHandle>& _ehandles );


private:

  std::vector<Point> points_;

  bool closed_;

  Scalar vertex_radius_;

  Scalar edge_radius_;

  // ############################### Standard Property Handling #############################

  // list of vertex properties
  std::vector<Point>  vnormals_;
  std::vector<Point>  vbinormals_;
  std::vector<Point>  vcolors_;
  std::vector<Scalar> vscalars_;
  std::vector<unsigned char>   vselections_;
  std::vector<int>    vvhandles_;
  std::vector<int>    vehandles_;
  std::vector<int>    vfhandles_;

  std::vector<Point>  enormals_;
  std::vector<Point>  ecolors_;
  std::vector<Scalar> escalars_;
  std::vector<unsigned char>   eselections_;
  std::vector<Point>  epreimage_direction_;


  // property reference counter
  unsigned int ref_count_vnormals_;
  unsigned int ref_count_vbinormals_;
  unsigned int ref_count_vcolors_;
  unsigned int ref_count_vscalars_;
  unsigned int ref_count_vselections_;
  unsigned int ref_count_vvhandles_;
  unsigned int ref_count_vehandles_;
  unsigned int ref_count_vfhandles_;

  unsigned int ref_count_enormals_;
  unsigned int ref_count_ecolors_;
  unsigned int ref_count_escalars_;
  unsigned int ref_count_eselections_;
  unsigned int ref_count_epreimage_direction_;


  // ############################### Custom Property Handling #############################

  struct  CustomProperty
  {
    std::string name;
    int ref_count;

    // size in bytes of one property element
    unsigned int prop_size;

    // property data in byte array
    std::vector<char> prop_data;

    // data type (GL_FLOAT, GL_DOUBLE, GL_UNSIGNED_BYTE...)
    unsigned int datatype;

    // input name in vertex shader
    std::string shader_binding;

    char* buffer() {return prop_data.empty() ? 0 : &prop_data[0];}
    const char* buffer() const {return prop_data.empty() ? 0 : &prop_data[0];}
  };
  
  typedef std::map< std::string, CustomProperty* > CustomPropertyMap;

  CustomProperty* custom_prop(CustomPropertyHandle _handle);
  const CustomProperty* custom_prop(CustomPropertyHandle _handle) const;

  CustomPropertyHandle custom_prop_handle(const CustomProperty*) const;

  // map from property name to property data
  CustomPropertyMap custom_properties;

  // vector of all properties for easier enumeration
  std::vector<CustomProperty*> cprop_enum;
};


//=============================================================================
} // namespace ACG
//=============================================================================
#if defined(INCLUDE_TEMPLATES) && !defined(ACG_POLYLINET_C)
#define ACG_POLYLINET_TEMPLATES
#include "PolyLineT_impl.hh"
#endif

#ifdef EXTENDED_POLY_LINE
  #if defined(INCLUDE_TEMPLATES) && !defined(ACG_POLYLINE_INTEGRATIONT_C)
  #define ACG_POLYLINE_INTEGRATIONT_TEMPLATES
  #include <libs/MeshIntegration/PolyLineIntegrationT.cc>
  #endif
#endif


//=============================================================================
#endif // ACG_POLYLINET_HH defined
//=============================================================================