terry::generator::RampFunctor< Pixel > Struct Template Reference

#include <ramp.hpp>

Public Types
typedef boost::gil::point2 < double >	point_t
typedef RampFunctor	const_t
typedef Pixel	value_type
typedef value_type	reference
typedef value_type	const_reference
typedef point_t	argument_type
typedef reference	result_type
typedef contains_color< Pixel, red_t >::type	hasRGBChannel
typedef contains_color< Pixel, gray_color_t >::type	hasAlphaChannel
Public Member Functions
	BOOST_STATIC_CONSTANT (bool, is_mutable=false)
	RampFunctor ()
	RampFunctor (const point_t &tileSize, const value_type &start_color, const value_type &end_color, bool horizontal=true, bool _multiColor=false)
Pixel	operator() (const point_t &p) const
Data Fields
point_t	_tile_size
value_type	_start_color
value_type	_end_color
bool	_horizontal
bool	_multiColor

---

Detailed Description

template<typename Pixel>
struct terry::generator::RampFunctor< Pixel >

Definition at line 60 of file ramp.hpp.

---

Member Typedef Documentation

template<typename Pixel >

typedef point_t terry::generator::RampFunctor< Pixel >::argument_type

Definition at line 69 of file ramp.hpp.

template<typename Pixel >

typedef value_type terry::generator::RampFunctor< Pixel >::const_reference

Definition at line 68 of file ramp.hpp.

template<typename Pixel >

typedef RampFunctor terry::generator::RampFunctor< Pixel >::const_t

Definition at line 65 of file ramp.hpp.

template<typename Pixel >

typedef contains_color<Pixel, gray_color_t>::type terry::generator::RampFunctor< Pixel >::hasAlphaChannel

Definition at line 72 of file ramp.hpp.

template<typename Pixel >

typedef contains_color<Pixel, red_t>::type terry::generator::RampFunctor< Pixel >::hasRGBChannel

Definition at line 71 of file ramp.hpp.

template<typename Pixel >

typedef boost::gil::point2<double> terry::generator::RampFunctor< Pixel >::point_t

Definition at line 63 of file ramp.hpp.

template<typename Pixel >

typedef value_type terry::generator::RampFunctor< Pixel >::reference

Definition at line 67 of file ramp.hpp.

template<typename Pixel >

typedef reference terry::generator::RampFunctor< Pixel >::result_type

Definition at line 70 of file ramp.hpp.

template<typename Pixel >

typedef Pixel terry::generator::RampFunctor< Pixel >::value_type

Definition at line 66 of file ramp.hpp.

---

Constructor & Destructor Documentation

template<typename Pixel >

terry::generator::RampFunctor< Pixel >::RampFunctor

(

)

[inline]

Definition at line 83 of file ramp.hpp.

template<typename Pixel >

terry::generator::RampFunctor< Pixel >::RampFunctor	(	const point_t &	tileSize,
		const value_type &	start_color,
		const value_type &	end_color,
		bool	horizontal = true,
		bool	_multiColor = false
	)		[inline]

Definition at line 84 of file ramp.hpp.

---

Member Function Documentation

template<typename Pixel >

terry::generator::RampFunctor< Pixel >::BOOST_STATIC_CONSTANT	(	bool	,
		is_mutable	= false
	)

template<typename Pixel >

Pixel terry::generator::RampFunctor< Pixel >::operator()

(

const point_t &

p

)

const [inline]

Definition at line 92 of file ramp.hpp.

References terry::generator::RampFunctor< Pixel >::_end_color, terry::generator::RampFunctor< Pixel >::_horizontal, terry::generator::RampFunctor< Pixel >::_multiColor, terry::generator::RampFunctor< Pixel >::_start_color, terry::generator::RampFunctor< Pixel >::_tile_size, and terry::generator::clearChannel().

Here is the call graph for this function:

---

Field Documentation

template<typename Pixel >

value_type terry::generator::RampFunctor< Pixel >::_end_color

Definition at line 78 of file ramp.hpp.

Referenced by terry::generator::RampFunctor< Pixel >::operator()().

template<typename Pixel >

bool terry::generator::RampFunctor< Pixel >::_horizontal

Definition at line 80 of file ramp.hpp.

Referenced by terry::generator::RampFunctor< Pixel >::operator()().

template<typename Pixel >

bool terry::generator::RampFunctor< Pixel >::_multiColor

Definition at line 81 of file ramp.hpp.

Referenced by terry::generator::RampFunctor< Pixel >::operator()().

template<typename Pixel >

value_type terry::generator::RampFunctor< Pixel >::_start_color

Definition at line 77 of file ramp.hpp.

Referenced by terry::generator::RampFunctor< Pixel >::operator()().

template<typename Pixel >

point_t terry::generator::RampFunctor< Pixel >::_tile_size

Definition at line 75 of file ramp.hpp.

Referenced by terry::generator::RampFunctor< Pixel >::operator()().

---

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

• libraries/terry/src/terry/generator/ramp.hpp