BeautyColorizer Class Reference

#include <Colorizer.h>

Inheritance diagram for BeautyColorizer:

Public Member Functions
	BeautyColorizer ()
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< float >	evalScalar (const Size idx) const override
virtual Optional< Particle >	getParticle (const Size idx) const override
	Returns the original value of the displayed quantity. More...
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...
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...
Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()

Detailed Description

Definition at line 689 of file Colorizer.h.

Constructor & Destructor Documentation

BeautyColorizer()

BeautyColorizer::BeautyColorizer

(

)

Definition at line 104 of file Colorizer.cpp.

Member Function Documentation

evalColor()

virtual Rgba BeautyColorizer::evalColor ( const Size  idx ) const

inlineoverridevirtual

Returns the color of idx-th particle.

Implements IColorizer.

Definition at line 716 of file Colorizer.h.

evalScalar()

virtual Optional<float> BeautyColorizer::evalScalar ( const Size  idx ) const

inlineoverridevirtual

Definition at line 721 of file Colorizer.h.

getPalette()

virtual Optional<Palette> BeautyColorizer::getPalette ( ) const

inlineoverridevirtual

Returns recommended palette for drawing this colorizer.

In case there is no palette, returns NOTHING.

Implements IColorizer.

Definition at line 730 of file Colorizer.h.

getParticle()

virtual Optional<Particle> BeautyColorizer::getParticle ( const Size  idx ) const

inlineoverridevirtual

Returns the original value of the displayed quantity.

If no such value exists, returns NOTHING.

Implements IColorizer.

Definition at line 726 of file Colorizer.h.

hasData()

virtual bool BeautyColorizer::hasData ( const Storage &  storage ) const

inlineoverridevirtual

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

Implements IColorizer.

Definition at line 704 of file Colorizer.h.

initialize()

virtual void BeautyColorizer::initialize ( const Storage &  storage, const RefEnum  ref  )

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 708 of file Colorizer.h.

isInitialized()

virtual bool BeautyColorizer::isInitialized ( ) const

inlineoverridevirtual

Checks if the colorizer has been initialized.

Implements IColorizer.

Definition at line 712 of file Colorizer.h.

name()

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

setPalette()

virtual void BeautyColorizer::setPalette ( const Palette &  newPalette )

inlineoverridevirtual

Modifies the palette used by ths colorizer.

Implements IColorizer.

Definition at line 734 of file Colorizer.h.

---

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

• /home/pavel/projects/astro/sph/src/gui/objects/Colorizer.h
• /home/pavel/projects/astro/sph/src/gui/objects/Colorizer.cpp