Q3CanvasItem Class Reference
^{[Qt3Support module]}

Detailed Description

The Q3CanvasItem class provides an abstract graphic object on a Q3Canvas.

A variety of Q3CanvasItem subclasses provide immediately usable behaviour. This class is a pure abstract superclass providing the behaviour that is shared among all the concrete canvas item classes. Q3CanvasItem is not intended for direct subclassing. It is much easier to subclass one of its subclasses, e.g. Q3CanvasPolygonalItem (the commonest base class), Q3CanvasRectangle, Q3CanvasSprite, Q3CanvasEllipse or Q3CanvasText.

Canvas items are added to a canvas by constructing them and passing the canvas to the canvas item's constructor. An item can be moved to a different canvas using setCanvas().

Items appear on the canvas after their show() function has been called (or setVisible(true)), and after update() has been called. The canvas only shows items that are visible, and then only if update() is called. If you created the canvas without passing a width and height to the constructor you'll also need to call resize(). Since the canvas background defaults to white and canvas items default to white, you may need to change colors to see your items.

A Q3CanvasItem object can be moved in the x(), y() and z() dimensions using functions such as move(), moveBy(), setX(), setY() and setZ(). A canvas item can be set in motion, `animated', using setAnimated() and given a velocity in the x and y directions with setXVelocity() and setYVelocity() -- the same effect can be achieved by calling setVelocity(). Use the collidesWith() function to see if the canvas item will collide on the next advance(1) and use collisions() to see what collisions have occurred.

Use Q3CanvasSprite or your own subclass of Q3CanvasSprite to create canvas items which are animated, i.e. which change over time.

The size of a canvas item is given by boundingRect(). Use boundingRectAdvanced() to see what the size of the canvas item will be after the next advance(1) call.

The rtti() function is used for identifying subclasses of Q3CanvasItem. The canvas() function returns a pointer to the canvas which contains the canvas item.

Q3CanvasItem provides the show() and isVisible() functions like those in QWidget.

Q3CanvasItem also provides the setEnabled(), setActive() and setSelected() functions; these functions set the relevant boolean and cause a repaint but the boolean values they set are not used in Q3CanvasItem itself. You can make use of these booleans in your subclasses.

By default, canvas items have no velocity, no size, and are not in motion. The subclasses provided in Qt do not change these defaults except where noted.

See also QtCanvas.

Member Type Documentation

enum Q3CanvasItem::RttiValues

This enum is used to name the different types of canvas item.

Member Function Documentation

Q3CanvasItem::Q3CanvasItem ( Q3Canvas * canvas )

Constructs a Q3CanvasItem on canvas canvas.

See also setCanvas().

Q3CanvasItem::~Q3CanvasItem ()   [virtual]

Destroys the Q3CanvasItem and removes it from its canvas.

void Q3CanvasItem::advance ( int phase )   [virtual]

The default implementation moves the canvas item, if it is animated(), by the preset velocity if phase is 1, and does nothing if phase is 0.

Note that if you reimplement this function, the reimplementation must not change the canvas in any way, for example it must not add or remove items.

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

bool Q3CanvasItem::animated () const

Returns true if the canvas item is in motion; otherwise returns false.

See also setVelocity() and setAnimated().

QRect Q3CanvasItem::boundingRect () const   [pure virtual]

Returns the bounding rectangle in pixels that the canvas item covers.

See also boundingRectAdvanced().

QRect Q3CanvasItem::boundingRectAdvanced () const   [virtual]

Returns the bounding rectangle of pixels that the canvas item will cover after advance(1) is called.

See also boundingRect().

Q3Canvas * Q3CanvasItem::canvas () const

Returns the canvas containing the canvas item.

See also setCanvas().

bool Q3CanvasItem::collidesWith ( const Q3CanvasItem * other ) const   [pure virtual]

Returns true if the canvas item will collide with the other item after they have moved by their current velocities; otherwise returns false.

See also collisions().

Q3CanvasItemList Q3CanvasItem::collisions ( bool exact ) const

Returns the list of canvas items that this canvas item has collided with.

A collision is generally defined as occurring when the pixels of one item draw on the pixels of another item, but not all subclasses are so precise. Also, since pixel-wise collision detection can be slow, this function works in either exact or inexact mode, according to the exact parameter.

If exact is true, the canvas items returned have been accurately tested for collision with the canvas item.

If exact is false, the canvas items returned are near the canvas item. You can test the canvas items returned using collidesWith() if any are interesting collision candidates. By using this approach, you can ignore some canvas items for which collisions are not relevant.

The returned list is a list of Q3CanvasItems, but often you will need to cast the items to their subclass types. The safe way to do this is to use rtti() before casting. This provides some of the functionality of the standard C++ dynamic cast operation even on compilers where dynamic casts are not available.

Note that a canvas item may be `on' a canvas, e.g. it was created with the canvas as parameter, even though its coordinates place it beyond the edge of the canvas's area. Collision detection only works for canvas items which are wholly or partly within the canvas's area.

Note that if items have a velocity (see setVelocity()), then collision testing is done based on where the item will be when it moves, not its current location. For example, a "ball" item doesn't need to actually embed into a "wall" item before a collision is detected. For items without velocity, plain intersection is used.

void Q3CanvasItem::draw ( QPainter & painter )   [pure virtual]

This abstract virtual function draws the canvas item using painter.

void Q3CanvasItem::hide ()

Shorthand for setVisible(false).

bool Q3CanvasItem::isActive () const

Returns true if the Q3CanvasItem is active; otherwise returns false.

