Displays the magnitudes of particle velocities. More...
#include <Colorizer.h>
Public Member Functions | |
| VelocityColorizer (Palette palette) | |
| 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 Optional< Vector > | evalVector (const Size idx) const override |
| 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 TypedColorizer< Vector > | |
| TypedColorizer (const QuantityId id, Palette palette) | |
| 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< float > | evalScalar (const Size idx) const override |
| virtual Optional< Palette > | getPalette () const override |
| Returns recommended palette for drawing this colorizer. More... | |
| virtual void | setPalette (const Palette &newPalette) override |
| Modifies the palette used by ths 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... | |
| Public Member Functions inherited from Polymorphic | |
| virtual | ~Polymorphic () |
Additional Inherited Members | |
| Protected Attributes inherited from TypedColorizer< Vector > | |
| QuantityId | id |
| Palette | palette |
| ArrayRef< const Vector > | values |
Detailed Description
Displays the magnitudes of particle velocities.
Definition at line 228 of file Colorizer.h.
Constructor & Destructor Documentation
◆ VelocityColorizer()
|
inlineexplicit |
Definition at line 230 of file Colorizer.h.
Member Function Documentation
◆ evalVector()
|
inlineoverridevirtual |
Reimplemented from TypedColorizer< Vector >.
Definition at line 241 of file Colorizer.h.
◆ getParticle()
|
inlineoverridevirtual |
Returns the original value of the displayed quantity.
If no such value exists, returns NOTHING.
Reimplemented from TypedColorizer< Vector >.
Definition at line 245 of file Colorizer.h.
◆ hasData()
|
inlineoverridevirtual |
Checks if the storage constains all data necessary to initialize the colorizer.
Reimplemented from TypedColorizer< Vector >.
Definition at line 233 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.
Reimplemented from TypedColorizer< Vector >.
Definition at line 237 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.
Reimplemented from TypedColorizer< Vector >.
Definition at line 249 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
