SPH
Public Member Functions | List of all members
MaterialColorizer Class Reference

#include <Colorizer.h>

Inheritance diagram for MaterialColorizer:
IndexColorizer IdColorizerTemplate< IndexColorizer > IColorizer Polymorphic

Public Member Functions

 MaterialColorizer (const GuiSettings &gui)
 
virtual void initialize (const Storage &storage, const RefEnum ref) override
 Initialize the colorizer before by getting necessary quantities from storage. More...
 
virtual Optional< ParticlegetParticle (const Size idx) const override
 Returns the original value of the displayed quantity. More...
 
- Public Member Functions inherited from IndexColorizer
 IndexColorizer (const QuantityId id, const GuiSettings &gui)
 
INLINE Optional< SizeevalId (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 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< PalettegetPalette () 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< VectorevalVector (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 1043 of file Colorizer.h.

Constructor & Destructor Documentation

◆ MaterialColorizer()

MaterialColorizer::MaterialColorizer ( const GuiSettings gui)
inline

Definition at line 1049 of file Colorizer.h.

Member Function Documentation

◆ getParticle()

Optional< Particle > MaterialColorizer::getParticle ( const Size  idx) const
overridevirtual

Returns the original value of the displayed quantity.

If no such value exists, returns NOTHING.

Reimplemented from IdColorizerTemplate< IndexColorizer >.

Definition at line 320 of file Colorizer.cpp.

◆ initialize()

void MaterialColorizer::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
storageParticle storage containing source data to be drawn.
refSpecifies 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 IndexColorizer.

Definition at line 305 of file Colorizer.cpp.


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