|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# Q3CanvasSprite Class Reference
[Qt3Support module]

The Q3CanvasSprite class provides an animated canvas item on a Q3Canvas. More...

    #include <Q3CanvasSprite>

This class is part of the Qt 3 support library. It is provided to keep old source code working. We strongly advise against using it in new code. See Porting to Qt 4 for more information.

Note to Qt Desktop Light Edition users: This class is only available in the Qt Desktop Edition.

Inherits Q3CanvasItem.

- List of all members, including inherited members

### Public Types

- enum FrameAnimationType { Cycle, Oscillate }

### Public Functions

- Q3CanvasSprite ( Q3CanvasPixmapArray * a, Q3Canvas * canvas )
- virtual ~Q3CanvasSprite ()
- virtual void advance ( int phase )
- int bottomEdge () const
- int bottomEdge ( int ny ) const
- virtual QRect boundingRect () const
- virtual void draw ( QPainter & painter )
- int frame () const
- int frameCount () const
- int height () const
- Q3CanvasPixmap * image () const
- Q3CanvasPixmap * image ( int f ) const
- virtual Q3CanvasPixmap * imageAdvanced () const
- int leftEdge () const
- int leftEdge ( int nx ) const
- void move ( double x, double y )
- virtual void move ( double nx, double ny, int nf )
- int rightEdge () const
- int rightEdge ( int nx ) const
- virtual int rtti () const
- void setFrame ( int f )
- virtual void setFrameAnimation ( FrameAnimationType type = Cycle, int step = 1, int state = 0 )
- void setSequence ( Q3CanvasPixmapArray * a )
- int topEdge () const
- int topEdge ( int ny ) const
- int width () const

- 34 public functions inherited from Q3CanvasItem

### Additional Inherited Members

- 1 protected function inherited from Q3CanvasItem

## Detailed Description

The Q3CanvasSprite class provides an animated canvas item on a Q3Canvas.

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 Q3CanvasSprite you can change the frame that is displayed periodically, e.g. whenever Q3CanvasItem::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.

Q3CanvasSprite 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 Q3CanvasItem::move() and Q3CanvasItem::moveBy(), or by setting coordinates with Q3CanvasItem::setX(), Q3CanvasItem::setY() and Q3CanvasItem::setZ().

## Member Type Documentation

### enum Q3CanvasSprite::FrameAnimationType

This enum is used to identify the different types of frame animation offered by Q3CanvasSprite.

Constant | Value | Description
--- | --- | ---
`Q3CanvasSprite::Cycle` | `0` | at each advance the frame number will be incremented by 1 (modulo the frame count).
`Q3CanvasSprite::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.

## Member Function Documentation

### Q3CanvasSprite::Q3CanvasSprite ( Q3CanvasPixmapArray * a, Q3Canvas * canvas )

Constructs a Q3CanvasSprite which uses images from the Q3CanvasPixmapArray a.

The sprite in initially positioned at (0, 0) on canvas, using frame 0.

### Q3CanvasSprite::~Q3CanvasSprite () `[virtual]`

Destroys the sprite and removes it from the canvas. Does not delete the images.

### void Q3CanvasSprite::advance ( int phase ) `[virtual]`

Extends the default Q3CanvasItem implementation to provide the functionality of setFrameAnimation().

The phase is 0 or 1: see Q3CanvasItem::advance() for details.

Reimplemented from Q3CanvasItem.

See also Q3CanvasItem::advance() and setVelocity().

### int Q3CanvasSprite::bottomEdge () const

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().

### int Q3CanvasSprite::bottomEdge ( int ny ) const

This is an overloaded member function, provided for convenience.

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().

### QRect Q3CanvasSprite::boundingRect () const `[virtual]`

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

### void Q3CanvasSprite::draw ( QPainter & painter ) `[virtual]`

Draws the current frame's image at the sprite's current position on painter painter.

Reimplemented from Q3CanvasItem.

### int Q3CanvasSprite::frame () const

Returns the index of the current animation frame in the Q3CanvasSprite's Q3CanvasPixmapArray.

See also setFrame() and move().

### int Q3CanvasSprite::frameCount () const

Returns the number of frames in the Q3CanvasSprite's Q3CanvasPixmapArray.

### int Q3CanvasSprite::height () const

The height of the sprite for the current frame's image.

See also frame().

### Q3CanvasPixmap * Q3CanvasSprite::image () const

Returns the current frame's image.

See also frame() and setFrame().

### Q3CanvasPixmap * Q3CanvasSprite::image ( int f ) const

This is an overloaded member function, provided for convenience.

Returns the image for frame f. Does not do any bounds checking on f.

### Q3CanvasPixmap * Q3CanvasSprite::imageAdvanced () const `[virtual]`

Returns the image the sprite will have after advance(1) is called. By default this is the same as image().

### int Q3CanvasSprite::leftEdge () const

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().

### int Q3CanvasSprite::leftEdge ( int nx ) const

This is an overloaded member function, provided for convenience.

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().

### void Q3CanvasSprite::move ( double x, double y )

Moves the sprite to (x, y).

### void Q3CanvasSprite::move ( double nx, double ny, int nf ) `[virtual]`

This is an overloaded member function, provided for convenience.

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.

### int Q3CanvasSprite::rightEdge () const

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().

### int Q3CanvasSprite::rightEdge ( int nx ) const

This is an overloaded member function, provided for convenience.

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().

### int Q3CanvasSprite::rtti () const `[virtual]`

Returns 1 (Q3CanvasItem::Rtti_Sprite).

Reimplemented from Q3CanvasItem.

See also Q3CanvasItem::rtti().

### void Q3CanvasSprite::setFrame ( int f )

Sets the animation frame used for displaying the sprite to f, an index into the Q3CanvasSprite's Q3CanvasPixmapArray. The call will be ignored if f is larger than frameCount() or smaller than 0.

See also frame() and move().

### void Q3CanvasSprite::setFrameAnimation ( FrameAnimationType type = Cycle, int step = 1, int state = 0 ) `[virtual]`

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.

### void Q3CanvasSprite::setSequence ( Q3CanvasPixmapArray * a )

Set the array of images used for displaying the sprite to the Q3CanvasPixmapArray a.

If the current frame() is larger than the number of images in a, the current frame will be reset to 0.

### int Q3CanvasSprite::topEdge () const

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().

### int Q3CanvasSprite::topEdge ( int ny ) const

This is an overloaded member function, provided for convenience.

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().

### int Q3CanvasSprite::width () const

The width of the sprite for the current frame's image.

See also frame().