DGtal::concepts::CDrawableWithViewer3D< T, S, KS > Struct Template Reference

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

#include <DGtal/io/viewers/CDrawableWithViewer3D.h>

Inheritance diagram for DGtal::concepts::CDrawableWithViewer3D< T, S, KS >:

Public Member Functions
	BOOST_CONCEPT_USAGE (CDrawableWithViewer3D)
Public Member Functions inherited from DGtal::concepts::CDrawableWithDisplay3D< T, S, KS >
	BOOST_CONCEPT_USAGE (CDrawableWithDisplay3D)

Private Attributes
T	myT
DrawableWithViewer3D *	myD
	the drawable class More...
std::string	myS

Detailed Description

template<typename T, typename S, typename KS>
struct DGtal::concepts::CDrawableWithViewer3D< T, S, KS >

Aim: The concept CDrawableWithViewer3D specifies what are the classes that admit an export with Viewer3D.

Description of concept 'CDrawableWithViewer3D'

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

Viewer3D<Space,KSpace> display;
display << CustomStyle( x.className(), x.defaultStyle() )
        << x;

Refinement of

Associated types

Notation

• X : A type that is a model of CDrawableWithViewer3DD
• 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	CDrawableWithViewer3D		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(CDrawableWithViewer3D &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 100 of file CDrawableWithViewer3D.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T , typename S , typename KS >

DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::BOOST_CONCEPT_USAGE ( CDrawableWithViewer3D< T, S, KS >  )

inline

Definition at line 103 of file CDrawableWithViewer3D.h.

      {
        //Drawable model should have a className() returning a string
        concepts::ConceptUtils::sameType( myS, myT.className() );
 
      }

References DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::myS, DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::myT, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

myD

template<typename T , typename S , typename KS >

DrawableWithViewer3D* DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::myD

private

the drawable class

Definition at line 114 of file CDrawableWithViewer3D.h.

myS

template<typename T , typename S , typename KS >

std::string DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::myS

private

Definition at line 116 of file CDrawableWithViewer3D.h.

Referenced by DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::BOOST_CONCEPT_USAGE().

myT

template<typename T , typename S , typename KS >

T DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::myT

private

Definition at line 113 of file CDrawableWithViewer3D.h.

Referenced by DGtal::concepts::CDrawableWithViewer3D< T, S, KS >::BOOST_CONCEPT_USAGE().

---

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

• CDrawableWithViewer3D.h