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

Flood filter. More...

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

Inheritance diagram for IlvFloodFilter:
IlvBitmapFilter IlvValueInterface

Public Member Functions

 IlvFloodFilter (IlUInt r=0, IlUInt g=0, IlUInt b=0, IlUInt a=255)
 Constructor. More...
 
IlvBitmapDataapply (IlUInt count=0, const IlvBitmapData **inputs=0)
 Applies the flood to the given image.
 
IlUInt getA () const
 Returns the alpha component value of the fill color. More...
 
IlUInt getB () const
 Returns the blue component value of the fill color. More...
 
void getColor (IlUInt &r, IlUInt &g, IlUInt &b, IlUInt &a) const
 Returns the component values of the fill color. More...
 
IlUInt getG () const
 Returns the green component value of the fill color. More...
 
IlUInt getR () const
 Returns the red component value of the fill color. More...
 
void setA (IlUInt a)
 Sets the alpha component value of the fill color. More...
 
void setB (IlUInt b)
 Sets the blue component value of the fill color. More...
 
void setColor (IlUInt r, IlUInt g, IlUInt b, IlUInt a=255)
 Sets the fill color. More...
 
void setG (IlUInt g)
 Sets the green component value of the fill color. More...
 
void setR (IlUInt r)
 Sets the red component value of the fill color. 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

Flood filter.

Library: ilvbmpflt

This bitmap filter lets you create an image filled with specified component values.

See also
IlvRGBBitmapData, IlvBitmapFilter

Constructor & Destructor Documentation

◆ IlvFloodFilter()

IlvFloodFilter::IlvFloodFilter ( IlUInt  r = 0,
IlUInt  g = 0,
IlUInt  b = 0,
IlUInt  a = 255 
)

Constructor.

Initializes a new instance of the class IlvFloodFilter. The default component values are all set to 0 for color and 255 for opacity.

Member Function Documentation

◆ getA()

IlUInt IlvFloodFilter::getA ( ) const

Returns the alpha component value of the fill color.

Returns
The alpha component value.

◆ getB()

IlUInt IlvFloodFilter::getB ( ) const

Returns the blue component value of the fill color.

Returns
The blue component value.

◆ getColor()

void IlvFloodFilter::getColor ( IlUInt r,
IlUInt g,
IlUInt b,
IlUInt a 
) const

Returns the component values of the fill color.

Parameters
rThe red component value.
gThe green component value.
bThe blue component value.
aThe alpha component value.

◆ getG()

IlUInt IlvFloodFilter::getG ( ) const

Returns the green component value of the fill color.

Returns
The green component value.

◆ getR()

IlUInt IlvFloodFilter::getR ( ) const

Returns the red component value of the fill color.

Returns
The red component value.

◆ setA()

void IlvFloodFilter::setA ( IlUInt  a)

Sets the alpha component value of the fill color.

Parameters
aThe new alpha component value.

◆ setB()

void IlvFloodFilter::setB ( IlUInt  b)

Sets the blue component value of the fill color.

Parameters
bThe new blue component value.

◆ setColor()

void IlvFloodFilter::setColor ( IlUInt  r,
IlUInt  g,
IlUInt  b,
IlUInt  a = 255 
)

Sets the fill color.

Parameters
rThe new red component value
gThe new green component value
bThe new blue component value
aThe new alpha component value

◆ setG()

void IlvFloodFilter::setG ( IlUInt  g)

Sets the green component value of the fill color.

Parameters
gThe new green component value.

◆ setR()

void IlvFloodFilter::setR ( IlUInt  r)

Sets the red component value of the fill color.

Parameters
rThe new red component value.