DGtal  0.9.4beta
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB > Class Template Reference

#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)
 
DigitalShapesMinusoperator= (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
ShapeAtype of the first shape. Must be a model of CDigitalBoundedShape and CDigitalOrientedShape
ShapeBtype of the second shape. Must be a model of CDigitalBoundedShape and CDigitalOrientedShape

Definition at line 636 of file DigitalShapesDecorator.h.

Member Typedef Documentation

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

Definition at line 646 of file DigitalShapesDecorator.h.

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

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

Constructor.

Parameters
[in]aa model of CDigitalBoundedShape and CDigitalOrientedShape
[in]ba model of CDigitalBoundedShape and CDigitalOrientedShape

Definition at line 654 of file DigitalShapesDecorator.h.

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.

655  : myShapeA( a ),
656  myShapeB( b )
657  {
658  Point shapeALowerBoundary = myShapeA.getLowerBound();
659  Point shapeBLowerBoundary = myShapeB.getLowerBound();
660  Point shapeAUpperBoundary = myShapeA.getUpperBound();
661  Point shapeBUpperBoundary = myShapeB.getUpperBound();
662  for ( unsigned int i = 0; i < myLowerBound.size(); ++i )
663  {
664  myLowerBound[ i ] = std::min( shapeALowerBoundary[ i ], shapeBLowerBoundary[ i ] );
665  myUpperBound[ i ] = std::max( shapeAUpperBoundary[ i ], shapeBUpperBoundary[ i ] );
666  }
667  }
template<typename ShapeA , typename ShapeB >
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::~DigitalShapesMinus ( )
inline

Destructor.

Definition at line 708 of file DigitalShapesDecorator.h.

708 {}
template<typename ShapeA , typename ShapeB >
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::DigitalShapesMinus ( )
protected

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

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

Copy constructor.

Parameters
otherthe object to clone. Forbidden by default.

Member Function Documentation

template<typename ShapeA , typename ShapeB >
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalBoundedShape< ShapeA >)  )
template<typename ShapeA , typename ShapeB >
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalOrientedShape< ShapeA >)  )
template<typename ShapeA , typename ShapeB >
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalBoundedShape< ShapeB >)  )
template<typename ShapeA , typename ShapeB >
DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalOrientedShape< ShapeB >)  )
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.

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

675  {
676  return myLowerBound;
677  }
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.

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

684  {
685  return myUpperBound;
686  }
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.
template<typename ShapeA , typename ShapeB >
DigitalShapesMinus& DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::operator= ( const DigitalShapesMinus< ShapeA, ShapeB > &  other)
private

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.
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]pinput point
Returns
the orientation of the point (0 = INSIDE, 1 = ON, 2 = OUTSIDE)

Definition at line 695 of file DigitalShapesDecorator.h.

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

696  {
697  if (( myShapeB.orientation( p ) == INSIDE ) || ( myShapeB.orientation( p ) == ON ))
698  {
699  return OUTSIDE;
700  }
701  return myShapeA.orientation( p );
702  }
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
outthe output stream where the object is written.

Field Documentation

template<typename ShapeA , typename ShapeB >
Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myLowerBound
private
template<typename ShapeA , typename ShapeB >
const ShapeA& DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeA
private
template<typename ShapeA , typename ShapeB >
const ShapeB& DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myShapeB
private
template<typename ShapeA , typename ShapeB >
Point DGtal::deprecated::DigitalShapesMinus< ShapeA, ShapeB >::myUpperBound
private

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