bool Q3CanvasItem::isEnabled () const

Returns true if the Q3CanvasItem is enabled; otherwise returns false.

bool Q3CanvasItem::isSelected () const

Returns true if the canvas item is selected; otherwise returns false.

bool Q3CanvasItem::isVisible () const

Returns true if the canvas item is visible; otherwise returns false.

Note that in this context true does not mean that the canvas item is currently in a view, merely that if a view is showing the area where the canvas item is positioned, and the item is not obscured by items with higher z values, and the view is not obscured by overlaying windows, it would be visible.

See also setVisible() and z().

void Q3CanvasItem::move ( double x, double y )

Moves the canvas item to the absolute position (x, y).

void Q3CanvasItem::moveBy ( double dx, double dy )   [virtual]

Moves the canvas item relative to its current position by (dx, dy).

int Q3CanvasItem::rtti () const   [virtual]

Returns 0 (Q3CanvasItem::Rtti_Item).

Make your derived classes return their own values for rtti(), so that you can distinguish between objects returned by Q3Canvas::at(). You should use values greater than 1000 to allow for extensions to this class.

Overuse of this functionality can damage its extensibility. For example, once you have identified a base class of a Q3CanvasItem found by Q3Canvas::at(), cast it to that type and call meaningful methods rather than acting upon the object based on its rtti value.

For example:

    Q3CanvasItem* item;
    // Find an item, e.g. with Q3CanvasItem::collisions().
    ...
    if (item->rtti() == MySprite::RTTI) {
        MySprite* s = (MySprite*)item;
        if (s->isDamagable()) s->loseHitPoints(1000);
        if (s->isHot()) myself->loseHitPoints(1000);
        ...
    }

void Q3CanvasItem::setActive ( bool yes )   [virtual]

Sets the active flag of the item to yes. If this changes the item's active state the item will be redrawn when Q3Canvas::update() is next called.

The Q3Canvas, Q3CanvasItem and the Qt-supplied Q3CanvasItem subclasses do not make use of this value. The setActive() function is supplied because many applications need it, but it is up to you how you use the isActive() value.

See also active().

void Q3CanvasItem::setAnimated ( bool y )   [virtual]

Sets the canvas item to be in motion if y is true, or not if y is false. The speed and direction of the motion is set with setVelocity(), or with setXVelocity() and setYVelocity().

See also animated(), advance(), and Q3Canvas::advance().

void Q3CanvasItem::setCanvas ( Q3Canvas * c )   [virtual]

Sets the Q3Canvas upon which the canvas item is to be drawn to c.

See also canvas().

void Q3CanvasItem::setEnabled ( bool yes )   [virtual]

Sets the enabled flag of the item to yes. If this changes the item's enabled state the item will be redrawn when Q3Canvas::update() is next called.

The Q3Canvas, Q3CanvasItem and the Qt-supplied Q3CanvasItem subclasses do not make use of this value. The setEnabled() function is supplied because many applications need it, but it is up to you how you use the isEnabled() value.

See also enabled().

void Q3CanvasItem::setSelected ( bool yes )   [virtual]

Sets the selected flag of the item to yes. If this changes the item's selected state the item will be redrawn when Q3Canvas::update() is next called.

The Q3Canvas, Q3CanvasItem and the Qt-supplied Q3CanvasItem subclasses do not make use of this value. The setSelected() function is supplied because many applications need it, but it is up to you how you use the isSelected() value.

See also selected().

void Q3CanvasItem::setVelocity ( double vx, double vy )   [virtual]

Sets the canvas item to be in motion, moving by vx and vy pixels in the horizontal and vertical directions respectively.

See also advance(), setXVelocity(), and setYVelocity().

void Q3CanvasItem::setVisible ( bool yes )   [virtual]

Makes the canvas item visible if yes is true, or invisible if yes is false. The change takes effect when Q3Canvas::update() is next called.

See also visible().

void Q3CanvasItem::setX ( double x )

Moves the canvas item so that its x-position is x.

See also x() and move().

void Q3CanvasItem::setXVelocity ( double vx )

Sets the horizontal component of the canvas item's velocity to vx.

See also xVelocity(), setYVelocity(), and setVelocity().

void Q3CanvasItem::setY ( double y )

Moves the canvas item so that its y-position is y.

See also y() and move().

void Q3CanvasItem::setYVelocity ( double vy )

Sets the vertical component of the canvas item's velocity to vy.

See also yVelocity(), setXVelocity(), and setVelocity().

void Q3CanvasItem::setZ ( double z )

Sets the z index of the canvas item to z. Higher-z items obscure (are in front of) lower-z items.

See also z() and move().

void Q3CanvasItem::show ()

Shorthand for setVisible(true).

void Q3CanvasItem::update ()   [protected]

Call this function to repaint the canvas's changed chunks.

double Q3CanvasItem::x () const

Returns the horizontal position of the canvas item. Note that subclasses often have an origin other than the top-left corner.

See also setX().

double Q3CanvasItem::xVelocity () const

Returns the horizontal velocity component of the canvas item.

See also setXVelocity().

double Q3CanvasItem::y () const

Returns the vertical position of the canvas item. Note that subclasses often have an origin other than the top-left corner.

See also setY().

double Q3CanvasItem::yVelocity () const

Returns the vertical velocity component of the canvas item.

See also setYVelocity().

double Q3CanvasItem::z () const

Returns the z index of the canvas item, which is used for visual order: higher-z items obscure (are in front of) lower-z items.

See also setZ().