BSplineCurveT.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 BSplineCurveT
//  Author:  Ellen Dekkers <dekkers@cs.rwth-aachen.de>
//
//=============================================================================


#ifndef BSPLINECURVET_HH
#define BSPLINECURVET_HH


//== INCLUDES =================================================================
#include <vector>
#include <iostream>

#include <ACG/Math/VectorT.hh>

#include <ObjectTypes/Knotvector/KnotvectorT.hh>

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

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

namespace ACG {

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


template <class PointT>
class BSplineCurveT
{
public:

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

  BSplineCurveT(unsigned int _degree = 3);

  BSplineCurveT(const BSplineCurveT& _curve);

  ~BSplineCurveT() {}

  std::vector< Scalar >& get_knots() {return knotvector_.getKnotvector();};

  void set_knots(std::vector< Scalar > _knots);

  Knotvector * get_knotvector_ref(){return &knotvector_;};

  void set_knotvector_type(Knotvector::KnotvectorType _type) {knotvector_.setType(_type);};

  Scalar get_knot(int _i) {return knotvector_(_i);};

  Point& get_control_point(int _i) {return control_polygon_[_i];};

  void add_control_point(const Point& _cp);

  void insert_control_point(int _idx, const Point& _cp);

  void delete_control_point(int _idx);

  void set_control_point(int _idx, const Point& _cp);

  void set_control_polygon(std::vector< Point> & _control_polygon);

  void reset_control_polygon();

  void print() const;

  Point curvePoint( Scalar _u );

  Point derivativeCurvePoint(Scalar _u, unsigned int _der);

  std::vector<Point> deBoorAlgorithm(double _u);

  void insertKnot(double _u);

  unsigned int n_control_points() const {return control_polygon_.size();};

  unsigned int n_knots() const { return knotvector_.size(); };

  unsigned int degree() const {return degree_;};

  void set_degree(unsigned int _degree) {degree_ = _degree;};

  ACG::Vec2i span(double _t);

  ACG::Vec2i interval(double _t);
  
  void autocompute_knotvector(bool _auto) {autocompute_knotvector_ = _auto;};

  void fixNumberOfControlPoints(bool _fix) {fix_number_control_points_ = _fix;};

  bool projected() {return fix_number_control_points_;};

  void reverse();


public:

  Scalar basisFunction(int _i, int _n, Scalar _t);

  Scalar derivativeBasisFunction(int _i, int _n, Scalar _t, int _der);


public:

  Scalar lower() const;

  Scalar upper() const;


  // request properties
  void request_controlpoint_selections() { request_prop( ref_count_cpselections_, cpselections_);}
  void request_edge_selections()   { request_prop( ref_count_eselections_, eselections_);}

  // release properties
  void release_controlpoint_selections() { release_prop( ref_count_cpselections_, cpselections_);}
  void release_edge_selections()   { release_prop( ref_count_eselections_, eselections_);}

  // property availability
  bool controlpoint_selections_available() const {return bool(ref_count_cpselections_);}
  bool edge_selections_available()   const {return bool(ref_count_eselections_);}


  // property access ( no range or availability check! )
  unsigned char& controlpoint_selection(unsigned int _i){
    assert(_i < n_control_points());
    assert(controlpoint_selections_available());
    return cpselections_[_i];
  }
  const unsigned char& controlpoint_selection(unsigned int _i) const {
    assert(_i < n_control_points());
    assert(controlpoint_selections_available());
    return cpselections_[_i];
  }

  unsigned char& edge_selection(unsigned int _i) {
    assert(edge_selections_available());
    return eselections_[_i];
  }
  const unsigned char& edge_selection(unsigned int _i) const {
    assert(edge_selections_available());
    return eselections_[_i];
  }
  
  // Wrapper for selection functions
  void select_controlpoint(unsigned int _pIdx) { controlpoint_selection(_pIdx) = 1; };
  void deselect_controlpoint(unsigned int _pIdx) { controlpoint_selection(_pIdx) = 0; };
  
  bool controlpoint_selected(unsigned int _pIdx) const { return (controlpoint_selection(_pIdx) == 1); };
  
  void select_edge(unsigned int _pIdx) { edge_selection(_pIdx) = 1; };
  void deselect_edge(unsigned int _pIdx) { edge_selection(_pIdx) = 0; };
  
  bool edge_selected(unsigned int _pIdx) const { return (edge_selection(_pIdx) == 1); };

private:

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

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


private: // private objects

  std::vector<Point> control_polygon_;

  Knotvector knotvector_;

  unsigned int degree_;

  bool autocompute_knotvector_;

  bool fix_number_control_points_;

private: // private properties

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

  // list of vertex properties
  std::vector<unsigned char>   cpselections_;

  // list of edge properties
  std::vector<unsigned char>   eselections_;

  // property reference counter
  unsigned int ref_count_cpselections_;
  unsigned int ref_count_eselections_;

};


//=============================================================================
} // namespace ACG
//=============================================================================
#if defined(INCLUDE_TEMPLATES) && !defined(BSPLINECURVE_BSPLINECURVET_C)
#define BSPLINECURVE_BSPLINECURVET_TEMPLATES
#include "BSplineCurveT_impl.hh"
#endif
//=============================================================================
#endif // ACG_BSPLINECURVET_HH defined
//=============================================================================