Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Bitmap filter flow class. More...
#include <ilviews/bitmaps/flow.h>
Public Member Functions | |
IlvFilterFlow () | |
Constructor. More... | |
IlvFilterFlow (IlXmlElement *element) | |
Constructor. More... | |
IlvFilterFlow (ILVSTDPREF istream &stream, const IlString &name) | |
Constructor. More... | |
virtual | ~IlvFilterFlow () |
Destructor. More... | |
virtual void | addBitmapData (IlvBitmapData *data) |
Adds a bitmap data to the handled bitmap data list. More... | |
virtual void | addFilter (IlvBitmapFilter *filter) |
Adds a filter to the handled filters list. More... | |
IlvBitmapData * | apply (IlUInt count=0, const IlvBitmapData **datas=0) |
Applies the filter to the given inputs. More... | |
virtual IlvBitmapData * | getBitmapData (const char *name) const |
Returns a handled bitmap data by its name. More... | |
virtual IlUInt | getBitmapDatasCardinal () const |
Returns the number of handled bitmap data. More... | |
const IlString & | getDescription () const |
Returns a description of the filter flow. More... | |
virtual IlvBitmapFilter * | getFilter (const char *name) const |
Returns a filter from its name. More... | |
virtual IlvBitmapFilter *const * | getFilters (IlUInt &count) const |
Returns an array of handled filters. More... | |
virtual IlUInt | getFiltersCardinal () const |
Returns the number of handled filters. More... | |
void | invalidate (IlvBitmapFilter *filter=0) |
Invalidates the given filter. When using apply() the first filter to be applied will be the first invalidated filter. More... | |
void | loadFromXml (IlXmlElement *element) |
Creates a filter flow from an XML node. More... | |
virtual void | removeBitmapData (const char *name) |
Removes a bitmap data from the list of handled bitmap data. More... | |
virtual void | removeFilter (IlvBitmapFilter *filter) |
Removes a filter from the handled filters list. More... | |
void | setDescription (const IlString &desc) |
Sets the description of the filter flow. More... | |
Public Member Functions inherited from IlvBitmapFilter | |
IlvBitmapFilter () | |
Constructor. More... | |
virtual | ~IlvBitmapFilter () |
Destructor. More... | |
IlvBitmapData * | applyUnary (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 IlvValue & | queryValue (IlvValue &val) const |
Retrieves an accessor value. More... | |
virtual void | queryValues (IlvValue *values, IlUShort count) const |
Retrieves multiple accessor values simultaneously. More... | |
Static Public Member Functions | |
static IlvFilterFlow ** | Read (ILVSTDPREF istream &stream, IlUInt &count) |
Returns an array of IlvFilterFlow instances from a stream. More... | |
Static Public Member Functions inherited from IlvBitmapFilter | |
static IlvBitmapFilter * | Create (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... | |
Bitmap filter flow class.
Library: xviews or winviews or mviews (mutually exclusive)
The bitmap filter lets you manipulate a flow of bitmap filters. It manages bitmap filters and named bitmap data using named inputs and outputs. The input bitmap data will be referenced as Sourcegraphic
. The input alpha bitmap data will be referenced as SourceAlpha
.
IlvBitmapData
, IlvBitmapFilter
IlvFilterFlow::IlvFilterFlow | ( | ) |
Constructor.
Initializes a new IlvFilterFlow
.
IlvFilterFlow::IlvFilterFlow | ( | IlXmlElement * | element | ) |
Constructor.
Initializes a new IlvFilterFlow
from the given XML description.
element | The XML element describing the filter flow. |
IlvFilterFlow::IlvFilterFlow | ( | ILVSTDPREF istream & | stream, |
const IlString & | name | ||
) |
Constructor.
Initializes a new IlvFilterFlow
from a stream containing a filter library.
stream | The stream containing the filter library. |
name | The name of the filter. |
|
virtual |
Destructor.
The destructor releases all the memory used by the instance.
|
virtual |
Adds a bitmap data to the handled bitmap data list.
data | The bitmap data to be handled. |
|
virtual |
Adds a filter to the handled filters list.
filter | The filter to be handled. |
|
virtual |
Applies the filter to the given inputs.
count | The number of inputs. |
datas | An array of count IlvBitmapData instances. |
Reimplemented from IlvBitmapFilter.
|
virtual |
Returns a handled bitmap data by its name.
name | The name of the bitmap data. |
|
virtual |
Returns the number of handled bitmap data.
const IlString& IlvFilterFlow::getDescription | ( | ) | const |
Returns a description of the filter flow.
|
virtual |
Returns a filter from its name.
name | The name of the filter. |
|
virtual |
Returns an array of handled filters.
count | The number of handled filters. |
|
virtual |
Returns the number of handled filters.
void IlvFilterFlow::invalidate | ( | IlvBitmapFilter * | filter = 0 | ) |
Invalidates the given filter. When using apply()
the first filter to be applied will be the first invalidated filter.
filter | The filter to invalidate. If 0 the whole flow is invalidated. |
void IlvFilterFlow::loadFromXml | ( | IlXmlElement * | element | ) |
Creates a filter flow from an XML node.
element | The XML element describing the filter flow. |
|
static |
Returns an array of IlvFilterFlow
instances from a stream.
stream | The stream to read from. |
count | The number of read IlvFilterFlow instances. |
IlvFilterFlow
instances.
|
virtual |
Removes a bitmap data from the list of handled bitmap data.
name | The name of the bitmap data. |
|
virtual |
Removes a filter from the handled filters list.
filter | The filter to be removed from the handled filters list. |
void IlvFilterFlow::setDescription | ( | const IlString & | desc | ) |
Sets the description of the filter flow.
desc | The description of the filter flow. |
© Copyright 2016, 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.