IndexColorizer Class Reference

#include <Colorizer.h>

Inheritance diagram for IndexColorizer:

Public Member Functions
	IndexColorizer (const QuantityId id, const GuiSettings &gui)
INLINE Optional< Size >	evalId (const Size idx) const
virtual bool	hasData (const Storage &storage) const override
	Checks if the storage constains all data necessary to initialize the colorizer. More...
virtual void	initialize (const Storage &storage, const RefEnum ref) override
	Initialize the colorizer before by getting necessary quantities from storage. More...
virtual bool	isInitialized () const override
	Checks if the colorizer has been initialized. More...
virtual std::string	name () const override
	Returns the name of the colorizer. More...
Public Member Functions inherited from IdColorizerTemplate< IndexColorizer >
	IdColorizerTemplate (const GuiSettings &gui)
void	setSeed (const Size newSeed)
virtual Rgba	evalColor (const Size idx) const override
	Returns the color of idx-th particle. More...
virtual Optional< Particle >	getParticle (const Size idx) const override
	Returns the original value of the displayed quantity. More...
virtual Optional< Palette >	getPalette () const override
	Returns recommended palette for drawing this colorizer. More...
virtual void	setPalette (const Palette &UNUSED(newPalette)) override
Public Member Functions inherited from IColorizer
virtual Optional< float >	evalScalar (const Size UNUSED(idx)) const
	Returns the scalar representation of the colorized quantity for idx-th particle. More...
virtual Optional< Vector >	evalVector (const Size UNUSED(idx)) const
	Returns the vector representation of the colorized quantity for idx-th particle. More...
virtual void	setPalette (const Palette &newPalette)=0
	Modifies the palette used by ths colorizer. More...
Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()

Detailed Description

Definition at line 1012 of file Colorizer.h.

Constructor & Destructor Documentation

IndexColorizer()

IndexColorizer::IndexColorizer ( const QuantityId  id, const GuiSettings &  gui  )

inline

Definition at line 1018 of file Colorizer.h.

Member Function Documentation

evalId()

INLINE Optional<Size> IndexColorizer::evalId ( const Size  idx ) const

inline

Definition at line 1022 of file Colorizer.h.

hasData()

virtual bool IndexColorizer::hasData ( const Storage &  storage ) const

inlineoverridevirtual

Checks if the storage constains all data necessary to initialize the colorizer.

Implements IColorizer.

Definition at line 1026 of file Colorizer.h.

initialize()

virtual void IndexColorizer::initialize ( const Storage &  storage, const RefEnum  ref  )

inlineoverridevirtual

Initialize the colorizer before by getting necessary quantities from storage.

Can only be called if hasData returns true. Must be called before evalColor is called, every time step as ArrayViews taken from storage might be invalidated.

Parameters

storage	Particle storage containing source data to be drawn.
ref	Specifies how the object refereneces the data required for evaluation; either the buffers are copied and stored in the colorizer, or only references to the the storage are kept.

Implements IColorizer.

Reimplemented in MaterialColorizer.

Definition at line 1030 of file Colorizer.h.

isInitialized()

virtual bool IndexColorizer::isInitialized ( ) const

inlineoverridevirtual

Checks if the colorizer has been initialized.

Implements IColorizer.

Definition at line 1034 of file Colorizer.h.

name()

virtual std::string IndexColorizer::name ( ) const

inlineoverridevirtual

Returns the name of the colorizer.

This is used when showing the colorizer in the window and as filename suffix.

Implements IColorizer.

Definition at line 1038 of file Colorizer.h.

---

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

• /home/pavel/projects/astro/sph/src/gui/objects/Colorizer.h