DGtal: DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB

Aim: Minus between two models of CEuclideanBoundedShape and CEuclideanOrientedShape. More...

#include <DGtal/shapes/EuclideanShapesDecorator.h>

Public Types
typedef ShapeA::Space	Space

typedef ShapeA::RealPoint	RealPoint

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CEuclideanBoundedShape< ShapeA >))

	BOOST_CONCEPT_ASSERT ((concepts::CEuclideanOrientedShape< ShapeA >))

	BOOST_CONCEPT_ASSERT ((concepts::CEuclideanBoundedShape< ShapeB >))

	BOOST_CONCEPT_ASSERT ((concepts::CEuclideanOrientedShape< ShapeB >))

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

RealPoint	getLowerBound () const

RealPoint	getUpperBound () const

Orientation	orientation (const RealPoint &p) const

	~EuclideanShapesMinus ()

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Protected Member Functions
	EuclideanShapesMinus ()

Private Member Functions
	EuclideanShapesMinus (const EuclideanShapesMinus &other)

EuclideanShapesMinus &	operator= (const EuclideanShapesMinus &other)

Private Attributes
const ShapeA &	myShapeA

const ShapeB &	myShapeB

RealPoint	myLowerBound

RealPoint	myUpperBound

Detailed Description

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

Aim: Minus between two models of CEuclideanBoundedShape and CEuclideanOrientedShape.

Description of template class 'EuclideanShapesMinus'

Template Parameters

ShapeA	type of the first shape. Must be a model of CEuclideanBoundedShape and CEuclideanOrientedShape
ShapeB	type of the second shape. Must be a model of CEuclideanBoundedShape and CEuclideanOrientedShape

Definition at line 633 of file EuclideanShapesDecorator.h.

Member Typedef Documentation

◆ RealPoint

template<typename ShapeA , typename ShapeB >

typedef ShapeA::RealPoint DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::RealPoint

Definition at line 643 of file EuclideanShapesDecorator.h.

◆ Space

template<typename ShapeA , typename ShapeB >

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

Definition at line 642 of file EuclideanShapesDecorator.h.

Constructor & Destructor Documentation

◆ EuclideanShapesMinus() [1/3]

template<typename ShapeA , typename ShapeB >

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

inline

Constructor.

Parameters

[in]	a	a model of CEuclideanBoundedShape and CEuclideanOrientedShape
[in]	b	a model of CEuclideanBoundedShape and CEuclideanOrientedShape

Definition at line 651 of file EuclideanShapesDecorator.h.

       : myShapeA( a ),
         myShapeB( b )
     {
       RealPoint shapeALowerBoundary = myShapeA.getLowerBound();
       RealPoint shapeBLowerBoundary = myShapeB.getLowerBound();
       RealPoint shapeAUpperBoundary = myShapeA.getUpperBound();
       RealPoint 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::EuclideanShapesMinus< ShapeA, ShapeB >::myLowerBound, DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::myShapeA, DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::myShapeB, and DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::myUpperBound.

◆ ~EuclideanShapesMinus()

template<typename ShapeA , typename ShapeB >

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

inline

Destructor.

Definition at line 704 of file EuclideanShapesDecorator.h.

704 {}

◆ EuclideanShapesMinus() [2/3]

template<typename ShapeA , typename ShapeB >

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

protected

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

◆ EuclideanShapesMinus() [3/3]

template<typename ShapeA , typename ShapeB >

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

◆ BOOST_CONCEPT_ASSERT() [2/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CEuclideanBoundedShape< ShapeB >) )

◆ BOOST_CONCEPT_ASSERT() [3/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CEuclideanOrientedShape< ShapeA >) )

◆ BOOST_CONCEPT_ASSERT() [4/4]

template<typename ShapeA , typename ShapeB >

DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::BOOST_CONCEPT_ASSERT ( (concepts::CEuclideanOrientedShape< ShapeB >) )

◆ getLowerBound()

template<typename ShapeA , typename ShapeB >

RealPoint DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::getLowerBound ( ) const

inline

Returns: the lower bound of the shape bounding box.

Definition at line 670 of file EuclideanShapesDecorator.h.

     {
       return myLowerBound;
     }

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

◆ getUpperBound()

template<typename ShapeA , typename ShapeB >

RealPoint DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::getUpperBound ( ) const

inline

Returns: the upper bound of the shape bounding box.

Definition at line 679 of file EuclideanShapesDecorator.h.

     {
       return myUpperBound;
     }

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

◆ isValid()

template<typename ShapeA , typename ShapeB >

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

EuclideanShapesMinus& DGtal::deprecated::EuclideanShapesMinus< ShapeA, ShapeB >::operator= ( const EuclideanShapesMinus< 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::EuclideanShapesMinus< ShapeA, ShapeB >::orientation ( const RealPoint & 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 691 of file EuclideanShapesDecorator.h.

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