The Fib multimedia system
Fib is a system for storing multimedia data (like images or films).
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes
fib::cEvalueSimpleRGBA255 Class Reference

#include <cEvalueSimpleRGBA255.h>

Inheritance diagram for fib::cEvalueSimpleRGBA255:
Inheritance graph
[legend]
Collaboration diagram for fib::cEvalueSimpleRGBA255:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 cEvalueSimpleRGBA255 (const unsigned int uiInMaxX, const unsigned int uiInMaxY)
 ~cEvalueSimpleRGBA255 ()
virtual bool evaluePosition (const cVectorPosition &vPosition, const list< cVectorProperty > &vProperties)
virtual void clear ()
bool colorWithBackgroundColor ()
virtual cDomains getPropertyDomains () const
virtual cDomains getPositionDomain () const
virtual bool setPoint (const cVectorPosition &vPosition, const list< cVectorProperty > &vProperties)
virtual list< cVectorProperty > getPointProperties (const cVectorPosition &vPosition) const
- Public Member Functions inherited from fib::iEvaluePosition
virtual ~iEvaluePosition ()
- Public Member Functions inherited from fib::iImageData
virtual ~iImageData ()

Public Attributes

const unsigned int uiMaxX
const unsigned int uiMaxY
unsigned char * pImageData
unsigned char pBackgroundColor [4]
bool bBackgroundColorExists

Detailed Description

Definition at line 63 of file cEvalueSimpleRGBA255.h.

Constructor & Destructor Documentation

fib::cEvalueSimpleRGBA255::cEvalueSimpleRGBA255 ( const unsigned int  uiInMaxX,
const unsigned int  uiInMaxY 
)

standard constructor

Parameters:
uiInMaxXthe maximum value for the first (x) dimension
See also:
uiMaxX
Parameters:
uiInMaxYthe maximum value for the second (y) dimension
See also:
uiMaxY
fib::cEvalueSimpleRGBA255::~cEvalueSimpleRGBA255 ( )

desstructor

Member Function Documentation

virtual void fib::cEvalueSimpleRGBA255::clear ( )
virtual

This method clears the data from the list with the evalued position data liEvaluedPositionData. After the function call the liEvaluedPositionData list will be empty.

See also:
liEvaluedPositionData

Implements fib::iImageData.

bool fib::cEvalueSimpleRGBA255::colorWithBackgroundColor ( )

Adds the background color pBackgroundColor to the image data matrix pImageData, if existing.

See also:
pBackgroundColor
pImageData
Returns:
true if the background color was added the image data matrix, else false
virtual bool fib::cEvalueSimpleRGBA255::evaluePosition ( const cVectorPosition &  vPosition,
const list< cVectorProperty > &  vProperties 
)
virtual

The method with wich the evalued points with ther properties are inserted. Everytime a point (to evalue) is reached in the evaluation, this method is called with the position and the properties of the point and stores the data into

See also:
pImageData This method will just evalue two dimensional points and properties for RGB and transparency. Points first dimension can have values from 0 ( including ) to the maximum value for the first (x) dimension. ( 0 =< vPosition.getValue( 1 ) < uiMaxX )
uiMaxX Points second dimension ( vPosition.getValue( 2 ) ) can have values from 0 ( including ) to the maximum value for the second (y) dimension. ( 0 =< vPosition.getValue( 2 ) < uiMaxY )
uiMaxY Background points (with 0 elements) are also possible. All other points will be discarded. Property (color RGB or transparency) element values should have a values from 0 to 255 (both including), else they will be rounded into the area.
pImageData
Parameters:
vPositionthe position of the point, which is evalued
vPropertiesa list of the properties of the point

Implements fib::iEvaluePosition.

virtual list<cVectorProperty> fib::cEvalueSimpleRGBA255::getPointProperties ( const cVectorPosition &  vPosition) const
virtual

With this method the properties for given points are returned.

Parameters:
vPositionthe position of the point, for which the properties should be returned
Returns:
a list of the properties of the point

Implements fib::iImageData.

virtual cDomains fib::cEvalueSimpleRGBA255::getPositionDomain ( ) const
virtual

This method returns the domains for the positions (dimension domain).

Returns:
the domains for the positions (dimension domain)

Implements fib::iImageData.

virtual cDomains fib::cEvalueSimpleRGBA255::getPropertyDomains ( ) const
virtual

This method returns the domains for the color and transparency properties.

Returns:
the domains for the color and transparency properties

Implements fib::iImageData.

virtual bool fib::cEvalueSimpleRGBA255::setPoint ( const cVectorPosition &  vPosition,
const list< cVectorProperty > &  vProperties 
)
virtual

With this method the properties for a points are set.

Parameters:
vPositionthe position of the point to set
vPropertiesa list of the properties of the point
Returns:
true if the properties for the point cold be set, else false

Implements fib::iImageData.

Member Data Documentation

bool fib::cEvalueSimpleRGBA255::bBackgroundColorExists

If true a background color was set.

Definition at line 107 of file cEvalueSimpleRGBA255.h.

unsigned char fib::cEvalueSimpleRGBA255::pBackgroundColor[4]

The ARGB value for the background color. value: alpha (transparency), red, green, blue wher 0 is the minimum (e.g. no green) and 255 the maximum (e.g. full red), the color values are non-premultiplied; for the alpha value

See also:
http://en.wikipedia.org/wiki/Alpha_compositing (0 = total transparent, 255 = total opaque)

Definition at line 102 of file cEvalueSimpleRGBA255.h.

unsigned char* fib::cEvalueSimpleRGBA255::pImageData

The matrix with the ARGB image data. The dimension entries are:

  • first dimension (x)
  • second dimension (y)
  • value: alpha (transparency), red, green, blue wher 0 is the minimum (e.g. no green) and 255 the maximum (e.g. full red), the color values are non-premultiplied; for the alpha value
    See also:
    http://en.wikipedia.org/wiki/Alpha_compositing (0 = total transparent, 255 = total opaque)
    The pointer will point to an one dimensional array. You have to evalue the single entries by hand (with: *(pImageData + (x * uiMaxY + y) * 4) )

Definition at line 92 of file cEvalueSimpleRGBA255.h.

const unsigned int fib::cEvalueSimpleRGBA255::uiMaxX

The maximum value for the first (x) dimension. (The number of point rows.)

Definition at line 70 of file cEvalueSimpleRGBA255.h.

const unsigned int fib::cEvalueSimpleRGBA255::uiMaxY

The maximum value for the second (y) dimension. (The number of point lines.)

Definition at line 76 of file cEvalueSimpleRGBA255.h.

The documentation for this class was generated from the following file: