DGtal  1.3.beta
Public Types | Public Member Functions | Private Attributes
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

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

Notation

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
Tthe type that should be a model of CDigitalOrientedShape.

Definition at line 90 of file CDigitalOrientedShape.h.

Member Typedef Documentation

◆ Point

template<typename T >
typedef 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

Field Documentation

◆ myA

template<typename T >
Orientation DGtal::concepts::CDigitalOrientedShape< T >::myA
private

◆ myX

template<typename T >
T DGtal::concepts::CDigitalOrientedShape< T >::myX
private

◆ 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:
DGtal::concepts::CDigitalOrientedShape::myX
T myX
Definition: CDigitalOrientedShape.h:104
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CDigitalOrientedShape::myA
Orientation myA
Definition: CDigitalOrientedShape.h:105