// Copyright (c) 2007  INRIA (France).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org); you may redistribute it under
// the terms of the Q Public License version 1.0.
// See the file LICENSE.QPL distributed with CGAL.
//
// Licensees holding a valid commercial license may use this file in
// accordance with the commercial license agreement provided with the software.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//
// $URL$
// $Id$
//
// Author(s)     : Laurent Saboret, Pierre Alliez


/// The ReconstructionVertexBase_3 concept defines the interface
/// of the vertex class of the ReconstructionTriangulation_3 concept.
/// It provides the interface requested by the Poisson_reconstruction_function class:
/// - Each vertex stores a normal vector.
/// - A vertex is either an input point or a Steiner point added by Delaunay refinement.
/// - In order to solve a linear system over the triangulation, a vertex may be constrained
///   or not (i.e. may contribute to the right or left member of the linear system),
///   and has a unique index.
///
/// @heading Has Models:
/// Reconstruction_vertex_base_3<GeomTraits, TriangulationVertexBase_3>
///
/// @commentheading Precondition:
/// The geometric traits class 's Point_3 type must be a model of PointWithNormal_3.

class ReconstructionVertexBase_3 : public DelaunayTriangulationVertexBase_3,
                                   public DefaultConstructible
{
// Public types
public:

  /// Geometric traits class / Point_3 is a model of PointWithNormal_3.
  typedef Gt Geom_traits;

  typedef typename Geom_traits::FT FT;
  typedef typename Geom_traits::Point_3 Point;             ///< Model of PointWithNormal_3
  typedef typename Geom_traits::Point_3 Point_with_normal; ///< Model of PointWithNormal_3
  typedef typename Point_with_normal::Normal Normal; ///< Model of Kernel::Vector_3 concept.

// Public methods
public:

  ReconstructionVertexBase_3();
  ReconstructionVertexBase_3(const Point_with_normal & p);
  ReconstructionVertexBase_3(const Point_with_normal & p, Cell_handle c);
  ReconstructionVertexBase_3(Cell_handle c);

  /// Is vertex constrained, i.e.
  /// does it contribute to the right or left member of the linear system?
  /// Default value is false.
  bool  constrained() const;
  bool& constrained();

  /// Get/set the value of the implicit function.
  /// Default value is 0.0.
  FT  f() const;
  FT& f();

  /// Get/set the type = INPUT or STEINER.
  unsigned char  type() const;
  unsigned char& type();

  /// Get/set the index in matrix.
  unsigned int  index() const;
  unsigned int& index();

  /// Get/set normal (vector + orientation).
  /// Default value is null vector.
  const Normal& normal() const;
  Normal&       normal();

}; // end of ReconstructionVertexBase_3