<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3canvas.cpp -->
<title>Qt 4.8: Q3CanvasItem Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qt3support.html">Qt3Support</a></li>
<li>Q3CanvasItem</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3CanvasItem Class Reference</h1>
<!-- $$$Q3CanvasItem-brief -->
<p>The Q3CanvasItem class provides an abstract graphic object on a <a href="q3canvas.html">Q3Canvas</a>. <a href="#details">More...</a></p>
<!-- @@@Q3CanvasItem -->
<pre class="cpp"> <span class="preprocessor">#include <Q3CanvasItem></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<p><b>Inherited by: </b><a href="q3canvaspolygonalitem.html">Q3CanvasPolygonalItem</a>, <a href="q3canvassprite.html">Q3CanvasSprite</a>, and <a href="q3canvastext.html">Q3CanvasText</a>.</p>
<ul>
<li><a href="q3canvasitem-members.html">List of all members, including inherited members</a></li>
<li><a href="q3canvasitem-obsolete.html">Obsolete members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#RttiValues-enum">RttiValues</a></b> { Rtti_Item, Rtti_Ellipse, Rtti_Line, Rtti_Polygon, ..., Rtti_Text }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#Q3CanvasItem">Q3CanvasItem</a></b> ( Q3Canvas * <i>canvas</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#dtor.Q3CanvasItem">~Q3CanvasItem</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#advance">advance</a></b> ( int <i>phase</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#animated">animated</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QRect </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#boundingRect">boundingRect</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QRect </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#boundingRectAdvanced">boundingRectAdvanced</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3Canvas * </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#canvas">canvas</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#collidesWith">collidesWith</a></b> ( const Q3CanvasItem * <i>other</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3CanvasItemList </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#collisions">collisions</a></b> ( bool <i>exact</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#draw">draw</a></b> ( QPainter & <i>painter</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#hide">hide</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#isActive">isActive</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#isEnabled">isEnabled</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#isSelected">isSelected</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#isVisible">isVisible</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#move">move</a></b> ( double <i>x</i>, double <i>y</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#moveBy">moveBy</a></b> ( double <i>dx</i>, double <i>dy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#rtti">rtti</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setActive">setActive</a></b> ( bool <i>yes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setAnimated">setAnimated</a></b> ( bool <i>y</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setCanvas">setCanvas</a></b> ( Q3Canvas * <i>c</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setEnabled">setEnabled</a></b> ( bool <i>yes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setSelected">setSelected</a></b> ( bool <i>yes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setVelocity">setVelocity</a></b> ( double <i>vx</i>, double <i>vy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setVisible">setVisible</a></b> ( bool <i>yes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setX">setX</a></b> ( double <i>x</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setXVelocity">setXVelocity</a></b> ( double <i>vx</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setY">setY</a></b> ( double <i>y</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setYVelocity">setYVelocity</a></b> ( double <i>vy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#setZ">setZ</a></b> ( double <i>z</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#show">show</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#x">x</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#xVelocity">xVelocity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#y">y</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#yVelocity">yVelocity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#z">z</a></b> () const</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvasitem.html#update">update</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$Q3CanvasItem-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3CanvasItem class provides an abstract graphic object on a <a href="q3canvas.html">Q3Canvas</a>.</p>
<p>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. <a href="q3canvaspolygonalitem.html">Q3CanvasPolygonalItem</a> (the commonest base class), <a href="q3canvasrectangle.html">Q3CanvasRectangle</a>, <a href="q3canvassprite.html">Q3CanvasSprite</a>, <a href="q3canvasellipse.html">Q3CanvasEllipse</a> or <a href="q3canvastext.html">Q3CanvasText</a>.</p>
<p>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 <a href="q3canvasitem.html#setCanvas">setCanvas</a>().</p>
<p>Items appear on the canvas after their <a href="q3canvasitem.html#show">show()</a> function has been called (or <a href="q3canvasitem.html#setVisible">setVisible(true)</a>), and <i>after</i> <a href="q3canvasitem.html#update">update</a>() has been called. The canvas only shows items that are <a href="q3canvasitem.html#setVisible">visible</a>, and then only if <a href="q3canvasitem.html#update">update</a>() is called. If you created the canvas without passing a width and height to the constructor you'll also need to call <a href="q3canvas.html#resize">resize()</a>. Since the canvas background defaults to white and canvas items default to white, you may need to change colors to see your items.</p>
<p>A Q3CanvasItem object can be moved in the <a href="q3canvasitem.html#x">x</a>(), <a href="q3canvasitem.html#y">y</a>() and <a href="q3canvasitem.html#z">z</a>() dimensions using functions such as <a href="q3canvasitem.html#move">move</a>(), <a href="q3canvasitem.html#moveBy">moveBy</a>(), <a href="q3canvasitem.html#setX">setX</a>(), <a href="q3canvasitem.html#setY">setY</a>() and <a href="q3canvasitem.html#setZ">setZ</a>(). A canvas item can be set in motion, `animated', using <a href="q3canvasitem.html#setAnimated">setAnimated</a>() and given a velocity in the x and y directions with <a href="q3canvasitem.html#setXVelocity">setXVelocity</a>() and <a href="q3canvasitem.html#setYVelocity">setYVelocity</a>() -- the same effect can be achieved by calling <a href="q3canvasitem.html#setVelocity">setVelocity</a>(). Use the <a href="q3canvasitem.html#collidesWith">collidesWith</a>() function to see if the canvas item will collide on the <i>next</i> advance(1) and use <a href="q3canvasitem.html#collisions">collisions</a>() to see what collisions have occurred.</p>
<p>Use <a href="q3canvassprite.html">Q3CanvasSprite</a> or your own subclass of <a href="q3canvassprite.html">Q3CanvasSprite</a> to create canvas items which are animated, i.e. which change over time.</p>
<p>The size of a canvas item is given by <a href="q3canvasitem.html#boundingRect">boundingRect</a>(). Use <a href="q3canvasitem.html#boundingRectAdvanced">boundingRectAdvanced</a>() to see what the size of the canvas item will be <i>after</i> the next advance(1) call.</p>
<p>The <a href="q3canvasitem.html#rtti">rtti</a>() function is used for identifying subclasses of Q3CanvasItem. The <a href="q3canvasitem.html#canvas">canvas</a>() function returns a pointer to the canvas which contains the canvas item.</p>
<p>Q3CanvasItem provides the <a href="q3canvasitem.html#show">show</a>() and <a href="q3canvasitem.html#isVisible">isVisible</a>() functions like those in <a href="qwidget.html">QWidget</a>.</p>
<p>Q3CanvasItem also provides the <a href="q3canvasitem.html#setEnabled">setEnabled</a>(), <a href="q3canvasitem.html#setActive">setActive</a>() and <a href="q3canvasitem.html#setSelected">setSelected</a>() 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.</p>
<p>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.</p>
</div>
<p><b>See also </b><a href="http://www.qt.io/product/">QtCanvas</a> and <a href="graphicsview-porting.html">Porting to Graphics View</a>.</p>
<!-- @@@Q3CanvasItem -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$RttiValues$$$Rtti_Item$$$Rtti_Sprite$$$Rtti_PolygonalItem$$$Rtti_Text$$$Rtti_Polygon$$$Rtti_Rectangle$$$Rtti_Ellipse$$$Rtti_Line$$$Rtti_Spline -->
<h3 class="fn"><a name="RttiValues-enum"></a>enum Q3CanvasItem::<span class="name">RttiValues</span></h3>
<p>This enum is used to name the different types of canvas item.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Item</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Canvas item abstract base class</td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Ellipse</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Line</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Polygon</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_PolygonalItem</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Rectangle</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Spline</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Sprite</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>Q3CanvasItem::Rtti_Text</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign"> </td></tr>
</table>
<!-- @@@RttiValues -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3CanvasItem[overload1]$$$Q3CanvasItemQ3Canvas* -->
<h3 class="fn"><a name="Q3CanvasItem"></a>Q3CanvasItem::<span class="name">Q3CanvasItem</span> ( <span class="type"><a href="q3canvas.html">Q3Canvas</a></span> * <i>canvas</i> )</h3>
<p>Constructs a <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> on canvas <i>canvas</i>.</p>
<p><b>See also </b><a href="q3canvasitem.html#setCanvas">setCanvas</a>().</p>
<!-- @@@Q3CanvasItem -->
<!-- $$$~Q3CanvasItem[overload1]$$$~Q3CanvasItem -->
<h3 class="fn"><a name="dtor.Q3CanvasItem"></a>Q3CanvasItem::<span class="name">~Q3CanvasItem</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> and removes it from its canvas.</p>
<!-- @@@~Q3CanvasItem -->
<!-- $$$advance[overload1]$$$advanceint -->
<h3 class="fn"><a name="advance"></a><span class="type">void</span> Q3CanvasItem::<span class="name">advance</span> ( <span class="type">int</span> <i>phase</i> )<tt> [virtual]</tt></h3>
<p>The default implementation moves the canvas item, if it is <a href="q3canvasitem.html#animated">animated</a>(), by the preset velocity if <i>phase</i> is 1, and does nothing if <i>phase</i> is 0.</p>
<p>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.</p>
<p><b>See also </b><a href="q3canvas.html#advance">Q3Canvas::advance</a>() and <a href="q3canvasitem.html#setVelocity">setVelocity</a>().</p>
<!-- @@@advance -->
<!-- $$$animated[overload1]$$$animated -->
<h3 class="fn"><a name="animated"></a><span class="type">bool</span> Q3CanvasItem::<span class="name">animated</span> () const</h3>
<p>Returns true if the canvas item is in motion; otherwise returns false.</p>
<p><b>See also </b><a href="q3canvasitem.html#setVelocity">setVelocity</a>() and <a href="q3canvasitem.html#setAnimated">setAnimated</a>().</p>
<!-- @@@animated -->
<!-- $$$boundingRect[overload1]$$$boundingRect -->
<h3 class="fn"><a name="boundingRect"></a><span class="type"><a href="qrect.html">QRect</a></span> Q3CanvasItem::<span class="name">boundingRect</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the bounding rectangle in pixels that the canvas item covers.</p>
<p><b>See also </b><a href="q3canvasitem.html#boundingRectAdvanced">boundingRectAdvanced</a>().</p>
<!-- @@@boundingRect -->
<!-- $$$boundingRectAdvanced[overload1]$$$boundingRectAdvanced -->
<h3 class="fn"><a name="boundingRectAdvanced"></a><span class="type"><a href="qrect.html">QRect</a></span> Q3CanvasItem::<span class="name">boundingRectAdvanced</span> () const<tt> [virtual]</tt></h3>
<p>Returns the bounding rectangle of pixels that the canvas item <i>will</i> cover after advance(1) is called.</p>
<p><b>See also </b><a href="q3canvasitem.html#boundingRect">boundingRect</a>().</p>
<!-- @@@boundingRectAdvanced -->
<!-- $$$canvas[overload1]$$$canvas -->
<h3 class="fn"><a name="canvas"></a><span class="type"><a href="q3canvas.html">Q3Canvas</a></span> * Q3CanvasItem::<span class="name">canvas</span> () const</h3>
<p>Returns the canvas containing the canvas item.</p>
<p><b>See also </b><a href="q3canvasitem.html#setCanvas">setCanvas</a>().</p>
<!-- @@@canvas -->
<!-- $$$collidesWith[overload1]$$$collidesWithconstQ3CanvasItem* -->
<h3 class="fn"><a name="collidesWith"></a><span class="type">bool</span> Q3CanvasItem::<span class="name">collidesWith</span> ( const <span class="type">Q3CanvasItem</span> * <i>other</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns true if the canvas item will collide with the <i>other</i> item <i>after</i> they have moved by their current velocities; otherwise returns false.</p>
<p><b>See also </b><a href="q3canvasitem.html#collisions">collisions</a>().</p>
<!-- @@@collidesWith -->
<!-- $$$collisions[overload1]$$$collisionsbool -->
<h3 class="fn"><a name="collisions"></a><span class="type"><a href="q3canvasitemlist.html">Q3CanvasItemList</a></span> Q3CanvasItem::<span class="name">collisions</span> ( <span class="type">bool</span> <i>exact</i> ) const</h3>
<p>Returns the list of canvas items that this canvas item has collided with.</p>
<p>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 <i>exact</i> parameter.</p>
<p>If <i>exact</i> is true, the canvas items returned have been accurately tested for collision with the canvas item.</p>
<p>If <i>exact</i> is false, the canvas items returned are <i>near</i> the canvas item. You can test the canvas items returned using <a href="q3canvasitem.html#collidesWith">collidesWith</a>() if any are interesting collision candidates. By using this approach, you can ignore some canvas items for which collisions are not relevant.</p>
<p>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 <a href="q3canvasitem.html#rtti">rtti</a>() before casting. This provides some of the functionality of the standard C++ dynamic cast operation even on compilers where dynamic casts are not available.</p>
<p>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.</p>
<p>Note that if items have a velocity (see <a href="q3canvasitem.html#setVelocity">setVelocity</a>()), then collision testing is done based on where the item <i>will</i> 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.</p>
<!-- @@@collisions -->
<!-- $$$draw[overload1]$$$drawQPainter& -->
<h3 class="fn"><a name="draw"></a><span class="type">void</span> Q3CanvasItem::<span class="name">draw</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> & <i>painter</i> )<tt> [pure virtual]</tt></h3>
<p>This abstract virtual function draws the canvas item using <i>painter</i>.</p>
<!-- @@@draw -->
<!-- $$$hide[overload1]$$$hide -->
<h3 class="fn"><a name="hide"></a><span class="type">void</span> Q3CanvasItem::<span class="name">hide</span> ()</h3>
<p>Shorthand for setVisible(false).</p>
<!-- @@@hide -->
<!-- $$$isActive[overload1]$$$isActive -->
<h3 class="fn"><a name="isActive"></a><span class="type">bool</span> Q3CanvasItem::<span class="name">isActive</span> () const</h3>
<p>Returns true if the <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> is active; otherwise returns false.</p>
<!-- @@@isActive -->
<!-- $$$isEnabled[overload1]$$$isEnabled -->
<h3 class="fn"><a name="isEnabled"></a><span class="type">bool</span> Q3CanvasItem::<span class="name">isEnabled</span> () const</h3>
<p>Returns true if the <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> is enabled; otherwise returns false.</p>
<!-- @@@isEnabled -->
<!-- $$$isSelected[overload1]$$$isSelected -->
<h3 class="fn"><a name="isSelected"></a><span class="type">bool</span> Q3CanvasItem::<span class="name">isSelected</span> () const</h3>
<p>Returns true if the canvas item is selected; otherwise returns false.</p>
<!-- @@@isSelected -->
<!-- $$$isVisible[overload1]$$$isVisible -->
<h3 class="fn"><a name="isVisible"></a><span class="type">bool</span> Q3CanvasItem::<span class="name">isVisible</span> () const</h3>
<p>Returns true if the canvas item is visible; otherwise returns false.</p>
<p>Note that in this context true does <i>not</i> 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.</p>
<p><b>See also </b><a href="q3canvasitem.html#setVisible">setVisible</a>() and <a href="q3canvasitem.html#z">z</a>().</p>
<!-- @@@isVisible -->
<!-- $$$move[overload1]$$$movedoubledouble -->
<h3 class="fn"><a name="move"></a><span class="type">void</span> Q3CanvasItem::<span class="name">move</span> ( <span class="type">double</span> <i>x</i>, <span class="type">double</span> <i>y</i> )</h3>
<p>Moves the canvas item to the absolute position (<i>x</i>, <i>y</i>).</p>
<!-- @@@move -->
<!-- $$$moveBy[overload1]$$$moveBydoubledouble -->
<h3 class="fn"><a name="moveBy"></a><span class="type">void</span> Q3CanvasItem::<span class="name">moveBy</span> ( <span class="type">double</span> <i>dx</i>, <span class="type">double</span> <i>dy</i> )<tt> [virtual]</tt></h3>
<p>Moves the canvas item relative to its current position by (<i>dx</i>, <i>dy</i>).</p>
<!-- @@@moveBy -->
<!-- $$$rtti[overload1]$$$rtti -->
<h3 class="fn"><a name="rtti"></a><span class="type">int</span> Q3CanvasItem::<span class="name">rtti</span> () const<tt> [virtual]</tt></h3>
<p>Returns 0 (<a href="q3canvasitem.html#RttiValues-enum">Q3CanvasItem::Rtti_Item</a>).</p>
<p>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.</p>
<p>Overuse of this functionality can damage its extensibility. For example, once you have identified a base class of a <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> found by Q3Canvas::at(), cast it to that type and call meaningful methods rather than acting upon the object based on its rtti value.</p>
<p>For example:</p>
<pre class="cpp"> <span class="type"><a href="q3canvasitem.html">Q3CanvasItem</a></span><span class="operator">*</span> item;
<span class="comment">// Find an item, e.g. with Q3CanvasItem::collisions().</span>
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="keyword">if</span> (item<span class="operator">-</span><span class="operator">></span>rtti() <span class="operator">=</span><span class="operator">=</span> MySprite<span class="operator">::</span>RTTI) {
MySprite<span class="operator">*</span> s <span class="operator">=</span> (MySprite<span class="operator">*</span>)item;
<span class="keyword">if</span> (s<span class="operator">-</span><span class="operator">></span>isDamagable()) s<span class="operator">-</span><span class="operator">></span>loseHitPoints(<span class="number">1000</span>);
<span class="keyword">if</span> (s<span class="operator">-</span><span class="operator">></span>isHot()) myself<span class="operator">-</span><span class="operator">></span>loseHitPoints(<span class="number">1000</span>);
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
}</pre>
<!-- @@@rtti -->
<!-- $$$setActive[overload1]$$$setActivebool -->
<h3 class="fn"><a name="setActive"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setActive</span> ( <span class="type">bool</span> <i>yes</i> )<tt> [virtual]</tt></h3>
<p>Sets the active flag of the item to <i>yes</i>. If this changes the item's active state the item will be redrawn when <a href="q3canvas.html#update">Q3Canvas::update</a>() is next called.</p>
<p>The <a href="q3canvas.html" class="compat">Q3Canvas</a>, <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> and the Qt-supplied <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> 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 <a href="q3canvasitem.html#isActive">isActive</a>() value.</p>
<p><b>See also </b><a href="q3canvasitem-obsolete.html#active" class="obsolete">active</a>().</p>
<!-- @@@setActive -->
<!-- $$$setAnimated[overload1]$$$setAnimatedbool -->
<h3 class="fn"><a name="setAnimated"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setAnimated</span> ( <span class="type">bool</span> <i>y</i> )<tt> [virtual]</tt></h3>
<p>Sets the canvas item to be in motion if <i>y</i> is true, or not if <i>y</i> is false. The speed and direction of the motion is set with <a href="q3canvasitem.html#setVelocity">setVelocity</a>(), or with <a href="q3canvasitem.html#setXVelocity">setXVelocity</a>() and <a href="q3canvasitem.html#setYVelocity">setYVelocity</a>().</p>
<p><b>See also </b><a href="q3canvasitem.html#animated">animated</a>(), <a href="q3canvasitem.html#advance">advance</a>(), and <a href="q3canvas.html#advance">Q3Canvas::advance</a>().</p>
<!-- @@@setAnimated -->
<!-- $$$setCanvas[overload1]$$$setCanvasQ3Canvas* -->
<h3 class="fn"><a name="setCanvas"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setCanvas</span> ( <span class="type"><a href="q3canvas.html">Q3Canvas</a></span> * <i>c</i> )<tt> [virtual]</tt></h3>
<p>Sets the <a href="q3canvas.html" class="compat">Q3Canvas</a> upon which the canvas item is to be drawn to <i>c</i>.</p>
<p><b>See also </b><a href="q3canvasitem.html#canvas">canvas</a>().</p>
<!-- @@@setCanvas -->
<!-- $$$setEnabled[overload1]$$$setEnabledbool -->
<h3 class="fn"><a name="setEnabled"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setEnabled</span> ( <span class="type">bool</span> <i>yes</i> )<tt> [virtual]</tt></h3>
<p>Sets the enabled flag of the item to <i>yes</i>. If this changes the item's enabled state the item will be redrawn when <a href="q3canvas.html#update">Q3Canvas::update</a>() is next called.</p>
<p>The <a href="q3canvas.html" class="compat">Q3Canvas</a>, <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> and the Qt-supplied <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> 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 <a href="q3canvasitem.html#isEnabled">isEnabled</a>() value.</p>
<p><b>See also </b><a href="q3canvasitem-obsolete.html#enabled" class="obsolete">enabled</a>().</p>
<!-- @@@setEnabled -->
<!-- $$$setSelected[overload1]$$$setSelectedbool -->
<h3 class="fn"><a name="setSelected"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setSelected</span> ( <span class="type">bool</span> <i>yes</i> )<tt> [virtual]</tt></h3>
<p>Sets the selected flag of the item to <i>yes</i>. If this changes the item's selected state the item will be redrawn when <a href="q3canvas.html#update">Q3Canvas::update</a>() is next called.</p>
<p>The <a href="q3canvas.html" class="compat">Q3Canvas</a>, <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> and the Qt-supplied <a href="q3canvasitem.html" class="compat">Q3CanvasItem</a> 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 <a href="q3canvasitem.html#isSelected">isSelected</a>() value.</p>
<p><b>See also </b><a href="q3canvasitem-obsolete.html#selected" class="obsolete">selected</a>().</p>
<!-- @@@setSelected -->
<!-- $$$setVelocity[overload1]$$$setVelocitydoubledouble -->
<h3 class="fn"><a name="setVelocity"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setVelocity</span> ( <span class="type">double</span> <i>vx</i>, <span class="type">double</span> <i>vy</i> )<tt> [virtual]</tt></h3>
<p>Sets the canvas item to be in motion, moving by <i>vx</i> and <i>vy</i> pixels in the horizontal and vertical directions respectively.</p>
<p><b>See also </b><a href="q3canvasitem.html#advance">advance</a>(), <a href="q3canvasitem.html#setXVelocity">setXVelocity</a>(), and <a href="q3canvasitem.html#setYVelocity">setYVelocity</a>().</p>
<!-- @@@setVelocity -->
<!-- $$$setVisible[overload1]$$$setVisiblebool -->
<h3 class="fn"><a name="setVisible"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setVisible</span> ( <span class="type">bool</span> <i>yes</i> )<tt> [virtual]</tt></h3>
<p>Makes the canvas item visible if <i>yes</i> is true, or invisible if <i>yes</i> is false. The change takes effect when <a href="q3canvas.html#update">Q3Canvas::update</a>() is next called.</p>
<p><b>See also </b><a href="q3canvasitem-obsolete.html#visible" class="obsolete">visible</a>().</p>
<!-- @@@setVisible -->
<!-- $$$setX[overload1]$$$setXdouble -->
<h3 class="fn"><a name="setX"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setX</span> ( <span class="type">double</span> <i>x</i> )</h3>
<p>Moves the canvas item so that its x-position is <i>x</i>.</p>
<p><b>See also </b><a href="q3canvasitem.html#x">x</a>() and <a href="q3canvasitem.html#move">move</a>().</p>
<!-- @@@setX -->
<!-- $$$setXVelocity[overload1]$$$setXVelocitydouble -->
<h3 class="fn"><a name="setXVelocity"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setXVelocity</span> ( <span class="type">double</span> <i>vx</i> )</h3>
<p>Sets the horizontal component of the canvas item's velocity to <i>vx</i>.</p>
<p><b>See also </b><a href="q3canvasitem.html#xVelocity">xVelocity</a>(), <a href="q3canvasitem.html#setYVelocity">setYVelocity</a>(), and <a href="q3canvasitem.html#setVelocity">setVelocity</a>().</p>
<!-- @@@setXVelocity -->
<!-- $$$setY[overload1]$$$setYdouble -->
<h3 class="fn"><a name="setY"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setY</span> ( <span class="type">double</span> <i>y</i> )</h3>
<p>Moves the canvas item so that its y-position is <i>y</i>.</p>
<p><b>See also </b><a href="q3canvasitem.html#y">y</a>() and <a href="q3canvasitem.html#move">move</a>().</p>
<!-- @@@setY -->
<!-- $$$setYVelocity[overload1]$$$setYVelocitydouble -->
<h3 class="fn"><a name="setYVelocity"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setYVelocity</span> ( <span class="type">double</span> <i>vy</i> )</h3>
<p>Sets the vertical component of the canvas item's velocity to <i>vy</i>.</p>
<p><b>See also </b><a href="q3canvasitem.html#yVelocity">yVelocity</a>(), <a href="q3canvasitem.html#setXVelocity">setXVelocity</a>(), and <a href="q3canvasitem.html#setVelocity">setVelocity</a>().</p>
<!-- @@@setYVelocity -->
<!-- $$$setZ[overload1]$$$setZdouble -->
<h3 class="fn"><a name="setZ"></a><span class="type">void</span> Q3CanvasItem::<span class="name">setZ</span> ( <span class="type">double</span> <i>z</i> )</h3>
<p>Sets the z index of the canvas item to <i>z</i>. Higher-z items obscure (are in front of) lower-z items.</p>
<p><b>See also </b><a href="q3canvasitem.html#z">z</a>() and <a href="q3canvasitem.html#move">move</a>().</p>
<!-- @@@setZ -->
<!-- $$$show[overload1]$$$show -->
<h3 class="fn"><a name="show"></a><span class="type">void</span> Q3CanvasItem::<span class="name">show</span> ()</h3>
<p>Shorthand for setVisible(true).</p>
<!-- @@@show -->
<!-- $$$update[overload1]$$$update -->
<h3 class="fn"><a name="update"></a><span class="type">void</span> Q3CanvasItem::<span class="name">update</span> ()<tt> [protected]</tt></h3>
<p>Call this function to repaint the canvas's changed chunks.</p>
<!-- @@@update -->
<!-- $$$x[overload1]$$$x -->
<h3 class="fn"><a name="x"></a><span class="type">double</span> Q3CanvasItem::<span class="name">x</span> () const</h3>
<p>Returns the horizontal position of the canvas item. Note that subclasses often have an origin other than the top-left corner.</p>
<p><b>See also </b><a href="q3canvasitem.html#setX">setX</a>().</p>
<!-- @@@x -->
<!-- $$$xVelocity[overload1]$$$xVelocity -->
<h3 class="fn"><a name="xVelocity"></a><span class="type">double</span> Q3CanvasItem::<span class="name">xVelocity</span> () const</h3>
<p>Returns the horizontal velocity component of the canvas item.</p>
<p><b>See also </b><a href="q3canvasitem.html#setXVelocity">setXVelocity</a>().</p>
<!-- @@@xVelocity -->
<!-- $$$y[overload1]$$$y -->
<h3 class="fn"><a name="y"></a><span class="type">double</span> Q3CanvasItem::<span class="name">y</span> () const</h3>
<p>Returns the vertical position of the canvas item. Note that subclasses often have an origin other than the top-left corner.</p>
<p><b>See also </b><a href="q3canvasitem.html#setY">setY</a>().</p>
<!-- @@@y -->
<!-- $$$yVelocity[overload1]$$$yVelocity -->
<h3 class="fn"><a name="yVelocity"></a><span class="type">double</span> Q3CanvasItem::<span class="name">yVelocity</span> () const</h3>
<p>Returns the vertical velocity component of the canvas item.</p>
<p><b>See also </b><a href="q3canvasitem.html#setYVelocity">setYVelocity</a>().</p>
<!-- @@@yVelocity -->
<!-- $$$z[overload1]$$$z -->
<h3 class="fn"><a name="z"></a><span class="type">double</span> Q3CanvasItem::<span class="name">z</span> () const</h3>
<p>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.</p>
<p><b>See also </b><a href="q3canvasitem.html#setZ">setZ</a>().</p>
<!-- @@@z -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
