DGtal::CEuclideanOrientedShape< T > Struct Template Reference

#include <CEuclideanOrientedShape.h>

Collaboration diagram for DGtal::CEuclideanOrientedShape< T >:

Public Types
typedef T::RealPoint	RealPoint

Public Member Functions
	BOOST_CONCEPT_USAGE (CEuclideanOrientedShape)

Private Attributes
T	myX
Orientation	myA
RealPoint	p

---

Detailed Description

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

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

Description of concept 'CEuclideanOrientedShape'

Refinement of

Associated types :

• RealPoint: type for real points.

Notation

• X : A type that is a model of CEuclideanOrientedShape
• 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 RealPoint &	DGtal::Orientation		return the orientation of a point aPoint according to the shape. Orientation values can be {DGtal::INSIDE, DGtal::ON or DGtal::OUTSIDE}.

Invariants

Models

 Parametric and implicit shapes in the DGtal shape factory, 

Notes

Template Parameters:

T	the type that should be a model of CEuclideanOrientedShape.

Definition at line 109 of file CEuclideanOrientedShape.h.

---

Member Typedef Documentation

template<typename T >

typedef T::RealPoint DGtal::CEuclideanOrientedShape< T >::RealPoint

Definition at line 114 of file CEuclideanOrientedShape.h.

---

Member Function Documentation

template<typename T >

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

inline

Definition at line 117 of file CEuclideanOrientedShape.h.

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

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

---

Field Documentation

template<typename T >

Orientation DGtal::CEuclideanOrientedShape< T >::myA

private

Definition at line 124 of file CEuclideanOrientedShape.h.

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

template<typename T >

T DGtal::CEuclideanOrientedShape< T >::myX

private

Definition at line 123 of file CEuclideanOrientedShape.h.

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

template<typename T >

RealPoint DGtal::CEuclideanOrientedShape< T >::p

private

Definition at line 125 of file CEuclideanOrientedShape.h.

---

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

• CEuclideanOrientedShape.h