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

#include <Colorizer.h>

Inheritance diagram for AggregateIdColorizer:
IdColorizerTemplate< AggregateIdColorizer > IColorizer Polymorphic

Public Member Functions

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 void initialize (const Storage &storage, const RefEnum UNUSED(ref)) override
 
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< AggregateIdColorizer >
 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 void initialize (const Storage &storage, const RefEnum ref)=0
 Initialize the colorizer before by getting necessary quantities from storage. 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...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Definition at line 980 of file Colorizer.h.

Member Function Documentation

◆ evalId()

INLINE Optional<Size> AggregateIdColorizer::evalId ( const Size  idx) const
inline

Definition at line 987 of file Colorizer.h.

◆ hasData()

virtual bool AggregateIdColorizer::hasData ( const Storage storage) const
inlineoverridevirtual

Checks if the storage constains all data necessary to initialize the colorizer.

Implements IColorizer.

Definition at line 995 of file Colorizer.h.

◆ initialize()

virtual void AggregateIdColorizer::initialize ( const Storage storage,
const RefEnum   UNUSEDref 
)
inlineoverridevirtual

Definition at line 999 of file Colorizer.h.

◆ isInitialized()

virtual bool AggregateIdColorizer::isInitialized ( ) const
inlineoverridevirtual

Checks if the colorizer has been initialized.

Implements IColorizer.

Definition at line 1003 of file Colorizer.h.

◆ name()

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


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