1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
<?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: Q3CanvasPixmapArray Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<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>Q3CanvasPixmapArray</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-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3CanvasPixmapArray Class Reference</h1>
<!-- $$$Q3CanvasPixmapArray-brief -->
<p>The Q3CanvasPixmapArray class provides an array of Q3CanvasPixmaps. <a href="#details">More...</a></p>
<!-- @@@Q3CanvasPixmapArray -->
<pre class="cpp"> <span class="preprocessor">#include <Q3CanvasPixmapArray></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>
<ul>
<li><a href="q3canvaspixmaparray-members.html">List of all members, including inherited members</a></li>
<li><a href="q3canvaspixmaparray-obsolete.html">Obsolete members</a></li>
</ul>
<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="q3canvaspixmaparray.html#Q3CanvasPixmapArray">Q3CanvasPixmapArray</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#Q3CanvasPixmapArray-2">Q3CanvasPixmapArray</a></b> ( const QString & <i>datafilenamepattern</i>, int <i>fc</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#Q3CanvasPixmapArray-4">Q3CanvasPixmapArray</a></b> ( Q3ValueList<QPixmap> <i>list</i>, Q3PointArray <i>hotspots</i> = Q3PointArray() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#dtor.Q3CanvasPixmapArray">~Q3CanvasPixmapArray</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3CanvasPixmap * </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#image">image</a></b> ( int <i>i</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#readCollisionMasks">readCollisionMasks</a></b> ( const QString & <i>filename</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#readPixmaps">readPixmaps</a></b> ( const QString & <i>filenamepattern</i>, int <i>fc</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmaparray.html#setImage">setImage</a></b> ( int <i>i</i>, Q3CanvasPixmap * <i>p</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$Q3CanvasPixmapArray-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3CanvasPixmapArray class provides an array of Q3CanvasPixmaps.</p>
<p>This class is used by <a href="q3canvassprite.html">Q3CanvasSprite</a> 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.</p>
<p>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 QPixmaps. You can also read in a set of pixmaps after construction using <a href="q3canvaspixmaparray.html#readPixmaps">readPixmaps</a>().</p>
<p>Individual pixmaps can be set with <a href="q3canvaspixmaparray.html#setImage">setImage</a>() and retrieved with <a href="q3canvaspixmaparray.html#image">image</a>(). The number of pixmaps in the array is returned by <a href="q3canvaspixmaparray.html#count">count</a>().</p>
<p><a href="q3canvassprite.html">Q3CanvasSprite</a> uses an image's mask for collision detection. You can change this by reading in a separate set of image masks using <a href="q3canvaspixmaparray.html#readCollisionMasks">readCollisionMasks</a>().</p>
</div>
<p><b>See also </b><a href="http://doc.qt.nokia.com/qtcanvas">QtCanvas</a> and <a href="graphicsview-porting.html">Porting to Graphics View</a>.</p>
<!-- @@@Q3CanvasPixmapArray -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3CanvasPixmapArray[overload1]$$$Q3CanvasPixmapArray -->
<h3 class="fn"><a name="Q3CanvasPixmapArray"></a>Q3CanvasPixmapArray::<span class="name">Q3CanvasPixmapArray</span> ()</h3>
<p>Constructs an invalid array (i.e. <a href="q3canvaspixmaparray.html#isValid">isValid</a>() will return false). You must call <a href="q3canvaspixmaparray.html#readPixmaps">readPixmaps</a>() before being able to use this <a href="q3canvaspixmaparray.html" class="compat">Q3CanvasPixmapArray</a>.</p>
<!-- @@@Q3CanvasPixmapArray -->
<!-- $$$Q3CanvasPixmapArray$$$Q3CanvasPixmapArrayconstQString&int -->
<h3 class="fn"><a name="Q3CanvasPixmapArray-2"></a>Q3CanvasPixmapArray::<span class="name">Q3CanvasPixmapArray</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>datafilenamepattern</i>, <span class="type">int</span> <i>fc</i> = 0 )</h3>
<p>Constructs a <a href="q3canvaspixmaparray.html" class="compat">Q3CanvasPixmapArray</a> from files.</p>
<p>The <i>fc</i> parameter sets the number of frames to be loaded for this image.</p>
<p>If <i>fc</i> is not 0, <i>datafilenamepattern</i> 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.</p>
<p>If <i>fc</i> is 0, <i>datafilenamepattern</i> is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame.</p>
<p>If <i>datafilenamepattern</i> does not exist, is not readable, isn't an image, or some other error occurs, the array ends up empty and <a href="q3canvaspixmaparray.html#isValid">isValid</a>() returns false.</p>
<!-- @@@Q3CanvasPixmapArray -->
<!-- $$$Q3CanvasPixmapArray$$$Q3CanvasPixmapArrayQ3ValueList<QPixmap>Q3PointArray -->
<h3 class="fn"><a name="Q3CanvasPixmapArray-4"></a>Q3CanvasPixmapArray::<span class="name">Q3CanvasPixmapArray</span> ( <span class="type"><a href="q3valuelist.html">Q3ValueList</a></span><<span class="type"><a href="qpixmap.html">QPixmap</a></span>> <i>list</i>, <span class="type"><a href="q3pointarray.html">Q3PointArray</a></span> <i>hotspots</i> = Q3PointArray() )</h3>
<p>Constructs a <a href="q3canvaspixmaparray.html" class="compat">Q3CanvasPixmapArray</a> from the list of QPixmaps in the <i>list</i>. Each pixmap will get a hotspot according to the <i>hotspots</i> array. If no hotspots are specified, each one is set to be at position (0, 0).</p>
<p>If an error occurs, <a href="q3canvaspixmaparray.html#isValid">isValid</a>() will return false.</p>
<!-- @@@Q3CanvasPixmapArray -->
<!-- $$$~Q3CanvasPixmapArray[overload1]$$$~Q3CanvasPixmapArray -->
<h3 class="fn"><a name="dtor.Q3CanvasPixmapArray"></a>Q3CanvasPixmapArray::<span class="name">~Q3CanvasPixmapArray</span> ()</h3>
<p>Destroys the pixmap array and all the pixmaps it contains.</p>
<!-- @@@~Q3CanvasPixmapArray -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3CanvasPixmapArray::<span class="name">count</span> () const</h3>
<p>Returns the number of pixmaps in the array.</p>
<!-- @@@count -->
<!-- $$$image[overload1]$$$imageint -->
<h3 class="fn"><a name="image"></a><span class="type"><a href="q3canvaspixmap.html">Q3CanvasPixmap</a></span> * Q3CanvasPixmapArray::<span class="name">image</span> ( <span class="type">int</span> <i>i</i> ) const</h3>
<p>Returns pixmap <i>i</i> in the array, if <i>i</i> is non-negative and less than than <a href="q3canvaspixmaparray.html#count">count</a>(), and returns an unspecified value otherwise.</p>
<p><b>See also </b><a href="q3canvaspixmaparray.html#setImage">setImage</a>().</p>
<!-- @@@image -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> Q3CanvasPixmapArray::<span class="name">isValid</span> () const</h3>
<p>Returns true if the pixmap array is valid; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$readCollisionMasks[overload1]$$$readCollisionMasksconstQString& -->
<h3 class="fn"><a name="readCollisionMasks"></a><span class="type">bool</span> Q3CanvasPixmapArray::<span class="name">readCollisionMasks</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>filename</i> )</h3>
<p>Reads new collision masks for the array.</p>
<p>By default, <a href="q3canvassprite.html" class="compat">Q3CanvasSprite</a> uses the image mask of a sprite to detect collisions. Use this function to set your own collision image masks.</p>
<p>If <a href="q3canvaspixmaparray.html#count">count</a>() is 1 <i>filename</i> must specify a real filename to read the mask from. If <a href="q3canvaspixmaparray.html#count">count</a>() is greater than 1, the <i>filename</i> must contain a "%1" that will get replaced by the number of the mask to be loaded, just like <a href="q3canvaspixmaparray.html#readPixmaps">Q3CanvasPixmapArray::readPixmaps</a>().</p>
<p>All collision masks must be 1-bit images or this function call will fail.</p>
<p>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.</p>
<p><b>See also </b><a href="q3canvaspixmaparray.html#isValid">isValid</a>().</p>
<!-- @@@readCollisionMasks -->
<!-- $$$readPixmaps[overload1]$$$readPixmapsconstQString&int -->
<h3 class="fn"><a name="readPixmaps"></a><span class="type">bool</span> Q3CanvasPixmapArray::<span class="name">readPixmaps</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>filenamepattern</i>, <span class="type">int</span> <i>fc</i> = 0 )</h3>
<p>Reads one or more pixmaps into the pixmap array.</p>
<p>If <i>fc</i> is not 0, <i>filenamepattern</i> 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.</p>
<p>If <i>fc</i> is 0, <i>filenamepattern</i> is asssumed to be a filename, and the image contained in this file will be loaded as the first (and only) frame.</p>
<p>If <i>filenamepattern</i> does not exist, is not readable, isn't an image, or some other error occurs, this function will return false, and <a href="q3canvaspixmaparray.html#isValid">isValid</a>() will return false; otherwise this function will return true.</p>
<p><b>See also </b><a href="q3canvaspixmaparray.html#isValid">isValid</a>().</p>
<!-- @@@readPixmaps -->
<!-- $$$setImage[overload1]$$$setImageintQ3CanvasPixmap* -->
<h3 class="fn"><a name="setImage"></a><span class="type">void</span> Q3CanvasPixmapArray::<span class="name">setImage</span> ( <span class="type">int</span> <i>i</i>, <span class="type"><a href="q3canvaspixmap.html">Q3CanvasPixmap</a></span> * <i>p</i> )</h3>
<p>Replaces the pixmap at index <i>i</i> with pixmap <i>p</i>.</p>
<p>The array takes ownership of <i>p</i> and will delete <i>p</i> when the array itself is deleted.</p>
<p>If <i>i</i> is beyond the end of the array the array is extended to at least i+1 elements, with elements <a href="q3canvaspixmaparray.html#count">count</a>() to i-1 being initialized to 0.</p>
<p><b>See also </b><a href="q3canvaspixmaparray.html#image">image</a>().</p>
<!-- @@@setImage -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. 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>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
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>
</body>
</html>
|
