From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qcanvaspixmaparray.html | 192 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 192 insertions(+) create mode 100644 doc/html/qcanvaspixmaparray.html (limited to 'doc/html/qcanvaspixmaparray.html') diff --git a/doc/html/qcanvaspixmaparray.html b/doc/html/qcanvaspixmaparray.html new file mode 100644 index 000000000..75d63d418 --- /dev/null +++ b/doc/html/qcanvaspixmaparray.html @@ -0,0 +1,192 @@ + + + + + +TQCanvasPixmapArray Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQCanvasPixmapArray Class Reference
[canvas module]

+ +

The TQCanvasPixmapArray class provides an array of TQCanvasPixmaps. +More... +

#include <qcanvas.h> +

List of all member functions. +

Public Members

+ +

Detailed Description

+ + +The TQCanvasPixmapArray class provides an array of TQCanvasPixmaps. + +

+ + +

This class is used by TQCanvasSprite 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 TQPixmaps. 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(). +

TQCanvasSprite 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

+

TQCanvasPixmapArray::TQCanvasPixmapArray () +

+Constructs an invalid array (i.e. isValid() will return FALSE). +You must call readPixmaps() before being able to use this +TQCanvasPixmapArray. + +

TQCanvasPixmapArray::TQCanvasPixmapArray ( const TQString & datafilenamepattern, int fc = 0 ) +

+Constructs a TQCanvasPixmapArray from files. +

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. + +

TQCanvasPixmapArray::TQCanvasPixmapArray ( TQPtrList<TQPixmap> list, TQPtrList<TQPoint> hotspots ) +

+This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. +

Use TQCanvasPixmapArray::TQCanvasPixmapArray( TQValueList, TQPointArray ) +instead. +

Constructs a TQCanvasPixmapArray from the list of TQPixmaps list. The hotspots list has to be of the same size as list. + +

TQCanvasPixmapArray::TQCanvasPixmapArray ( TQValueList<TQPixmap> list, TQPointArray hotspots = TQPointArray ( ) ) +

+Constructs a TQCanvasPixmapArray from the list of TQPixmaps in the +list. Each pixmap will get a hotspot according to the hotspots array. If no hotspots are specified, each one is set to +be at position (0, 0). +

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

TQCanvasPixmapArray::~TQCanvasPixmapArray () +

+Destroys the pixmap array and all the pixmaps it contains. + +

uint TQCanvasPixmapArray::count () const +

+ +

Returns the number of pixmaps in the array. + +

TQCanvasPixmap * TQCanvasPixmapArray::image ( int i ) const +

+ +

Returns pixmap i in the array, if i is non-negative and less +than than count(), and returns an unspecified value otherwise. + +

bool TQCanvasPixmapArray::isValid () const +

+Returns TRUE if the pixmap array is valid; otherwise returns +FALSE. + +

bool TQCanvasPixmapArray::operator! () +

+This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. +

Use isValid() instead. +

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

bool TQCanvasPixmapArray::readCollisionMasks ( const TQString & filename ) +

+Reads new collision masks for the array. +

By default, TQCanvasSprite 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 TQCanvasPixmapArray::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 TQCanvasPixmapArray::readPixmaps ( const TQString & filenamepattern, int fc = 0 ) +

+Reads one or more pixmaps into the pixmap array. +

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 TQCanvasPixmapArray::setImage ( int i, TQCanvasPixmap * p ) +

+Replaces the pixmap at index i with pixmap 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. + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.3