SPH
Public Member Functions | List of all members
IdColorizerTemplate< TDerived > Class Template Reference

#include <Colorizer.h>

Inheritance diagram for IdColorizerTemplate< TDerived >:
IColorizer Polymorphic

Public Member Functions

 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< ParticlegetParticle (const Size idx) const override
 Returns the original value of the displayed quantity. 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 bool hasData (const Storage &storage) const =0
 Checks if the storage constains all data necessary to initialize the colorizer. More...
 
virtual void initialize (const Storage &storage, const RefEnum ref)=0
 Initialize the colorizer before by getting necessary quantities from storage. More...
 
virtual bool isInitialized () const =0
 Checks if the colorizer has been initialized. 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< 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...
 
virtual std::string name () const =0
 Returns the name of the colorizer. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

template<typename TDerived>
class IdColorizerTemplate< TDerived >

Definition at line 867 of file Colorizer.h.

Constructor & Destructor Documentation

◆ IdColorizerTemplate()

template<typename TDerived >
IdColorizerTemplate< TDerived >::IdColorizerTemplate ( const GuiSettings gui)
inlineexplicit

Definition at line 873 of file Colorizer.h.

Member Function Documentation

◆ evalColor()

template<typename TDerived >
Rgba IdColorizerTemplate< TDerived >::evalColor ( const Size  idx) const
overridevirtual

Returns the color of idx-th particle.

Implements IColorizer.

Reimplemented in ComponentIdColorizer.

Definition at line 190 of file Colorizer.cpp.

◆ getPalette()

template<typename TDerived >
virtual Optional<Palette> IdColorizerTemplate< TDerived >::getPalette ( ) const
inlineoverridevirtual

Returns recommended palette for drawing this colorizer.

In case there is no palette, returns NOTHING.

Implements IColorizer.

Definition at line 885 of file Colorizer.h.

◆ getParticle()

template<typename TDerived >
Optional< Particle > IdColorizerTemplate< TDerived >::getParticle ( const Size  idx) const
overridevirtual

Returns the original value of the displayed quantity.

If no such value exists, returns NOTHING.

Implements IColorizer.

Reimplemented in MaterialColorizer, ComponentIdColorizer, and ParticleIdColorizer.

Definition at line 200 of file Colorizer.cpp.

◆ setPalette()

template<typename TDerived >
virtual void IdColorizerTemplate< TDerived >::setPalette ( const Palette UNUSEDnewPalette)
inlineoverridevirtual

Definition at line 889 of file Colorizer.h.

◆ setSeed()

template<typename TDerived >
void IdColorizerTemplate< TDerived >::setSeed ( const Size  newSeed)
inline

Definition at line 877 of file Colorizer.h.


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