ParticleIdColorizer Class Reference

#include <Colorizer.h>

Inheritance diagram for ParticleIdColorizer:

Public Member Functions
INLINE Optional< Size >	evalId (const Size idx) const
virtual bool	hasData (const Storage &UNUSED(storage)) const override
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 Optional< Particle >	getParticle (const Size idx) const override
	Returns the original value of the displayed quantity. More...
virtual std::string	name () const override
	Returns the name of the colorizer. More...
Public Member Functions inherited from IdColorizerTemplate< ParticleIdColorizer >
	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< 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 bool	hasData (const Storage &storage) const =0
	Checks if the storage constains all data necessary to initialize the colorizer. More...
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 892 of file Colorizer.h.

Member Function Documentation

evalId()

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

inline

Definition at line 899 of file Colorizer.h.

getParticle()

Optional< Particle > ParticleIdColorizer::getParticle ( const Size  idx ) const

overridevirtual

Returns the original value of the displayed quantity.

If no such value exists, returns NOTHING.

Reimplemented from IdColorizerTemplate< ParticleIdColorizer >.

Definition at line 220 of file Colorizer.cpp.

hasData()

virtual bool ParticleIdColorizer::hasData ( const Storage &  UNUSEDstorage ) const

inlineoverridevirtual

Definition at line 907 of file Colorizer.h.

initialize()

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

overridevirtual

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.

Definition at line 214 of file Colorizer.cpp.

isInitialized()

virtual bool ParticleIdColorizer::isInitialized ( ) const

inlineoverridevirtual

Checks if the colorizer has been initialized.

Implements IColorizer.

Definition at line 913 of file Colorizer.h.

name()

virtual std::string ParticleIdColorizer::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 919 of file Colorizer.h.

---

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

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