QCanvasPixmapArray

NAME

SYNOPSIS

Public Members

DESCRIPTION

This class is used by QCanvasSprite to hold an array of pixmaps. It is used to implement animated sprites, i.e. images that change over time, with each pixmap in the array holding one frame.

Depending on the constructor you use you can load multiple pixmaps into the array either from a directory (specifying a wildcard pattern for the files), or from a list of QPixmaps. You can also read in a set of pixmaps after construction using readPixmaps().

Individual pixmaps can be set with setImage() and retrieved with image(). The number of pixmaps in the array is returned by count().

QCanvasSprite uses an image's mask for collision detection. You can change this by reading in a separate set of image masks using readCollisionMasks().

See also Graphics Classes and Image Processing Classes.  

MEMBER FUNCTION DOCUMENTATION

QCanvasPixmapArray::QCanvasPixmapArray ()

QCanvasPixmapArray::QCanvasPixmapArray ( const QString & datafilenamepattern, int fc = 0 )

The fc parameter sets the number of frames to be loaded for this image.

If fc is not 0, datafilenamepattern should contain "%1", e.g. "foo%1.png". The actual filenames are formed by replacing the %1 with four-digit integers from 0 to (fc - 1), e.g. foo0000.png, foo0001.png, foo0002.png, etc.

If fc is 0, datafilenamepattern is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame.

If datafilenamepattern does not exist, is not readable, isn't an image, or some other error occurs, the array ends up empty and isValid() returns FALSE.  

QCanvasPixmapArray::QCanvasPixmapArray ( QPtrList<QPixmap> list, QPtrList<QPoint> hotspots )

Use QCanvasPixmapArray::QCanvasPixmapArray( QValueList<QPixmap>, QPointArray ) instead.

Constructs a QCanvasPixmapArray from the list of QPixmaps list. The hotspots list has to be of the same size as list.  

QCanvasPixmapArray::QCanvasPixmapArray ( QValueList<QPixmap> list, QPointArray hotspots = QPointArray ( ) )

If an error occurs, isValid() will return FALSE.  

QCanvasPixmapArray::~QCanvasPixmapArray ()

uint QCanvasPixmapArray::count () const

QCanvasPixmap * QCanvasPixmapArray::image ( int i ) const

bool QCanvasPixmapArray::isValid () const

bool QCanvasPixmapArray::operator! ()

Use isValid() instead.

This returns FALSE if the array is valid, and TRUE if it is not.  

bool QCanvasPixmapArray::readCollisionMasks ( const QString & filename )

By default, QCanvasSprite uses the image mask of a sprite to detect collisions. Use this function to set your own collision image masks.

If count() is 1 filename must specify a real filename to read the mask from. If count() is greater than 1, the filename must contain a "%1" that will get replaced by the number of the mask to be loaded, just like QCanvasPixmapArray::readPixmaps().

All collision masks must be 1-bit images or this function call will fail.

If the file isn't readable, contains the wrong number of images, or there is some other error, this function will return FALSE, and the array will be flagged as invalid; otherwise this function returns TRUE.

See also isValid().  

bool QCanvasPixmapArray::readPixmaps ( const QString & filenamepattern, int fc = 0 )

If fc is not 0, filenamepattern should contain "%1", e.g." foo%1.png". The actual filenames are formed by replacing the %1 with four-digit integers from 0 to (fc - 1), e.g. foo0000.png, foo0001.png, foo0002.png, etc.

If fc is 0, filenamepattern is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame.

If filenamepattern does not exist, is not readable, isn't an image, or some other error occurs, this function will return FALSE, and isValid() will return FALSE; otherwise this function will return TRUE.

See also isValid().  

void QCanvasPixmapArray::setImage ( int i, QCanvasPixmap * p )

The array takes ownership of p and will delete p when the array itself is deleted.

If i is beyond the end of the array the array is extended to at least i+1 elements, with elements count() to i-1 being initialized to 0.

SEE ALSO

COPYRIGHT

AUTHOR

BUGS