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

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

#include <DGtal/shapes/CDigitalOrientedShape.h>

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::concepts::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 semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	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 90 of file CDigitalOrientedShape.h.

Member Typedef Documentation

Point

template<typename T >

T::Point DGtal::concepts::CDigitalOrientedShape< T >::Point

Definition at line 95 of file CDigitalOrientedShape.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 98 of file CDigitalOrientedShape.h.

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

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

Field Documentation

myA

template<typename T >

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

private

Definition at line 105 of file CDigitalOrientedShape.h.

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

myX

template<typename T >

T DGtal::concepts::CDigitalOrientedShape< T >::myX

private

Definition at line 104 of file CDigitalOrientedShape.h.

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

p

template<typename T >

Point DGtal::concepts::CDigitalOrientedShape< T >::p

private

Definition at line 106 of file CDigitalOrientedShape.h.

---

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

• CDigitalOrientedShape.h