DGtal::Point2ShapePredicate< TSurface, isUpward, isClosed > Class Template Reference

#include <Point2ShapePredicate.h>

Public Types
typedef TSurface::Point	Point
typedef TSurface::Distance	Distance

Public Member Functions
	Point2ShapePredicate (const TSurface &aSurface)
	Point2ShapePredicate (const Point2ShapePredicate &other)
bool	operator() (const Point &p) const
void	selfDisplay (std::ostream &out) const
	~Point2ShapePredicate ()

Private Attributes
TSurface	myS

---

Detailed Description

template<typename TSurface, bool isUpward, bool isClosed>
class DGtal::Point2ShapePredicate< TSurface, isUpward, isClosed >

Aim: Predicate returning 'true' iff a given point is in the 'interior' of a given shape, 'false' otherwise.

 @tparam TSurface  a type that is a model of COrientableHypersurface.
 Must separate the space in two disjoints parts (the 'interior' and the 'exterior')
 and must be able to return for any given point (of type TSurface::Point) 
 the signed distance to itself (of type TSurface::Distance) by a method called signedDistance() 
 @tparam isUpward  a bool for the orientation ('true' means that the interior 
 is the set of points of positive distance)
 @tparam isClosed  a bool for the closure ('true' means that the surface is included)

 For instance, in 2d, you can define four shapes from one straight line of equation \form#164:

• the set \( \{(x,y) | y > ax + b \} \)
• \( \{(x,y) | y \geq ax + b \} \)
• \( \{(x,y) | y < ax + b \} \)

• \( \{(x,y) | y \leq ax + b \} \)

  The second set can be defined as follows:

  Then, you can create and use your half-plane as shown below:

  You should get:

    [Point2ShapePredicate] :
  [StraightLine] passing through:
  [PointVector] {0, 0}[PointVector] {5, 2}
  (upward oriented, closed)
  
    Does [PointVector] {2, 0} belongs to hp (no)?
    no

  This class is a model of CPointPredicate.

  See also:

  testHalfPlane.cpp

Definition at line 95 of file Point2ShapePredicate.h.

---

Member Typedef Documentation

template<typename TSurface, bool isUpward, bool isClosed>

typedef TSurface::Distance DGtal::Point2ShapePredicate< TSurface, isUpward, isClosed >::Distance

Definition at line 101 of file Point2ShapePredicate.h.

template<typename TSurface, bool isUpward, bool isClosed>

typedef TSurface::Point DGtal::Point2ShapePredicate< TSurface, isUpward, isClosed >::Point

Definition at line 100 of file Point2ShapePredicate.h.

---

Constructor & Destructor Documentation

template<typename TSurface , bool isUpward, bool isClosed>

DGtal::Point2ShapePredicate< TSurface, isUpward, isClosed >::Point2ShapePredicate ( const TSurface &  aSurface )

inline

Constructor.

Parameters:

aSurface

any Surface

Definition at line 50 of file Point2ShapePredicate.ih.

                                 :
        myS(aSurface)
{