Colormap Class Reference

#include <colormappable.hh>

Collaboration diagram for Colormap:

Public Types
using	Ptr = std::shared_ptr< Colormap >
using	ConstPtr = std::shared_ptr< const Colormap >
using	WeakPtr = std::weak_ptr< Colormap >

Public Member Functions
Ptr	clone () const
void	setAlpha (double alpha)
Ptr	setAlpha (double alpha) const

Static Public Member Functions
static Colormap::Ptr	create ()
static Colormap::Ptr	createDefault (int n)
static Colormap::Ptr	createDefaultInverted (int n)

Public Attributes
std::string	name
std::vector< Color >	colors

Private Member Functions
	Colormap ()

Detailed Description

Represent a colormap

Member Typedef Documentation

ConstPtr

using Colormap::ConstPtr = std::shared_ptr<const Colormap>

Ptr

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

WeakPtr

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

Constructor & Destructor Documentation

Colormap()

Colormap::Colormap ( )

inlineprivate

Constructor. Create an empty colormap

    : name("Empty")
  {
  }

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

clone()

Ptr Colormap::clone ( ) const

inline

{ return std::make_shared<Colormap>(*this); }

Referenced by setAlpha().

Here is the caller graph for this function:

create()

static Colormap::Ptr Colormap::create ( )

inlinestatic

Constructor. Create a smart pointer to an empty colormap

{ return Ptr(new Colormap()); }

Referenced by createDefault(), createDefaultInverted(), Scroom::Tiff::getColorMap(), Scroom::ColormapImpl::Colormaps::load(), and Scroom::Pnm::open().

Here is the call graph for this function:

Here is the caller graph for this function:

createDefault()

static Colormap::Ptr Colormap::createDefault ( int  n )

inlinestatic

Constructor. Create a smart pointer to a colormap of n grays.

  {
    Colormap::Ptr result = create();
    result->name = "Default";
    result->colors.reserve(n);
    result->colors.clear();
    const double max = n - 1;
    for(int i = 0; i < n; i++)
    {
      result->colors.emplace_back(i / max); // Min is black
    }
 
    return result;
  }

Referenced by ColormapHelper::create(), MonochromeColormapHelper::generateInitialColormap(), setupTest1bpp(), setupTest2bpp(), setupTest4bpp(), setupTest8bpp(), and setupTest8bppColormapped().

Here is the call graph for this function:

Here is the caller graph for this function:

createDefaultInverted()

static Colormap::Ptr Colormap::createDefaultInverted ( int  n )

inlinestatic

Constructor. Create a smart pointer to a colormap of n grays.

  {
    Colormap::Ptr result = create();
    result->name = "0 is white";
    result->colors.reserve(n);
    result->colors.clear();
    const double max = n - 1;
    for(int i = 0; i < n; i++)
    {
      result->colors.emplace_back((max - i) / max); // Min is white
    }
 
    return result;
  }

Referenced by ColormapHelper::createInverted(), and MonochromeColormapHelper::generateInitialColormap().

Here is the call graph for this function:

Here is the caller graph for this function:

setAlpha() [1/2]

void Colormap::setAlpha ( double  alpha )

inline

  {
    for(Color& c: colors)
    {
      c.setAlpha(alpha);
    }
  }

setAlpha() [2/2]

Ptr Colormap::setAlpha ( double  alpha ) const

inline

  {
    Ptr result = clone();
    result->setAlpha(alpha);
    return result;
  }

Here is the call graph for this function:

Member Data Documentation

colors

std::vector<Color> Colormap::colors

Colors in this colormap

Referenced by setAlpha().

name

std::string Colormap::name

Name of this colormap

---

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

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