Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvOffsetFilter Class Reference

Offset filter. More...

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

Inheritance diagram for IlvOffsetFilter:
IlvBitmapFilter IlvValueInterface

Public Member Functions

 IlvOffsetFilter (IlInt dx=0, IlInt dy=0)
 Constructor. More...
 
IlvBitmapDataapply (IlUInt count=0, const IlvBitmapData **inputs=0)
 Applies the offset to the given image.
 
IlInt getdX () const
 Returns the x direction offset. More...
 
void getdXY (IlInt &dx, IlInt &dy) const
 Returns the offsets. More...
 
IlInt getdY () const
 Returns the y direction offset. More...
 
void setdX (IlInt dx)
 Sets the x direction offset. More...
 
void setdXY (IlInt dx, IlInt dy)
 Sets the offsets. More...
 
void setdY (IlInt dy)
 Sets the y direction offset. 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.
 
- Public Member Functions inherited from IlvValueInterface
virtual IlBoolean applyValue (const IlvValue &value)
 Apply an accessor. More...
 
virtual IlBoolean changeValue (const IlvValue &val)
 Changes the value of an accessor. More...
 
virtual IlBoolean changeValues (const IlvValue *values, IlUShort count=0)
 Changes several accessor values simultaneously. More...
 
virtual void getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const
 Retrieves the list of available accessors of an object. More...
 
virtual IlvValuequeryValue (IlvValue &val) const
 Retrieves an accessor value. More...
 
virtual void queryValues (IlvValue *values, IlUShort count) const
 Retrieves multiple accessor values simultaneously. More...
 

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

Offset filter.

Library: ilvbmpflt

This bitmap filter lets you offset an image position.

See also
IlvRGBBitmapData, IlvBitmapFilter

Constructor & Destructor Documentation

◆ IlvOffsetFilter()

IlvOffsetFilter::IlvOffsetFilter ( IlInt  dx = 0,
IlInt  dy = 0 
)

Constructor.

Initializes a new instance of the class IlvOffsetFilter. The default offset in both directions is 0.

Member Function Documentation

◆ getdX()

IlInt IlvOffsetFilter::getdX ( ) const

Returns the x direction offset.

Returns
The x direction offset.

◆ getdXY()

void IlvOffsetFilter::getdXY ( IlInt dx,
IlInt dy 
) const

Returns the offsets.

Parameters
dxThe x direction offset.
dyThe y direction offset.

◆ getdY()

IlInt IlvOffsetFilter::getdY ( ) const

Returns the y direction offset.

Returns
The y direction offset.

◆ setdX()

void IlvOffsetFilter::setdX ( IlInt  dx)

Sets the x direction offset.

Parameters
dxThe new x direction offset.

◆ setdXY()

void IlvOffsetFilter::setdXY ( IlInt  dx,
IlInt  dy 
)

Sets the offsets.

Parameters
dxThe new x direction offset.
dyThe new y direction offset.

◆ setdY()

void IlvOffsetFilter::setdY ( IlInt  dy)

Sets the y direction offset.

Parameters
dyThe new y direction offset.