DGtal  1.3.beta
Public Member Functions | Data Fields
DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D Struct Reference

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

Public Member Functions

template<typename TDomain >
 Image2DDomainD3D (TDomain aDomain, ImageDirection normalDir=zDirection, double xBottomLeft=0.0, double yBottomLeft=0.0, double zBottomLeft=0.0, std::string mode="BoundingBox")
 
void updateDomainOrientation (ImageDirection normalDir, double xBottomLeft, double yBottomLeft, double zBottomLeft)
 
void translateDomain (double xTranslation=0.0, double yTranslation=0.0, double zTranslation=0.0)
 

Data Fields

RealPoint point1
 The image domain coordinates. More...
 
RealPoint point2
 
RealPoint point3
 
RealPoint point4
 
DGtal::Color color
 The image domain color. More...
 
unsigned int myDomainWidth
 the width of the image domain More...
 
unsigned int myDomainHeight
 the height of the image domain More...
 
ImageDirection myDirection
 the direction of the domain (x, y or z axe) More...
 
std::string myMode
 the mode of representation of the image domain More...
 
std::size_t myLineSetIndex
 the index of the line of the domain in the lineSetList of the viewer More...
 

Detailed Description

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
struct DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D

Used to display the 2D domain of an image.

Note
has to be public because of external functions

Definition at line 497 of file Viewer3D.h.

Constructor & Destructor Documentation

◆ Image2DDomainD3D()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
template<typename TDomain >
DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::Image2DDomainD3D ( TDomain  aDomain,
ImageDirection  normalDir = zDirection,
double  xBottomLeft = 0.0,
double  yBottomLeft = 0.0,
double  zBottomLeft = 0.0,
std::string  mode = "BoundingBox" 
)
inline

Constructor

Parameters
aDomaina domain
normalDirthe normal vector direction
xBottomLeftthe x coordinate of bottom left image point.
yBottomLeftthe y coordinate of bottom left image point.
zBottomLeftthe z coordinate of bottom left image point.
modethe mode of representation

Definition at line 528 of file Viewer3D.h.

530  {
531  BOOST_CONCEPT_ASSERT(( concepts::CDomain < TDomain >));
532  myMode = mode;
533  myDirection=normalDir;
534  myDomainWidth = (aDomain.upperBound())[0]-(aDomain.lowerBound())[0]+1;
535  myDomainHeight = (aDomain.upperBound())[1]-(aDomain.lowerBound())[1]+1;
536  updateDomainOrientation(normalDir, xBottomLeft, yBottomLeft, zBottomLeft);
537  }

References DGtal::Viewer3D< TSpace, TKSpace >::BOOST_CONCEPT_ASSERT(), DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myDirection, DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myDomainHeight, DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myDomainWidth, DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myMode, and DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::updateDomainOrientation().

Member Function Documentation

◆ translateDomain()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
void DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::translateDomain ( double  xTranslation = 0.0,
double  yTranslation = 0.0,
double  zTranslation = 0.0 
)

Translate domain postion.

Parameters
xTranslationthe image translation in the x direction (default 0).
yTranslationthe image translation in the y direction (default 0).
zTranslationthe image translation in the z direction (default 0).

◆ updateDomainOrientation()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
void DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::updateDomainOrientation ( ImageDirection  normalDir,
double  xBottomLeft,
double  yBottomLeft,
double  zBottomLeft 
)

Update the domain direction from a specific normal direction (Viewer3D::xDirection, Viewer3D::yDirection or Viewer3D::zDirection) and image position from the botton left point.

Parameters
normalDirgive a predifined normal orientation can be (Viewer3D::xDirection, Viewer3D::yDirection or Viewer3D::zDirection)
xBottomLeftthe x coordinate of bottom left image point.
yBottomLeftthe x coordinate of bottom left image point.
zBottomLeftthe x coordinate of bottom left image point.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::Image2DDomainD3D().

Field Documentation

◆ color

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
DGtal::Color DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::color

The image domain color.

Definition at line 506 of file Viewer3D.h.

◆ myDirection

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
ImageDirection DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myDirection

the direction of the domain (x, y or z axe)

Definition at line 512 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::Image2DDomainD3D().

◆ myDomainHeight

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
unsigned int DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myDomainHeight

the height of the image domain

Definition at line 510 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::Image2DDomainD3D().

◆ myDomainWidth

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
unsigned int DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myDomainWidth

the width of the image domain

Definition at line 508 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::Image2DDomainD3D().

◆ myLineSetIndex

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
std::size_t DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myLineSetIndex

the index of the line of the domain in the lineSetList of the viewer

Definition at line 516 of file Viewer3D.h.

◆ myMode

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
std::string DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::myMode

the mode of representation of the image domain

Definition at line 514 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::Image2DDomainD3D().

◆ point1

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
RealPoint DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::point1

The image domain coordinates.

Definition at line 501 of file Viewer3D.h.

◆ point2

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
RealPoint DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::point2

Definition at line 502 of file Viewer3D.h.

◆ point3

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
RealPoint DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::point3

Definition at line 503 of file Viewer3D.h.

◆ point4

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
RealPoint DGtal::Viewer3D< TSpace, TKSpace >::Image2DDomainD3D::point4

Definition at line 504 of file Viewer3D.h.


The documentation for this struct was generated from the following file:
DGtal::Viewer3D::Image2DDomainD3D::myDomainHeight
unsigned int myDomainHeight
the height of the image domain
Definition: Viewer3D.h:510
DGtal::Viewer3D::Image2DDomainD3D::myDomainWidth
unsigned int myDomainWidth
the width of the image domain
Definition: Viewer3D.h:508
DGtal::Viewer3D::BOOST_CONCEPT_ASSERT
BOOST_CONCEPT_ASSERT((concepts::CSpace< TSpace >))
DGtal::Viewer3D::Image2DDomainD3D::myMode
std::string myMode
the mode of representation of the image domain
Definition: Viewer3D.h:514
DGtal::Viewer3D::Image2DDomainD3D::myDirection
ImageDirection myDirection
the direction of the domain (x, y or z axe)
Definition: Viewer3D.h:512
DGtal::Viewer3D::Image2DDomainD3D::updateDomainOrientation
void updateDomainOrientation(ImageDirection normalDir, double xBottomLeft, double yBottomLeft, double zBottomLeft)