DGtal  0.9.4beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CDigitalOrientedShape< T > Struct Template Reference

#include <DGtal/shapes/CDigitalOrientedShape.h>

Collaboration diagram for DGtal::concepts::CDigitalOrientedShape< T >:
[legend]

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

template<typename T >
typedef T::Point DGtal::concepts::CDigitalOrientedShape< T >::Point

Definition at line 95 of file CDigitalOrientedShape.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CDigitalOrientedShape< T >::BOOST_CONCEPT_USAGE ( CDigitalOrientedShape< T >  )
inline

Field Documentation

template<typename T >
Orientation DGtal::concepts::CDigitalOrientedShape< T >::myA
private
template<typename T >
T DGtal::concepts::CDigitalOrientedShape< T >::myX
private
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: