DGtal::CDigitalOrientedShape< T > Struct Template Reference

#include <CDigitalOrientedShape.h>

Collaboration diagram for DGtal::CDigitalOrientedShape< T >:

Public Types
typedef T::Point	Point

Public Member Functions
	BOOST_CONCEPT_USAGE (CDigitalOrientedShape)

Private Attributes
T	myX
Orientation	myA
Point	p

---

Detailed Description

template<typename T>
struct DGtal::CDigitalOrientedShape< T >

Aim: characterizes models of digital oriented shapes. For example, models should provide an orientation method for points on a SpaceND. Returned value type corresponds to DGtal::Orientation.

Description of concept 'CDigitalOrientedShape'

Refinement of

Associated types :

• Point: type for digital points.

Notation

• X : A type that is a model of CDigitalOrientedShape
• x, y : object of type X

Definitions

Valid expressions and

Name	Expression	Type requirements	Return type	Precondition	Semantics	Postcondition	Complexity
Orientation method	x.orientation( aPoint)	aPoint of type const Point &	Orientation		return the orientation of a point aPoint according to the shape. Orientation values can be {INSIDE, ON, OUTSIDE}.

Invariants

Models

 Parametric and implicit shapes in the DGtal shape factory, 

Notes

Template Parameters:

T	the type that should be a model of CDigitalOrientedShape.

Definition at line 110 of file CDigitalOrientedShape.h.

---

Member Typedef Documentation

template<typename T >

typedef T::Point DGtal::CDigitalOrientedShape< T >::Point

Definition at line 115 of file CDigitalOrientedShape.h.

---

Member Function Documentation

template<typename T >

DGtal::CDigitalOrientedShape< T >::BOOST_CONCEPT_USAGE ( CDigitalOrientedShape< T >  )

inline

Definition at line 118 of file CDigitalOrientedShape.h.

References DGtal::CDigitalOrientedShape< T >::myA, DGtal::CDigitalOrientedShape< T >::myX, and DGtal::ConceptUtils::sameType().

    {
      ConceptUtils::sameType( myA, myX.orientation( p ));
    }

---

Field Documentation

template<typename T >

Orientation DGtal::CDigitalOrientedShape< T >::myA

private

Definition at line 125 of file CDigitalOrientedShape.h.

Referenced by DGtal::CDigitalOrientedShape< T >::BOOST_CONCEPT_USAGE().

template<typename T >

T DGtal::CDigitalOrientedShape< T >::myX

private

Definition at line 124 of file CDigitalOrientedShape.h.

Referenced by DGtal::CDigitalOrientedShape< T >::BOOST_CONCEPT_USAGE().

template<typename T >

Point DGtal::CDigitalOrientedShape< T >::p

private

Definition at line 126 of file CDigitalOrientedShape.h.

---

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

• CDigitalOrientedShape.h