Colormappable Class Reference

#include <colormappable.hh>

Inheritance diagram for Colormappable:

Collaboration diagram for Colormappable:

Public Types
using	Ptr = std::shared_ptr< Colormappable >
using	WeakPtr = std::weak_ptr< Colormappable >

Public Member Functions
virtual void	setColormap (Colormap::Ptr colormap)=0
virtual Colormap::Ptr	getOriginalColormap ()=0
virtual int	getNumberOfColors ()=0
For monochrome presentations: Set/Get the current color
virtual Color	getMonochromeColor ()=0
virtual void	setMonochromeColor (const Color &c)=0
Manipulate the "Transparent Background" setting of the presentation
virtual void	setTransparentBackground ()=0
virtual void	disableTransparentBackground ()=0
virtual bool	getTransparentBackground ()=0

Additional Inherited Members
Private Member Functions inherited from Interface
	Interface ()=default
	Interface (const Interface &)=delete
Interface &	operator= (const Interface &)=delete
	Interface (Interface &&)=delete
Interface &	operator= (Interface &&)=delete
virtual	~Interface ()=default

Detailed Description

Interface for Colormappable presentations.

In order to use the colormap plugin, presentations should implement this interface, and define the COLORMAPPABLE_PROPERTY_NAME property.

Presentations should forward view creation and destruction events (i.e. Viewable::open() and Viewable::close() events) to their observers. As a result, new views will get a sidebar containing the available colormaps, and when one is selected, setColormap() will be called.

Member Typedef Documentation

Ptr

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

WeakPtr

using Colormappable::WeakPtr = std::weak_ptr<Colormappable>

Member Function Documentation

disableTransparentBackground()

virtual void Colormappable::disableTransparentBackground ( )

pure virtual

Implemented in ColormapHelperBase, MonochromeColormapHelper, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

getMonochromeColor()

virtual Color Colormappable::getMonochromeColor ( )

pure virtual

Implemented in ColormapHelperBase, MonochromeColormapHelper, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

getNumberOfColors()

virtual int Colormappable::getNumberOfColors ( )

pure virtual

Retrieve the number of colors in use by the presentation

Implemented in ColormapHelperBase, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

getOriginalColormap()

virtual Colormap::Ptr Colormappable::getOriginalColormap ( )

pure virtual

Retrieve the images colormap (if any)

Implemented in ColormapHelperBase, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

getTransparentBackground()

virtual bool Colormappable::getTransparentBackground ( )

pure virtual

Implemented in ColormapHelperBase, MonochromeColormapHelper, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

setColormap()

virtual void Colormappable::setColormap ( Colormap::Ptr  colormap )

pure virtual

Request that the presentation use the given colormap

Implemented in ColormapHelperBase, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

setMonochromeColor()

virtual void Colormappable::setMonochromeColor ( const Color &  c )

pure virtual

Implemented in ColormapHelperBase, MonochromeColormapHelper, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

setTransparentBackground()

virtual void Colormappable::setTransparentBackground ( )

pure virtual

Implemented in ColormapHelperBase, MonochromeColormapHelper, TransformPresentation, and anonymous_namespace{tiledbitmappresentation.cc}::TiledBitmapPresentation.

---

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

• libs/plugin-interfaces/inc/scroom/colormappable.hh