DGtal::concepts::Board3DTo2D< S, KS > Class Template Reference

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

Detailed Description

template<class S, class KS>
class DGtal::concepts::Board3DTo2D< S, KS >

Aim: The concept CDrawableWithBoard3DTo2D specifies what are the classes that admit an export with Board3DTo2D.

Description of concept 'CDrawableWithBoard3DTo2D'

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

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

Refinement of

Associated types

Notation

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

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
the default draw style	x.defaultStyle( m = "")	mode m: std::string	CDrawableWithBoard3DTo2D		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(CDrawableWithBoard3DTo2D &display)				draws the object x on the display stream

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 98 of file CDrawableWithBoard3DTo2D.h.

---

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

• CDrawableWithBoard3DTo2D.h