grid_map::ColorBlendingFilter< T > Class Template Reference

#include <ColorBlendingFilter.hpp>

Inheritance diagram for grid_map::ColorBlendingFilter< T >:

List of all members.

Public Member Functions
	ColorBlendingFilter ()
virtual bool	configure ()
virtual bool	update (const T &mapIn, T &mapOut)
virtual	~ColorBlendingFilter ()
Private Types
enum	BlendModes { Normal, HardLight, SoftLight }
Private Attributes
std::string	backgroundLayer_
	Input layers.
BlendModes	blendMode_
	Blend mode.
std::string	foregroundLayer_
double	opacity_
	Opacity of foreground layer.
std::string	outputLayer_
	Output layer name.

---

Detailed Description

template<typename T>
class grid_map::ColorBlendingFilter< T >

Blend two color layers.

Definition at line 22 of file ColorBlendingFilter.hpp.

---

Member Enumeration Documentation

template<typename T >

enum grid_map::ColorBlendingFilter::BlendModes [private]

Enumerator:

Normal
HardLight
SoftLight

Definition at line 49 of file ColorBlendingFilter.hpp.

---

Constructor & Destructor Documentation

template<typename T >

grid_map::ColorBlendingFilter< T >::ColorBlendingFilter

(

)

Constructor

Definition at line 22 of file ColorBlendingFilter.cpp.

template<typename T >

grid_map::ColorBlendingFilter< T >::~ColorBlendingFilter

(

)

[virtual]

Destructor.

Definition at line 29 of file ColorBlendingFilter.cpp.

---

Member Function Documentation

template<typename T >

bool grid_map::ColorBlendingFilter< T >::configure

(

)

[virtual]

Configures the filter.

Implements filters::FilterBase< T >.

Definition at line 34 of file ColorBlendingFilter.cpp.

template<typename T >

bool grid_map::ColorBlendingFilter< T >::update	(	const T &	mapIn,
		T &	mapOut
	)		[virtual]

Compute a new color layer based on blending two color layers.

Parameters:

mapIn	grid map containing the two color layers.
mapOut	grid map containing mapIn and the blended color layer.

Implements filters::FilterBase< T >.

Definition at line 76 of file ColorBlendingFilter.cpp.

---

Member Data Documentation

template<typename T >

std::string grid_map::ColorBlendingFilter< T >::backgroundLayer_ [private]

Input layers.

Definition at line 56 of file ColorBlendingFilter.hpp.

template<typename T >

BlendModes grid_map::ColorBlendingFilter< T >::blendMode_ [private]

Blend mode.

Definition at line 59 of file ColorBlendingFilter.hpp.

template<typename T >

std::string grid_map::ColorBlendingFilter< T >::foregroundLayer_ [private]

Definition at line 56 of file ColorBlendingFilter.hpp.

template<typename T >

double grid_map::ColorBlendingFilter< T >::opacity_ [private]

Opacity of foreground layer.

Definition at line 62 of file ColorBlendingFilter.hpp.

template<typename T >

std::string grid_map::ColorBlendingFilter< T >::outputLayer_ [private]

Output layer name.

Definition at line 65 of file ColorBlendingFilter.hpp.

---

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

• ColorBlendingFilter.hpp
• ColorBlendingFilter.cpp