DGtal: DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB

Aim: Intersection 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 >))

	DigitalShapesIntersection (ConstAlias< ShapeA > a, ConstAlias< ShapeB > b)

Point	getLowerBound () const

Point	getUpperBound () const

Orientation	orientation (const Point &p) const

	~DigitalShapesIntersection ()

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Protected Member Functions
	DigitalShapesIntersection ()

Private Member Functions
	DigitalShapesIntersection (const DigitalShapesIntersection &other)

DigitalShapesIntersection &	operator= (const DigitalShapesIntersection &other)

Private Attributes
const ShapeA &	myShapeA

const ShapeB &	myShapeB

Point	myLowerBound

Point	myUpperBound

Detailed Description

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

Aim: Intersection between two models of CDigitalBoundedShape and CDigitalOrientedShape.

Description of template class 'DigitalShapesIntersection'

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 492 of file DigitalShapesDecorator.h.

Member Typedef Documentation

◆ Point

template<typename ShapeA , typename ShapeB >

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

Definition at line 502 of file DigitalShapesDecorator.h.

◆ Space

template<typename ShapeA , typename ShapeB >

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

Definition at line 501 of file DigitalShapesDecorator.h.

Constructor & Destructor Documentation

◆ DigitalShapesIntersection() [1/3]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::DigitalShapesIntersection	(	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 510 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 max(), DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::myLowerBound, DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::myShapeA, DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::myShapeB, and DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::myUpperBound.

◆ ~DigitalShapesIntersection()

template<typename ShapeA , typename ShapeB >

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

inline

Destructor.

Definition at line 573 of file DigitalShapesDecorator.h.

573 {}

◆ DigitalShapesIntersection() [2/3]

template<typename ShapeA , typename ShapeB >

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

protected

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

◆ DigitalShapesIntersection() [3/3]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::DigitalShapesIntersection ( const DigitalShapesIntersection< 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::DigitalShapesIntersection< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalBoundedShape< ShapeA >) )

◆ BOOST_CONCEPT_ASSERT() [2/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalBoundedShape< ShapeB >) )

◆ BOOST_CONCEPT_ASSERT() [3/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalOrientedShape< ShapeA >) )

◆ BOOST_CONCEPT_ASSERT() [4/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalOrientedShape< ShapeB >) )

◆ getLowerBound()

template<typename ShapeA , typename ShapeB >

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

inline

Returns: the lower bound of the shape bounding box.

Definition at line 530 of file DigitalShapesDecorator.h.

   {
     return myLowerBound;
   }

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

◆ getUpperBound()

template<typename ShapeA , typename ShapeB >

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

inline

Returns: the upper bound of the shape bounding box.

Definition at line 539 of file DigitalShapesDecorator.h.

   {
     return myUpperBound;
   }

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

◆ isValid()

template<typename ShapeA , typename ShapeB >

bool DGtal::deprecated::DigitalShapesIntersection< 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 >

DigitalShapesIntersection& DGtal::deprecated::DigitalShapesIntersection< ShapeA, ShapeB >::operator= ( const DigitalShapesIntersection< 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::DigitalShapesIntersection< 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 551 of file DigitalShapesDecorator.h.

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