DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB > Class Template Reference

Aim: Minus between two models of CDigitalBoundedShape and CDigitalOrientedShape. More...

#include <DGtal/shapes/DigitalShapesDecorator.h>

Public Types
typedef ShapeA::Space	Space
typedef ShapeA::Point	Point

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalBoundedShape< ShapeA >))
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalOrientedShape< ShapeA >))
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalBoundedShape< ShapeB >))
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalOrientedShape< ShapeB >))
	DigitalShapesMinus (ConstAlias< ShapeA > a, ConstAlias< ShapeB > b)
Point	getLowerBound () const
Point	getUpperBound () const
Orientation	orientation (const Point &p) const
	~DigitalShapesMinus ()
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Protected Member Functions
	DigitalShapesMinus ()

Private Member Functions
	DigitalShapesMinus (const DigitalShapesMinus &other)
DigitalShapesMinus &	operator= (const DigitalShapesMinus &other)

Private Attributes
const ShapeA &	myShapeA
const ShapeB &	myShapeB
Point	myLowerBound
Point	myUpperBound

Detailed Description

template<typename ShapeA, typename ShapeB>
class DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >

Aim: Minus between two models of CDigitalBoundedShape and CDigitalOrientedShape.

Description of template class 'DigitalShapesMinus'

Template Parameters

ShapeA	type of the first shape. Must be a model of CDigitalBoundedShape and CDigitalOrientedShape
ShapeB	type of the second shape. Must be a model of CDigitalBoundedShape and CDigitalOrientedShape

Definition at line 636 of file DigitalShapesDecorator.h.

Member Typedef Documentation

Point

template<typename ShapeA , typename ShapeB >

typedef ShapeA::Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::Point

Definition at line 646 of file DigitalShapesDecorator.h.

Space

template<typename ShapeA , typename ShapeB >

typedef ShapeA::Space DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::Space

Definition at line 645 of file DigitalShapesDecorator.h.

Constructor & Destructor Documentation

DigitalShapesMinus() [1/3]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus ( ConstAlias< ShapeA > a, ConstAlias< ShapeB > b )

inline

Constructor.

Parameters

[in]	a	a model of CDigitalBoundedShape and CDigitalOrientedShape
[in]	b	a model of CDigitalBoundedShape and CDigitalOrientedShape

Definition at line 654 of file DigitalShapesDecorator.h.

    : myShapeA( a ),
      myShapeB( b )
  {
    Point shapeALowerBoundary = myShapeA.getLowerBound();
    Point shapeBLowerBoundary = myShapeB.getLowerBound();
    Point shapeAUpperBoundary = myShapeA.getUpperBound();
    Point shapeBUpperBoundary = myShapeB.getUpperBound();
    for ( unsigned int i = 0; i < myLowerBound.size(); ++i )
    {
      myLowerBound[ i ] = std::min( shapeALowerBoundary[ i ], shapeBLowerBoundary[ i ] );
      myUpperBound[ i ] = std::max( shapeAUpperBoundary[ i ], shapeBUpperBoundary[ i ] );
    }
  }

References DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myLowerBound, DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeA, DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeB, and DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myUpperBound.

~DigitalShapesMinus()

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::~DigitalShapesMinus ( )

inline

Destructor.

Definition at line 708 of file DigitalShapesDecorator.h.

{}

DigitalShapesMinus() [2/3]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus ( )

protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

DigitalShapesMinus() [3/3]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus ( const DigitalShapesMinus< ShapeA, ShapeB > & other )

private

Copy constructor.

Parameters

other

the object to clone. Forbidden by default.

Member Function Documentation

BOOST_CONCEPT_ASSERT() [1/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT

(

(concepts::CDigitalBoundedShape< ShapeA >)

)

BOOST_CONCEPT_ASSERT() [2/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT

(

(concepts::CDigitalBoundedShape< ShapeB >)

)

BOOST_CONCEPT_ASSERT() [3/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT

(

(concepts::CDigitalOrientedShape< ShapeA >)

)

BOOST_CONCEPT_ASSERT() [4/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT

(

(concepts::CDigitalOrientedShape< ShapeB >)

)

getLowerBound()

template<typename ShapeA , typename ShapeB >

Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::getLowerBound ( ) const

inline

Returns

the lower bound of the shape bounding box.

Definition at line 674 of file DigitalShapesDecorator.h.

  {
    return myLowerBound;
  }

References DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myLowerBound.

getUpperBound()

template<typename ShapeA , typename ShapeB >

Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::getUpperBound ( ) const

inline

Returns

the upper bound of the shape bounding box.

Definition at line 683 of file DigitalShapesDecorator.h.

  {
    return myUpperBound;
  }

References DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myUpperBound.

isValid()

template<typename ShapeA , typename ShapeB >

bool DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

'true' if the object is valid, 'false' otherwise.

operator=()

template<typename ShapeA , typename ShapeB >

DigitalShapesMinus & DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::operator= ( const DigitalShapesMinus< ShapeA, ShapeB > & other )

private

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

orientation()

template<typename ShapeA , typename ShapeB >

Orientation DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::orientation ( const Point & p ) const

inline

Return the orientation of a point with respect to a shape.

Parameters

[in]

p

input point

Returns

the orientation of the point (0 = INSIDE, 1 = ON, 2 = OUTSIDE)

Definition at line 695 of file DigitalShapesDecorator.h.

  {
    if (( myShapeB.orientation( p ) == INSIDE ) || ( myShapeB.orientation( p ) == ON ))
    {
      return OUTSIDE;
    }
    return myShapeA.orientation( p );
  }

References DGtal::INSIDE, DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeA, DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeB, DGtal::ON, and DGtal::OUTSIDE.

selfDisplay()

template<typename ShapeA , typename ShapeB >

void DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::selfDisplay

(

std::ostream &

out

)

const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

Field Documentation

myLowerBound

template<typename ShapeA , typename ShapeB >

Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myLowerBound

private

Definition at line 756 of file DigitalShapesDecorator.h.

Referenced by DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus(), and DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::getLowerBound().

myShapeA

template<typename ShapeA , typename ShapeB >

const ShapeA& DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeA

private

Definition at line 753 of file DigitalShapesDecorator.h.

Referenced by DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus(), and DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::orientation().

myShapeB

template<typename ShapeA , typename ShapeB >

const ShapeB& DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeB

private

Definition at line 754 of file DigitalShapesDecorator.h.

Referenced by DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus(), and DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::orientation().

myUpperBound

template<typename ShapeA , typename ShapeB >

Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myUpperBound

private

Definition at line 757 of file DigitalShapesDecorator.h.

Referenced by DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus(), and DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::getUpperBound().

---

The documentation for this class was generated from the following file:

• DigitalShapesDecorator.h