#include <Colorizer.h>
Public Member Functions | |
| 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 Rgba | evalColor (const Size idx) const override |
| Returns the color of idx-th particle. More... | |
| virtual Optional< Particle > | getParticle (const Size UNUSED(idx)) const override |
| virtual Optional< Palette > | getPalette () const override |
| Returns recommended palette for drawing this colorizer. More... | |
| virtual void | setPalette (const Palette &UNUSED(newPalette)) override |
| virtual std::string | name () const override |
| Returns the name of the colorizer. More... | |
 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 Optional< Particle > | getParticle (const Size idx) const =0 |
| Returns the original value of the displayed quantity. 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 771 of file Colorizer.h.
Member Function Documentation
◆ evalColor()
Returns the color of idx-th particle.
Implements IColorizer.
Definition at line 788 of file Colorizer.h.
◆ getPalette()
Returns recommended palette for drawing this colorizer.
In case there is no palette, returns NOTHING.
Implements IColorizer.
Definition at line 797 of file Colorizer.h.
◆ getParticle()
|
inlineoverridevirtual |
Definition at line 793 of file Colorizer.h.
◆ hasData()
|
inlineoverridevirtual |
Checks if the storage constains all data necessary to initialize the colorizer.
Implements IColorizer.
Definition at line 776 of file Colorizer.h.
◆ initialize()
|
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.
Definition at line 780 of file Colorizer.h.
◆ isInitialized()
|
inlineoverridevirtual |
Checks if the colorizer has been initialized.
Implements IColorizer.
Definition at line 784 of file Colorizer.h.
◆ name()
|
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 803 of file Colorizer.h.
◆ setPalette()
|
inlineoverridevirtual |
Definition at line 801 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
