Aim: The concept CDrawableWithBoard2D specifies what are the classes that admit an export with Board2D. More...

#include <DGtal/io/boards/CDrawableWithBoard2D.h>

Public Member Functions
	BOOST_CONCEPT_USAGE (CDrawableWithBoard2D)

Private Attributes
T	myT

DrawableWithBoard2D *	myD

Board2D	myB

std::string	myS

Detailed Description

template<typename T>
struct DGtal::concepts::CDrawableWithBoard2D< T >

Aim: The concept CDrawableWithBoard2D specifies what are the classes that admit an export with Board2D.

Description of concept 'CDrawableWithBoard2D'

An object x satisfying this concept may then be used as:

Board2D board;
board << CustomStyle( x.className(), x.defaultStyle() )
      << x;

Refinement of

Associated types

Notation

X : A type that is a model of CDrawableWithBoard2D
x, y : Object of type X
m : a string of characters

Definitions

Valid expressions and semantics

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

Invariants

Models

ArithmeticalDSSComputer, FreemanChain, HyperRectDomain, ImageContainerByHashTree, ImageContainerBySTLVector, PointVector, DigitalSetBySTLSet,DigitalSetBySTLVector, Object

Notes

Todo:

ImageContainerByHashTree does not implement setStyle(Board2D &).

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

Definition at line 104 of file CDrawableWithBoard2D.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 108 of file CDrawableWithBoard2D.h.

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