ColormapHelper Class Reference

#include <colormappable.hh>

Inheritance diagram for ColormapHelper:

Collaboration diagram for ColormapHelper:

Public Member Functions
std::map< std::string, std::string >	getProperties () override
Public Member Functions inherited from ColormapHelperBase
	ColormapHelperBase (Colormap::Ptr const &colormap)
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

Static Public Member Functions
static Ptr	create (int numberOfColors)
static Ptr	createInverted (int numberOfColors)
static Ptr	create (Colormap::Ptr const &colormap)

Private Member Functions
	ColormapHelper (Colormap::Ptr const &colormap)

Additional Inherited Members
Public Types inherited from ColormapHelperBase
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 Attributes inherited from ColormapHelperBase
Colormap::Ptr	colormap
Colormap::Ptr	originalColormap

Constructor & Destructor Documentation

ColormapHelper()

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

explicitprivate

  : ColormapHelperBase(colormap_)
{
}

Member Function Documentation

create() [1/2]

ColormapHelper::Ptr ColormapHelper::create ( Colormap::Ptr const &  colormap )

static

{ return Ptr(new ColormapHelper(colormap)); }

create() [2/2]

ColormapHelper::Ptr ColormapHelper::create ( int  numberOfColors )

static

{ return create(Colormap::createDefault(numberOfColors)); }

Referenced by create(), createInverted(), Scroom::Tiff::getColormapHelper(), Scroom::Pnm::open(), and Scroom::Tiff::open().

Here is the call graph for this function:

Here is the caller graph for this function:

createInverted()

ColormapHelper::Ptr ColormapHelper::createInverted ( int  numberOfColors )

static

{
  return create(Colormap::createDefaultInverted(numberOfColors));
}

Here is the call graph for this function:

getProperties()

std::map< std::string, std::string > ColormapHelper::getProperties ( )

overridevirtual

Implements ColormapHelperBase.

{ return {{COLORMAPPABLE_PROPERTY_NAME, ""}}; }

---

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

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