DGtal  0.6.devel
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes
DGtal::CDrawableWithDisplay3D< T > Struct Template Reference

#include <CDrawableWithDisplay3D.h>

Collaboration diagram for DGtal::CDrawableWithDisplay3D< T >:
Collaboration graph
[legend]

Public Member Functions

 BOOST_CONCEPT_USAGE (CDrawableWithDisplay3D)

Private Attributes

myT
DrawableWithDisplay3DmyD
Display3D myD3D
std::string myS

Detailed Description

template<typename T>
struct DGtal::CDrawableWithDisplay3D< T >

DescriptionDescription of concept 'CDrawableWithDisplay3D'

Aim: The concept CDrawableWithDisplay3D specifies what are the classes that admit an export with Display3D. An object x satisfying this concept may then be used as:

Display3D display;
display << CustomStyle( x.className(), x.defaultStyle() )
<< x;

Refinement of

Associated types :

Notation

Definitions

Valid expressions and

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
the default draw style x.defaultStyle( m = "" ) mode : std::string CDrawableWithDisplay3D * returns a dynamic allocation of the default style for the model X in mode m
the name of the model X x.className() std::string returns a string telling the name of the model X
the way the object x is drawn x.setStyle(CDrawableWithDisplay3D &display) draws on the display stream the object x

Invariants###

Models### ArimeticalDSS, FreemanChain, HyperRectDomain, ImageContainerByHashTree, ImageContainerBySTLVector, PointVector, DigitalSetBySTLSet,DigitalSetBySTLVector, Object

Notes###

Todo:

ImageContainerByHashTree does not implement setStyle(display &).

ImageContainerByHashTree does not implement defaultStyle(std::string&)const.

Definition at line 110 of file CDrawableWithDisplay3D.h.


Member Function Documentation

template<typename T >
DGtal::CDrawableWithDisplay3D< T >::BOOST_CONCEPT_USAGE ( CDrawableWithDisplay3D< T >  )
inline

Definition at line 113 of file CDrawableWithDisplay3D.h.

References DGtal::CDrawableWithDisplay3D< T >::myS, DGtal::CDrawableWithDisplay3D< T >::myT, and DGtal::ConceptUtils::sameType().

{
//Drawable model should have a className() returning a string
ConceptUtils::sameType( myS, myT.className() );
//Drawable model should be associated to global functions draw and defaultStyle.
//draw(myD3D, myT);
//ConceptUtils::sameType( myD, defaultStyle( myT) );
}

Field Documentation

template<typename T >
DrawableWithDisplay3D* DGtal::CDrawableWithDisplay3D< T >::myD
private

Definition at line 126 of file CDrawableWithDisplay3D.h.

template<typename T >
Display3D DGtal::CDrawableWithDisplay3D< T >::myD3D
private

Definition at line 128 of file CDrawableWithDisplay3D.h.

template<typename T >
std::string DGtal::CDrawableWithDisplay3D< T >::myS
private
template<typename T >
T DGtal::CDrawableWithDisplay3D< T >::myT
private

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