IlvBitmapFilter Class Reference

Bitmap filter base class. More...

#include <ilviews/bitmaps/filter.h>

Inheritance diagram for IlvBitmapFilter:

List of all members.

Public Member Functions
	IlvBitmapFilter ()
	Constructor.
virtual	~IlvBitmapFilter ()
	Destructor.
virtual IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **datas=0)
	Applies the filter to the given inputs.
IlvBitmapData *	applyUnary (const IlvBitmapData *data)
	Convenience method for unary filters.
virtual const char *	getClassName () const
	Returns the class name of the filter.
IlUInt	getHeight () const
	Returns the height of the filter effect region.
const char *const *	getInputs (IlUInt &count) const
	Returns the name of the input bitmap data.
const char *	getName () const
	Returns the name of the filter.
IlUInt	getRefCount () const
	Returns the reference count for this instance.
const char *	getResult () const
	Returns the name of the result bitmap data.
IlUInt	getWidth () const
	Returns the width of the filter effect region.
IlInt	getX () const
	Returns the left coordinate of the filter effect region.
IlInt	getY () const
	Returns the top coordinate of the filter effect region.
void	lock ()
	Locks the current instance.
void	setHeight (IlUInt height)
	Sets the height of the filter effect region.
void	setInputs (IlUInt count, const char *const *name)
	Sets the input names of the filter.
void	setName (const char *id)
	Sets the name of the filter.
void	setResult (const char *name)
	Sets the result name of the filter.
void	setWidth (IlUInt width)
	Sets the width of the filter effect region.
void	setX (IlInt x)
	Sets the left coordinate of the filter effect region.
void	setY (IlInt y)
	Sets the top coordinate of the filter effect region.
void	unLock ()
	Unlocks the current instance. When the reference count is 0, the instance is deleted.
Static Public Member Functions
static IlvBitmapFilter *	Create (const char *classname, IlBoolean forceLoad=((IlBoolean) 1))
	This static method creates an instance of a bitmap filter of given classname. If the filter class is not registered and forceLoad is IlTrue, an attempt to load a dynamic module for this filter is made.
static const char **	GetRegisteredFilters (IlUInt &num)
	This static method returns an array of registered filter class names.

---

Detailed Description

Bitmap filter base class.

Library: display

The bitmap filter lets you manipulate bitmap data. This class provides general attribute management and must be subclassed. Each filter exposes its input and output bitmap data using names. The class IlvFilterFlow manages a list of filters and a list of bitmap data items.

See also:

IlvRGBBitmapData, IlvFilterFlow

---

Constructor & Destructor Documentation

IlvBitmapFilter::IlvBitmapFilter

(

)

Constructor.

Initializes a new IlvBitmapFilter.

virtual IlvBitmapFilter::~IlvBitmapFilter

(

)

[virtual]

Destructor.

The destructor releases all the memory used by the instance.

---

Member Function Documentation

virtual IlvBitmapData* IlvBitmapFilter::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 in IlvBlendFilter, IlvColorMatrixFilter, IlvComponentTransferFilter, IlvComposeFilter, IlvConvolutionFilter, IlvDisplaceFilter, IlvFloodFilter, IlvGaussianBlurFilter, IlvImageFilter, IlvDiffuseLightingFilter, IlvSpecularLightingFilter, IlvMergeFilter, IlvMorphologyFilter, IlvOffsetFilter, IlvTileFilter, IlvTurbulenceFilter, and IlvFilterFlow.

IlvBitmapData* IlvBitmapFilter::applyUnary

(

const IlvBitmapData *

data

)

Convenience method for unary filters.

Parameters:

data

The bitmap data to apply the filter on.

Returns:

The resulting bitmap data.

static IlvBitmapFilter* IlvBitmapFilter::Create	(	const char *	classname,
		IlBoolean	forceLoad = ((IlBoolean) 1)
	)			[static]

This static method creates an instance of a bitmap filter of given classname. If the filter class is not registered and forceLoad is IlTrue, an attempt to load a dynamic module for this filter is made.

Parameters:

	classname	The class name of the filter.
	forceLoad	IlTrue if dynamic loading is attempted.

Returns:

A pointer to the created bitmap filter.

virtual const char* IlvBitmapFilter::getClassName

(

)

const [virtual]

Returns the class name of the filter.

Returns:

The class name of the filter.

IlUInt IlvBitmapFilter::getHeight

(

)

const

Returns the height of the filter effect region.

Returns:

The height of the filter effect region.

const char* const* IlvBitmapFilter::getInputs

(

IlUInt &

count

)

const

Returns the name of the input bitmap data.

Parameters:

count

The number of input names.

Returns:

An array of input names.

const char* IlvBitmapFilter::getName

(

)

const

Returns the name of the filter.

Returns:

The name of the filter.

static const char** IlvBitmapFilter::GetRegisteredFilters

(

IlUInt &

num

)

[static]

This static method returns an array of registered filter class names.

Parameters:

num

The size of the returned array.

Returns:

An array of class names.

const char* IlvBitmapFilter::getResult

(

)

const

Returns the name of the result bitmap data.

Returns:

The name of the result bitmap data.

IlUInt IlvBitmapFilter::getWidth

(

)

const

Returns the width of the filter effect region.

Returns:

The width of the filter effect region.

IlInt IlvBitmapFilter::getX

(

)

const

Returns the left coordinate of the filter effect region.

Returns:

The left coordinate of the filter effect region.

IlInt IlvBitmapFilter::getY

(

)

const

Returns the top coordinate of the filter effect region.

Returns:

The top coordinate of the filter effect region.

void IlvBitmapFilter::setHeight

(

IlUInt

height

)

Sets the height of the filter effect region.

Parameters:

height

The height of the filter effect region

void IlvBitmapFilter::setInputs	(	IlUInt	count,
		const char *const *	name
	)

Sets the input names of the filter.

Parameters:

	count	The number of input names.
	name	The names of the input bitmap data.

void IlvBitmapFilter::setName

(

const char *

id

)

Sets the name of the filter.

Parameters:

id

The new name of the filter.

void IlvBitmapFilter::setResult

(

const char *

name

)

Sets the result name of the filter.

Parameters:

name

The new name of the result bitmap data.

void IlvBitmapFilter::setWidth

(

IlUInt

width

)

Sets the width of the filter effect region.

Parameters:

width

The width of the filter effect region.

void IlvBitmapFilter::setX

(

IlInt

x

)

Sets the left coordinate of the filter effect region.

Parameters:

x

The left coordinate of the filter effect region.

void IlvBitmapFilter::setY

(

IlInt

y

)

Sets the top coordinate of the filter effect region.

Parameters:

y

The top coordinate of the filter effect region.