IlvDisplaceFilter Class Reference

Displace filter. More...

#include <ilviews/bitmaps/filters/displace.h>

Inheritance diagram for IlvDisplaceFilter:

List of all members.

Public Member Functions
	IlvDisplaceFilter (IlFloat scale=0.0, IlvRGBBitmapData::Channel xChannelSelector=IlvRGBBitmapData::Alpha, IlvRGBBitmapData::Channel yChannelSelector=IlvRGBBitmapData::Alpha)
	Constructor.
virtual	~IlvDisplaceFilter ()
	Destructor.
IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **inputs=0)
	Applies the displacement to the given images.
IlFloat	getScale () const
	Returns the scaling factor.
IlvRGBBitmapData::Channel	getXChannelSelector () const
	Returns the channel selector for the x displacement.
IlvRGBBitmapData::Channel	getYChannelSelector () const
	Returns the channel selector for the y displacement.
void	setScale (IlFloat scale)
	Sets the scaling factor for the displacement.
void	setXChannelSelector (IlvRGBBitmapData::Channel selector)
	Sets the channel selector for the x displacement.
void	setYChannelSelector (IlvRGBBitmapData::Channel selector)
	Sets the channel selector for the y displacement.

---

Detailed Description

Displace filter.

Library: ilvbmpflt

This bitmap filter uses the pixel values from an image to spatially displace another image: P'(x, y) = P(x + scale * (XC(x, y) - 0.5), y + scale * (YC(x, y) - 0.5)) where P(x, y) is the input image and P'(x, y) is the destination. XC(x, y) and YC(x, y) are the component values designated by the channel selectors.

See also:

IlvRGBBitmapData, IlvBitmapFilter

---

Constructor & Destructor Documentation

IlvDisplaceFilter::IlvDisplaceFilter	(	IlFloat	scale = 0.0,
		IlvRGBBitmapData::Channel	xChannelSelector = IlvRGBBitmapData::Alpha,
		IlvRGBBitmapData::Channel	yChannelSelector = IlvRGBBitmapData::Alpha
	)

Constructor.

Initializes a new instance of the class IlvDisplaceFilter.

Parameters:

	scale	The scaling factor.
	xChannelSelector	The x direction channel selector.
	yChannelSelector	The y direction channel selector.

virtual IlvDisplaceFilter::~IlvDisplaceFilter

(

)

[virtual]

Destructor.

The destructor releases all the memory used by the instance.

---

Member Function Documentation

IlFloat IlvDisplaceFilter::getScale

(

)

const

Returns the scaling factor.

Returns:

The scaling factor.

IlvRGBBitmapData::Channel IlvDisplaceFilter::getXChannelSelector

(

)

const

Returns the channel selector for the x displacement.

Returns:

The x channel selector.

IlvRGBBitmapData::Channel IlvDisplaceFilter::getYChannelSelector

(

)

const

Returns the channel selector for the y displacement.

Returns:

The y channel selector.

void IlvDisplaceFilter::setScale

(

IlFloat

scale

)

Sets the scaling factor for the displacement.

Parameters:

scale

The new scaling factor.

void IlvDisplaceFilter::setXChannelSelector

(

IlvRGBBitmapData::Channel

selector

)

Sets the channel selector for the x displacement.

Parameters:

selector

The new channel selector.

void IlvDisplaceFilter::setYChannelSelector

(

IlvRGBBitmapData::Channel

selector

)

Sets the channel selector for the y displacement.

Parameters:

selector

The new channel selector.