ColormapHelperBase Class Reference

#include <colormappable.hh>

Inheritance diagram for ColormapHelperBase:

Collaboration diagram for ColormapHelperBase:

Public Types
using	Ptr = std::shared_ptr< ColormapHelperBase >
Public Types inherited from ColormapProvider
using	Ptr = std::shared_ptr< ColormapProvider >
Public Types inherited from Colormappable
using	Ptr = std::shared_ptr< Colormappable >
using	WeakPtr = std::weak_ptr< Colormappable >

Public Member Functions
	ColormapHelperBase (Colormap::Ptr const &colormap)
virtual std::map< std::string, std::string >	getProperties ()=0
void	setColormap (Colormap::Ptr colormap) override
Colormap::Ptr	getOriginalColormap () override
int	getNumberOfColors () override
Color	getMonochromeColor () override
void	setMonochromeColor (const Color &c) override
void	setTransparentBackground () override
void	disableTransparentBackground () override
bool	getTransparentBackground () override
Colormap::Ptr	getColormap () override
virtual void	setOriginalColormap (Colormap::Ptr colormap)
For monochrome presentations: Set/Get the current color
Manipulate the "Transparent Background" setting of the presentation

Public Attributes
Colormap::Ptr	colormap
Colormap::Ptr	originalColormap

Static Private Member Functions
static void	OperationNotSupported ()

Member Typedef Documentation

Ptr

using ColormapHelperBase::Ptr = std::shared_ptr<ColormapHelperBase>

Constructor & Destructor Documentation

ColormapHelperBase()

ColormapHelperBase::ColormapHelperBase ( Colormap::Ptr const &  colormap )

explicit

  : colormap(colormap_)
  , originalColormap(colormap_)
{
}

Member Function Documentation

disableTransparentBackground()

void ColormapHelperBase::disableTransparentBackground ( )

overridevirtual

Implements Colormappable.

Reimplemented in MonochromeColormapHelper.

{ OperationNotSupported(); }

Here is the call graph for this function:

getColormap()

Colormap::Ptr ColormapHelperBase::getColormap ( )

overridevirtual

Implements ColormapProvider.

{ return colormap; }

getMonochromeColor()

Color ColormapHelperBase::getMonochromeColor ( )

overridevirtual

Implements Colormappable.

Reimplemented in MonochromeColormapHelper.

{ OperationNotSupported(); }

Here is the call graph for this function:

getNumberOfColors()

int ColormapHelperBase::getNumberOfColors ( )

overridevirtual

Retrieve the number of colors in use by the presentation

Implements Colormappable.

{ return originalColormap->colors.size(); }

getOriginalColormap()

Colormap::Ptr ColormapHelperBase::getOriginalColormap ( )

overridevirtual

Retrieve the images colormap (if any)

Implements Colormappable.

{ return originalColormap; }

getProperties()

virtual std::map< std::string, std::string > ColormapHelperBase::getProperties ( )

pure virtual

Implemented in ColormapHelper, and MonochromeColormapHelper.

getTransparentBackground()

bool ColormapHelperBase::getTransparentBackground ( )

overridevirtual

Implements Colormappable.

Reimplemented in MonochromeColormapHelper.

{ OperationNotSupported(); }

Here is the call graph for this function:

OperationNotSupported()

void ColormapHelperBase::OperationNotSupported ( )

staticprivate

{ throw std::runtime_error("Operation not supported"); }

Referenced by disableTransparentBackground(), getMonochromeColor(), getTransparentBackground(), setMonochromeColor(), and setTransparentBackground().

Here is the caller graph for this function:

setColormap()

void ColormapHelperBase::setColormap ( Colormap::Ptr  colormap )

overridevirtual

Request that the presentation use the given colormap

Implements Colormappable.

{ colormap = colormap_; }

setMonochromeColor()

void ColormapHelperBase::setMonochromeColor ( const Color &  c )

overridevirtual

Implements Colormappable.

Reimplemented in MonochromeColormapHelper.

{ OperationNotSupported(); }

Here is the call graph for this function:

setOriginalColormap()

void ColormapHelperBase::setOriginalColormap ( Colormap::Ptr  colormap )

virtual

{ originalColormap = std::move(colormap_); }

setTransparentBackground()

void ColormapHelperBase::setTransparentBackground ( )

overridevirtual

Implements Colormappable.

Reimplemented in MonochromeColormapHelper.

{ OperationNotSupported(); }

Here is the call graph for this function:

Member Data Documentation

colormap

Colormap::Ptr ColormapHelperBase::colormap

Referenced by ColormapHelper::create(), getColormap(), MonochromeColormapHelper::regenerateColormap(), and setColormap().

originalColormap

Colormap::Ptr ColormapHelperBase::originalColormap

Referenced by getNumberOfColors(), getOriginalColormap(), and setOriginalColormap().

---

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

• libs/plugin-interfaces/inc/scroom/colormappable.hh
• libs/scroom/src/colormap-helpers.cc