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

#include <DGtal/shapes/CEuclideanOrientedShape.h>

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

Public Types

typedef T::RealPoint RealPoint
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CEuclideanOrientedShape)
 

Private Attributes

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 :

Notation

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

Definition at line 91 of file CEuclideanOrientedShape.h.

Member Typedef Documentation

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

Definition at line 96 of file CEuclideanOrientedShape.h.

Member Function Documentation

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

Field Documentation

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