lti::drawFlowField Class Reference

Draws the visualization of a two dimensional flowfield. More...

#include <ltiDrawFlowField.h>

Inheritance diagram for lti::drawFlowField:

[legend]

Collaboration diagram for lti::drawFlowField:

[legend]

List of all members.

Classes
class	parameters
	the parameters for the class drawFlowField More...
Public Member Functions
	drawFlowField ()
	drawFlowField (const drawFlowField &other)
virtual	~drawFlowField ()
virtual const char *	getTypeName () const
bool	apply (channel &x_component, channel &y_component) const
bool	apply (const channel &x_component, const channel &y_component, channel &flowfield) const
drawFlowField &	copy (const drawFlowField &other)
virtual functor *	clone () const
const parameters &	getParameters () const

---

Detailed Description

Draws the visualization of a two dimensional flowfield.

The channels of the x and y component are the input parameters, a picture of the flowfield is the output. The input channels must have the same dimensions.

---

Constructor & Destructor Documentation

lti::drawFlowField::drawFlowField

(

)

default constructor

lti::drawFlowField::drawFlowField

(

const drawFlowField &

other

)

copy constructor

Parameters:

other

the object to be copied

virtual lti::drawFlowField::~drawFlowField

(

)

[virtual]

destructor

---

Member Function Documentation

bool lti::drawFlowField::apply	(	const channel &	x_component,
		const channel &	y_component,
		channel &	flowfield
	)			const

operates on a copy of the given parameters.

Parameters:

	x_component	channel must be the flow component in x-direction.
	y_component	channel must be the flow component in y-direction.
	flowfield	contains the resulting visualization.

Returns:

true if successful, false otherwise

bool lti::drawFlowField::apply	(	channel &	x_component,
		channel &	y_component
	)			const

operates on the given parameters.

Parameters:

	x_component	channel must be the flow component in x-direction.
	y_component	channel must be the flow component in y-direction.

Returns:

true if successful, false otherwise

virtual functor* lti::drawFlowField::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

drawFlowField& lti::drawFlowField::copy

(

const drawFlowField &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

const parameters& lti::drawFlowField::getParameters

(

)

const

returns used parameters

Reimplemented from lti::functor.

virtual const char* lti::drawFlowField::getTypeName

(

)

const [virtual]

returns the name of this type ("drawFlowField")

Reimplemented from lti::functor.

---

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

• ltiDrawFlowField.h