|
|
The QtCanvasSprite class provides an animated canvas item on a QtCanvas. More...
#include <QtCanvasSprite>
Inherits QtCanvasItem.
The QtCanvasSprite class provides an animated canvas item on a QtCanvas.
A canvas sprite is an object which can contain any number of images (referred to as frames), only one of which is current, i.e. displayed, at any one time. The images can be passed in the constructor or set or changed later with setSequence(). If you subclass QtCanvasSprite you can change the frame that is displayed periodically, e.g. whenever QtCanvasItem::advance(1) is called to create the effect of animation.
The current frame can be set with setFrame() or with move(). The number of frames available is given by frameCount(). The bounding rectangle of the current frame is returned by boundingRect().
The current frame's image can be retrieved with image(); use imageAdvanced() to retrieve the image for the frame that will be shown after advance(1) is called. Use the image() overload passing it an integer index to retrieve a particular image from the list of frames.
Use width() and height() to retrieve the dimensions of the current frame.
Use leftEdge() and rightEdge() to retrieve the current frame's left-hand and right-hand x-coordinates respectively. Use bottomEdge() and topEdge() to retrieve the current frame's bottom and top y-coordinates respectively. These functions have an overload which will accept an integer frame number to retrieve the coordinates of a particular frame.
QtCanvasSprite draws very quickly, at the expense of memory.
The current frame's image can be drawn on a painter with draw().
Like any other canvas item, canvas sprites can be moved with move() which sets the x and y coordinates and the frame number, as well as with QtCanvasItem::move() and QtCanvasItem::moveBy(), or by setting coordinates with QtCanvasItem::setX(), QtCanvasItem::setY() and QtCanvasItem::setZ().
This enum is used to identify the different types of frame animation offered by QtCanvasSprite.
| Constant | Value | Description |
|---|---|---|
| QtCanvasSprite::Cycle | 0 | at each advance the frame number will be incremented by 1 (modulo the frame count). |
| QtCanvasSprite::Oscillate | 1 | at each advance the frame number will be incremented by 1 up to the frame count then decremented to by 1 to 0, repeating this sequence forever. |
Constructs a QtCanvasSprite which uses images from the QtCanvasPixmapArray a.
The sprite in initially positioned at (0, 0) on canvas, using frame 0.
Destroys the sprite and removes it from the canvas. Does not delete the images.
Extends the default QtCanvasItem implementation to provide the functionality of setFrameAnimation().
The phase is 0 or 1: see QtCanvasItem::advance() for details.
Reimplemented from QtCanvasItem.
See also QtCanvasItem::advance() and setVelocity().
Returns the y-coordinate of the current bottom edge of the sprite. (This may change as the sprite animates since different frames may have different bottom edges.)
See also leftEdge(), rightEdge(), and topEdge().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns what the y-coordinate of the top edge of the sprite would be if the sprite (actually its hotspot) were moved to y-position ny.
See also leftEdge(), rightEdge(), and topEdge().
Returns the bounding rectangle for the image in the sprite's current frame. This assumes that the images are tightly cropped (i.e. do not have transparent pixels all along a side).
Reimplemented from QtCanvasItem.
Draws the current frame's image at the sprite's current position on painter painter.
Reimplemented from QtCanvasItem.
Returns the index of the current animation frame in the QtCanvasSprite's QtCanvasPixmapArray.
See also setFrame() and move().
Returns the number of frames in the QtCanvasSprite's QtCanvasPixmapArray.
The height of the sprite for the current frame's image.
See also frame().
Returns the current frame's image.
See also frame() and setFrame().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns the image for frame f. Does not do any bounds checking on f.
Returns the image the sprite will have after advance(1) is called. By default this is the same as image().
Returns the x-coordinate of the current left edge of the sprite. (This may change as the sprite animates since different frames may have different left edges.)
See also rightEdge(), bottomEdge(), and topEdge().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns what the x-coordinate of the left edge of the sprite would be if the sprite (actually its hotspot) were moved to x-position nx.
See also rightEdge(), bottomEdge(), and topEdge().
Moves the sprite to (x, y).
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Moves the sprite to (nx, ny) and sets the current frame to nf. nf will be ignored if it is larger than frameCount() or smaller than 0.
Returns the x-coordinate of the current right edge of the sprite. (This may change as the sprite animates since different frames may have different right edges.)
See also leftEdge(), bottomEdge(), and topEdge().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns what the x-coordinate of the right edge of the sprite would be if the sprite (actually its hotspot) were moved to x-position nx.
See also leftEdge(), bottomEdge(), and topEdge().
Returns 1 (QtCanvasItem::Rtti_Sprite).
Reimplemented from QtCanvasItem.
See also QtCanvasItem::rtti().
Sets the animation frame used for displaying the sprite to f, an index into the QtCanvasSprite's QtCanvasPixmapArray. The call will be ignored if f is larger than frameCount() or smaller than 0.
Sets the animation characteristics for the sprite.
For type == Cycle, the frames will increase by step at each advance, modulo the frameCount().
For type == Oscillate, the frames will increase by step at each advance, up to the frameCount(), then decrease by step back to 0, repeating forever.
The state parameter is for internal use.
Set the array of images used for displaying the sprite to the QtCanvasPixmapArray a.
If the current frame() is larger than the number of images in a, the current frame will be reset to 0.
Returns the y-coordinate of the top edge of the sprite. (This may change as the sprite animates since different frames may have different top edges.)
See also leftEdge(), rightEdge(), and bottomEdge().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns what the y-coordinate of the top edge of the sprite would be if the sprite (actually its hotspot) were moved to y-position ny.
See also leftEdge(), rightEdge(), and bottomEdge().
The width of the sprite for the current frame's image.
See also frame().
| Copyright © 2005 Trolltech | Trademarks |