IlvFilterFlow Class Reference

Bitmap filter flow class. More...

#include <ilviews/bitmaps/flow.h>

Inheritance diagram for IlvFilterFlow:

List of all members.

Public Member Functions
	IlvFilterFlow (ILVSTDPREF istream &stream, const IlString &name)
	Constructor.
	IlvFilterFlow (IlXmlElement *element)
	Constructor.
	IlvFilterFlow ()
	Constructor.
virtual	~IlvFilterFlow ()
	Destructor.
virtual void	addBitmapData (IlvBitmapData *data)
	Adds a bitmap data to the handled bitmap data list.
virtual void	addFilter (IlvBitmapFilter *filter)
	Adds a filter to the handled filters list.
IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **datas=0)
	Applies the filter to the given inputs.
virtual IlvBitmapData *	getBitmapData (const char *name) const
	Returns a handled bitmap data by its name.
virtual IlUInt	getBitmapDatasCardinal () const
	Returns the number of handled bitmap data.
const IlString &	getDescription () const
	Returns a description of the filter flow.
virtual IlvBitmapFilter *	getFilter (const char *name) const
	Returns a filter from its name.
virtual IlvBitmapFilter *const *	getFilters (IlUInt &count) const
	Returns an array of handled filters.
virtual IlUInt	getFiltersCardinal () const
	Returns the number of handled filters.
void	invalidate (IlvBitmapFilter *filter=0)
	Invalidates the given filter. When using apply() the first filter to be applied will be the first invalidated filter.
void	loadFromXml (IlXmlElement *element)
	Creates a filter flow from an XML node.
virtual void	removeBitmapData (const char *name)
	Removes a bitmap data from the list of handled bitmap data.
virtual void	removeFilter (IlvBitmapFilter *filter)
	Removes a filter from the handled filters list.
void	setDescription (const IlString &desc)
	Sets the description of the filter flow.
Static Public Member Functions
static IlvFilterFlow **	Read (ILVSTDPREF istream &stream, IlUInt &count)
	Returns an array of IlvFilterFlow instances from a stream.

---

Detailed Description

Bitmap filter flow class.

Library: display

The bitmap filter lets you manipulate a flow of bitmap filters. It manages bitmap filters and named bitmap data using named inputs and outputs. The input bitmap data will be referenced as Sourcegraphic. The input alpha bitmap data will be referenced as SourceAlpha.

See also:

IlvBitmapData, IlvBitmapFilter

---

Constructor & Destructor Documentation

IlvFilterFlow::IlvFilterFlow

(

)

Constructor.

Initializes a new IlvFilterFlow.

IlvFilterFlow::IlvFilterFlow

(

IlXmlElement *

element

)

Constructor.

Initializes a new IlvFilterFlow from the given XML description.

Parameters:

element

The XML element describing the filter flow.

IlvFilterFlow::IlvFilterFlow	(	ILVSTDPREF istream &	stream,
		const IlString &	name
	)

Constructor.

Initializes a new IlvFilterFlow from a stream containing a filter library.

Parameters:

	stream	The stream containing the filter library.
	name	The name of the filter.

virtual IlvFilterFlow::~IlvFilterFlow

(

)

[virtual]

Destructor.

The destructor releases all the memory used by the instance.

---

Member Function Documentation

virtual void IlvFilterFlow::addBitmapData

(

IlvBitmapData *

data

)

[virtual]

Adds a bitmap data to the handled bitmap data list.

Parameters:

data

The bitmap data to be handled.

virtual void IlvFilterFlow::addFilter

(

IlvBitmapFilter *

filter

)

[virtual]

Adds a filter to the handled filters list.

Parameters:

filter

The filter to be handled.

IlvBitmapData* IlvFilterFlow::apply	(	IlUInt	count = 0,
		const IlvBitmapData **	datas = 0
	)			[virtual]

Applies the filter to the given inputs.

Parameters:

	count	The number of inputs.
	datas	An array of count IlvBitmapData instances.

Returns:

The resulting bitmap data;

Reimplemented from IlvBitmapFilter.

virtual IlvBitmapData* IlvFilterFlow::getBitmapData

(

const char *

name

)

const [virtual]

Returns a handled bitmap data by its name.

Parameters:

name

The name of the bitmap data.

Returns:

The bitmap data.

virtual IlUInt IlvFilterFlow::getBitmapDatasCardinal

(

)

const [virtual]

Returns the number of handled bitmap data.

Returns:

The number of handled bitmap data.

const IlString& IlvFilterFlow::getDescription

(

)

const

Returns a description of the filter flow.

Returns:

A description of the filter flow.

virtual IlvBitmapFilter* IlvFilterFlow::getFilter

(

const char *

name

)

const [virtual]

Returns a filter from its name.

Parameters:

name

The name of the filter.

Returns:

The filter whose name is name.

virtual IlvBitmapFilter* const* IlvFilterFlow::getFilters

(

IlUInt &

count

)

const [virtual]

Returns an array of handled filters.

Parameters:

count

The number of handled filters.

Returns:

The array of handled filters.

virtual IlUInt IlvFilterFlow::getFiltersCardinal

(

)

const [virtual]

Returns the number of handled filters.

Returns:

The number of handled filters.

void IlvFilterFlow::invalidate

(

IlvBitmapFilter *

filter = 0

)

Invalidates the given filter. When using apply() the first filter to be applied will be the first invalidated filter.

Parameters:

filter

The filter to invalidate. If 0 the whole flow is invalidated.

void IlvFilterFlow::loadFromXml

(

IlXmlElement *

element

)

Creates a filter flow from an XML node.

Parameters:

element

The XML element describing the filter flow.

static IlvFilterFlow** IlvFilterFlow::Read	(	ILVSTDPREF istream &	stream,
		IlUInt &	count
	)			[static]

Returns an array of IlvFilterFlow instances from a stream.

Parameters:

	stream	The stream to read from.
	count	The number of read IlvFilterFlow instances.

Returns:

An array of count IlvFilterFlow instances.

virtual void IlvFilterFlow::removeBitmapData

(

const char *

name

)

[virtual]

Removes a bitmap data from the list of handled bitmap data.

Parameters:

name

The name of the bitmap data.

virtual void IlvFilterFlow::removeFilter

(

IlvBitmapFilter *

filter

)

[virtual]

Removes a filter from the handled filters list.

Parameters:

filter

The filter to be removed from the handled filters list.

void IlvFilterFlow::setDescription

(

const IlString &

desc

)

Sets the description of the filter flow.

Parameters:

desc

The description of the filter flow.