DGtal::concepts::CEuclideanOrientedShape< T > Struct Template Reference

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. More...

#include <DGtal/shapes/CEuclideanOrientedShape.h>

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::concepts::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	Post condition	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 91 of file CEuclideanOrientedShape.h.

Member Typedef Documentation

RealPoint

template<typename T >

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

Definition at line 96 of file CEuclideanOrientedShape.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 99 of file CEuclideanOrientedShape.h.

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

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

Field Documentation

myA

template<typename T >

Orientation DGtal::concepts::CEuclideanOrientedShape< T >::myA

private

Definition at line 106 of file CEuclideanOrientedShape.h.

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

myX

template<typename T >

T DGtal::concepts::CEuclideanOrientedShape< T >::myX

private

Definition at line 105 of file CEuclideanOrientedShape.h.

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

p

template<typename T >

RealPoint DGtal::concepts::CEuclideanOrientedShape< T >::p

private

Definition at line 107 of file CEuclideanOrientedShape.h.

---

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

• CEuclideanOrientedShape.h