Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvComponentTransferFilter Class Reference

Component transfer filter. More...

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

Inheritance diagram for IlvComponentTransferFilter:
IlvBitmapFilter IlvValueInterface

Public Member Functions

 IlvComponentTransferFilter ()
 Constructor. More...
 
 ~IlvComponentTransferFilter ()
 Destructor. More...
 
IlvBitmapDataapply (IlUInt count=0, const IlvBitmapData **inputs=0)
 Applies the component transfer to the given image.
 
IlvTransferFunctiongetAlphaFunction () const
 Returns the alpha component transfer function. More...
 
IlvTransferFunctiongetBlueFunction () const
 Returns the blue component transfer function. More...
 
IlvTransferFunctiongetGreenFunction () const
 Returns the green component transfer function. More...
 
IlvTransferFunctiongetRedFunction () const
 Returns the red component transfer function. More...
 
void setAlphaFunction (IlvTransferFunction *alphaFunction)
 Sets the alpha component transfer function. More...
 
void setBlueFunction (IlvTransferFunction *blueFunction)
 Sets the blue component transfer function. More...
 
void setGreenFunction (IlvTransferFunction *greenFunction)
 Sets the green component transfer function. More...
 
void setRedFunction (IlvTransferFunction *redFunction)
 Sets the red component transfer function. 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

Component transfer filter.

Library: ilvbmpflt

This bitmap filter lets you manipulate the individual color components of an image using lookup tables. Each component value in the source image is replaced by the corresponding value in the lookup table.

See also
IlvRGBBitmapData, IlvBitmapFilter, IlvTransferFunction

Constructor & Destructor Documentation

§ IlvComponentTransferFilter()

IlvComponentTransferFilter::IlvComponentTransferFilter ( )

Constructor.

Initializes a new instance of the class IlvComponentTransferFilter.

The default matrix is the identity matrix.

§ ~IlvComponentTransferFilter()

IlvComponentTransferFilter::~IlvComponentTransferFilter ( )

Destructor.

The destructor releases all the memory used by the instance.

Member Function Documentation

§ getAlphaFunction()

IlvTransferFunction* IlvComponentTransferFilter::getAlphaFunction ( ) const

Returns the alpha component transfer function.

Returns
The alpha component transfer function.

§ getBlueFunction()

IlvTransferFunction* IlvComponentTransferFilter::getBlueFunction ( ) const

Returns the blue component transfer function.

Returns
The blue component transfer function.

§ getGreenFunction()

IlvTransferFunction* IlvComponentTransferFilter::getGreenFunction ( ) const

Returns the green component transfer function.

Returns
The green component transfer function.

§ getRedFunction()

IlvTransferFunction* IlvComponentTransferFilter::getRedFunction ( ) const

Returns the red component transfer function.

Returns
The red component transfer function.

§ setAlphaFunction()

void IlvComponentTransferFilter::setAlphaFunction ( IlvTransferFunction alphaFunction)

Sets the alpha component transfer function.

Parameters
alphaFunctionThe new alpha component transfer function.

§ setBlueFunction()

void IlvComponentTransferFilter::setBlueFunction ( IlvTransferFunction blueFunction)

Sets the blue component transfer function.

Parameters
blueFunctionThe new blue component transfer function.

§ setGreenFunction()

void IlvComponentTransferFilter::setGreenFunction ( IlvTransferFunction greenFunction)

Sets the green component transfer function.

Parameters
greenFunctionThe new green component transfer function.

§ setRedFunction()

void IlvComponentTransferFilter::setRedFunction ( IlvTransferFunction redFunction)

Sets the red component transfer function.

Parameters
redFunctionThe new red component transfer function.

© Copyright 2017, 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.