rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvDisplaceFilter Class Reference

Displace filter. More...

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

Inheritance diagram for IlvDisplaceFilter:
IlvBitmapFilter

Public Member Functions

 IlvDisplaceFilter (IlFloat scale=0.0, IlvRGBBitmapData::Channel xChannelSelector=IlvRGBBitmapData::Alpha, IlvRGBBitmapData::Channel yChannelSelector=IlvRGBBitmapData::Alpha)
 Constructor. More...
 
virtual ~IlvDisplaceFilter ()
 Destructor. More...
 
IlvBitmapDataapply (IlUInt count=0, const IlvBitmapData **inputs=0)
 Applies the displacement to the given images.
 
IlFloat getScale () const
 Returns the scaling factor. More...
 
IlvRGBBitmapData::Channel getXChannelSelector () const
 Returns the channel selector for the x displacement. More...
 
IlvRGBBitmapData::Channel getYChannelSelector () const
 Returns the channel selector for the y displacement. More...
 
void setScale (IlFloat scale)
 Sets the scaling factor for the displacement. More...
 
void setXChannelSelector (IlvRGBBitmapData::Channel selector)
 Sets the channel selector for the x displacement. More...
 
void setYChannelSelector (IlvRGBBitmapData::Channel selector)
 Sets the channel selector for the y displacement. More...
 
- Public Member Functions inherited from IlvBitmapFilter
 IlvBitmapFilter ()
 Constructor. More...
 
virtual ~IlvBitmapFilter ()
 Destructor. More...
 
IlvBitmapDataapplyUnary (const IlvBitmapData *data)
 Convenience method for unary filters. More...
 
virtual const char * getClassName () const
 Returns the class name of the filter. More...
 
IlUInt getHeight () const
 Returns the height of the filter effect region. More...
 
const char *const * getInputs (IlUInt &count) const
 Returns the name of the input bitmap data. More...
 
const char * getName () const
 Returns the name of the filter. More...
 
IlUInt getRefCount () const
 Returns the reference count for this instance.
 
const char * getResult () const
 Returns the name of the result bitmap data. More...
 
IlUInt getWidth () const
 Returns the width of the filter effect region. More...
 
IlInt getX () const
 Returns the left coordinate of the filter effect region. More...
 
IlInt getY () const
 Returns the top coordinate of the filter effect region. More...
 
void lock ()
 Locks the current instance.
 
void setHeight (IlUInt height)
 Sets the height of the filter effect region. More...
 
void setInputs (IlUInt count, const char *const *name)
 Sets the input names of the filter. More...
 
void setName (const char *id)
 Sets the name of the filter. More...
 
void setResult (const char *name)
 Sets the result name of the filter. More...
 
void setWidth (IlUInt width)
 Sets the width of the filter effect region. More...
 
void setX (IlInt x)
 Sets the left coordinate of the filter effect region. More...
 
void setY (IlInt y)
 Sets the top coordinate of the filter effect region. More...
 
void unLock ()
 Unlocks the current instance. When the reference count is 0, the instance is deleted.
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvBitmapFilter
static IlvBitmapFilterCreate (const char *classname, IlBoolean forceLoad=IlTrue)
 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. More...
 
static const char ** GetRegisteredFilters (IlUInt &num)
 This static method returns an array of registered filter class names. More...
 

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
scaleThe scaling factor.
xChannelSelectorThe x direction channel selector.
yChannelSelectorThe 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
scaleThe new scaling factor.
void IlvDisplaceFilter::setXChannelSelector ( IlvRGBBitmapData::Channel  selector)

Sets the channel selector for the x displacement.

Parameters
selectorThe new channel selector.
void IlvDisplaceFilter::setYChannelSelector ( IlvRGBBitmapData::Channel  selector)

Sets the channel selector for the y displacement.

Parameters
selectorThe new channel selector.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.