source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ZipDataStream.html @ 657

Revision 657, 35.5 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ZipDataStream class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::ZipDataStream Class Reference</h1>Specialisation of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> to handle streaming data from zip archives. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ZipDataStream:
16<p><center><img src="classOgre_1_1ZipDataStream.png" usemap="#Ogre::ZipDataStream_map" border="0" alt=""></center>
17<map name="Ogre::ZipDataStream_map">
18<area href="classOgre_1_1DataStream.html" alt="Ogre::DataStream" shape="rect" coords="0,0,131,24">
19</map>
20<a href="classOgre_1_1ZipDataStream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama0">ZipDataStream</a> (<a class="el" href="OgreZip_8h.html#a1">ZZIP_FILE</a> *zzipFile, size_t uncompressedSize)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unnamed constructor.  <a href="#Ogre_1_1ZipDataStreama0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama1">ZipDataStream</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, <a class="el" href="OgreZip_8h.html#a1">ZZIP_FILE</a> *zzipFile, size_t uncompressedSize)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor for creating named streams.  <a href="#Ogre_1_1ZipDataStreama1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama2">~ZipDataStream</a> ()</td></tr>
30
31<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama3">read</a> (void *buf, size_t count)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
34  <table border="0" cellspacing="2" cellpadding="0">
35    <tr><td valign=top><em>buf</em>&nbsp;</td><td>Reference to a buffer pointer </td></tr>
36    <tr><td valign=top><em>count</em>&nbsp;</td><td>Number of bytes to read </td></tr>
37  </table>
38</dl>
39<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl>
40  <a href="#Ogre_1_1ZipDataStreama3"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama4">readLine</a> (char *buf, size_t maxCount, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;delim="\n")</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
44  <table border="0" cellspacing="2" cellpadding="0">
45    <tr><td valign=top><em>buf</em>&nbsp;</td><td>Reference to a buffer pointer </td></tr>
46    <tr><td valign=top><em>count</em>&nbsp;</td><td>Number of bytes to read </td></tr>
47  </table>
48</dl>
49<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl>
50  <a href="#Ogre_1_1ZipDataStreama4"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama5">skipLine</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;delim="\n")</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
54  <table border="0" cellspacing="2" cellpadding="0">
55    <tr><td valign=top><em>delim</em>&nbsp;</td><td>The delimiter(s) to stop at </td></tr>
56  </table>
57</dl>
58<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl>
59  <a href="#Ogre_1_1ZipDataStreama5"></a><br><br></td></tr>
60<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama6">skip</a> (long count)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.  <a href="#Ogre_1_1ZipDataStreama6"></a><br><br></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama7">seek</a> (size_t pos)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ZipDataStreama7"></a><br><br></td></tr>
66<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama8">tell</a> (void) const </td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ZipDataStreama8"></a><br><br></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama9">eof</a> (void) const </td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ZipDataStreama9"></a><br><br></td></tr>
72<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreama10">close</a> (void)</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ZipDataStreama10"></a><br><br></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama11">getName</a> (void)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the stream, if it has one.  <a href="#Ogre_1_1ZipDataStreama11"></a><br><br></td></tr>
78<tr><td class="memItemLeft" nowrap align=right valign=top>template&lt;typename T&gt; <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama12">operator&gt;&gt;</a> (T &amp;val)</td></tr>
79
80<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama13">getLine</a> (bool trimAfter=true)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a String containing the next line of data, optionally trimmed for whitespace.  <a href="#Ogre_1_1ZipDataStreama13"></a><br><br></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama14">getAsString</a> (void)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a String containing the entire stream.  <a href="#Ogre_1_1ZipDataStreama14"></a><br><br></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama15">size</a> (void) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.  <a href="#Ogre_1_1ZipDataStreama15"></a><br><br></td></tr>
89<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="OgreZip_8h.html#a1">ZZIP_FILE</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreamp0">mZzipFile</a></td></tr>
91
92<tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreamp1">mZipTmpArea</a> [OGRE_STREAM_TEMP_SIZE]</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Temporary zip copy area.  <a href="#Ogre_1_1ZipDataStreamp1"></a><br><br></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">mName</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name (e.g. resource name) that can be used to identify the source fot his data (optional).  <a href="#Ogre_1_1ZipDataStreamp2"></a><br><br></td></tr>
98<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">mSize</a></td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the data in the stream (may be 0 if size cannot be determined).  <a href="#Ogre_1_1ZipDataStreamp3"></a><br><br></td></tr>
101<tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">mTmpArea</a> [OGRE_STREAM_TEMP_SIZE]</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Temporary buffer area used for formatted read.  <a href="#Ogre_1_1ZipDataStreamp4"></a><br><br></td></tr>
104</table>
105<hr><a name="_details"></a><h2>Detailed Description</h2>
106Specialisation of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> to handle streaming data from zip archives.
107<p>
108
109<p>
110Definition at line <a class="el" href="OgreZip_8h-source.html#l00101">101</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
111<a class="anchor" name="Ogre_1_1ZipDataStreama0" doxytag="Ogre::ZipDataStream::ZipDataStream" ></a><p>
112<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
113  <tr>
114    <td class="mdRow">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" nowrap valign="top"> Ogre::ZipDataStream::ZipDataStream </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top"><a class="el" href="OgreZip_8h.html#a1">ZZIP_FILE</a> *&nbsp;</td>
120          <td class="mdname" nowrap> <em>zzipFile</em>, </td>
121        </tr>
122        <tr>
123          <td class="md" nowrap align="right"></td>
124          <td></td>
125          <td class="md" nowrap>size_t&nbsp;</td>
126          <td class="mdname" nowrap> <em>uncompressedSize</em></td>
127        </tr>
128        <tr>
129          <td></td>
130          <td class="md">)&nbsp;</td>
131          <td class="md" colspan="2"></td>
132        </tr>
133
134      </table>
135    </td>
136  </tr>
137</table>
138<table cellspacing=5 cellpadding=0 border=0>
139  <tr>
140    <td>
141      &nbsp;
142    </td>
143    <td>
144
145<p>
146Unnamed constructor.
147<p>
148    </td>
149  </tr>
150</table>
151<a class="anchor" name="Ogre_1_1ZipDataStreama1" doxytag="Ogre::ZipDataStream::ZipDataStream" ></a><p>
152<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
153  <tr>
154    <td class="mdRow">
155      <table cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td class="md" nowrap valign="top"> Ogre::ZipDataStream::ZipDataStream </td>
158          <td class="md" valign="top">(&nbsp;</td>
159          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
160          <td class="mdname" nowrap> <em>name</em>, </td>
161        </tr>
162        <tr>
163          <td class="md" nowrap align="right"></td>
164          <td></td>
165          <td class="md" nowrap><a class="el" href="OgreZip_8h.html#a1">ZZIP_FILE</a> *&nbsp;</td>
166          <td class="mdname" nowrap> <em>zzipFile</em>, </td>
167        </tr>
168        <tr>
169          <td class="md" nowrap align="right"></td>
170          <td></td>
171          <td class="md" nowrap>size_t&nbsp;</td>
172          <td class="mdname" nowrap> <em>uncompressedSize</em></td>
173        </tr>
174        <tr>
175          <td></td>
176          <td class="md">)&nbsp;</td>
177          <td class="md" colspan="2"></td>
178        </tr>
179
180      </table>
181    </td>
182  </tr>
183</table>
184<table cellspacing=5 cellpadding=0 border=0>
185  <tr>
186    <td>
187      &nbsp;
188    </td>
189    <td>
190
191<p>
192Constructor for creating named streams.
193<p>
194    </td>
195  </tr>
196</table>
197<a class="anchor" name="Ogre_1_1ZipDataStreama2" doxytag="Ogre::ZipDataStream::~ZipDataStream" ></a><p>
198<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
199  <tr>
200    <td class="mdRow">
201      <table cellpadding="0" cellspacing="0" border="0">
202        <tr>
203          <td class="md" nowrap valign="top"> Ogre::ZipDataStream::~<a class="el" href="classOgre_1_1ZipDataStream.html">ZipDataStream</a> </td>
204          <td class="md" valign="top">(&nbsp;</td>
205          <td class="mdname1" valign="top" nowrap>          </td>
206          <td class="md" valign="top">&nbsp;)&nbsp;</td>
207          <td class="md" nowrap></td>
208        </tr>
209
210      </table>
211    </td>
212  </tr>
213</table>
214<table cellspacing=5 cellpadding=0 border=0>
215  <tr>
216    <td>
217      &nbsp;
218    </td>
219    <td>
220
221<p>
222    </td>
223  </tr>
224</table>
225<hr><h2>Member Function Documentation</h2>
226<a class="anchor" name="Ogre_1_1ZipDataStreama10" doxytag="Ogre::ZipDataStream::close" ></a><p>
227<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
228  <tr>
229    <td class="mdRow">
230      <table cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td class="md" nowrap valign="top"> void Ogre::ZipDataStream::close </td>
233          <td class="md" valign="top">(&nbsp;</td>
234          <td class="md" nowrap valign="top">void&nbsp;</td>
235          <td class="mdname1" valign="top" nowrap>          </td>
236          <td class="md" valign="top">&nbsp;)&nbsp;</td>
237          <td class="md" nowrap><code> [virtual]</code></td>
238        </tr>
239
240      </table>
241    </td>
242  </tr>
243</table>
244<table cellspacing=5 cellpadding=0 border=0>
245  <tr>
246    <td>
247      &nbsp;
248    </td>
249    <td>
250
251<p>
252 
253<p>
254
255<p>
256Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama15">Ogre::DataStream</a>.    </td>
257  </tr>
258</table>
259<a class="anchor" name="Ogre_1_1ZipDataStreama9" doxytag="Ogre::ZipDataStream::eof" ></a><p>
260<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
261  <tr>
262    <td class="mdRow">
263      <table cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <td class="md" nowrap valign="top"> bool Ogre::ZipDataStream::eof </td>
266          <td class="md" valign="top">(&nbsp;</td>
267          <td class="md" nowrap valign="top">void&nbsp;</td>
268          <td class="mdname1" valign="top" nowrap>          </td>
269          <td class="md" valign="top">&nbsp;)&nbsp;</td>
270          <td class="md" nowrap> const<code> [virtual]</code></td>
271        </tr>
272
273      </table>
274    </td>
275  </tr>
276</table>
277<table cellspacing=5 cellpadding=0 border=0>
278  <tr>
279    <td>
280      &nbsp;
281    </td>
282    <td>
283
284<p>
285 
286<p>
287
288<p>
289Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama13">Ogre::DataStream</a>.    </td>
290  </tr>
291</table>
292<a class="anchor" name="Ogre_1_1ZipDataStreama14" doxytag="Ogre::ZipDataStream::getAsString" ></a><p>
293<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
294  <tr>
295    <td class="mdRow">
296      <table cellpadding="0" cellspacing="0" border="0">
297        <tr>
298          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::DataStream::getAsString </td>
299          <td class="md" valign="top">(&nbsp;</td>
300          <td class="md" nowrap valign="top">void&nbsp;</td>
301          <td class="mdname1" valign="top" nowrap>          </td>
302          <td class="md" valign="top">&nbsp;)&nbsp;</td>
303          <td class="md" nowrap><code> [virtual, inherited]</code></td>
304        </tr>
305
306      </table>
307    </td>
308  </tr>
309</table>
310<table cellspacing=5 cellpadding=0 border=0>
311  <tr>
312    <td>
313      &nbsp;
314    </td>
315    <td>
316
317<p>
318Returns a String containing the entire stream.
319<p>
320<dl compact><dt><b>Remarks:</b></dt><dd>This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.</dd></dl>
321    </td>
322  </tr>
323</table>
324<a class="anchor" name="Ogre_1_1ZipDataStreama13" doxytag="Ogre::ZipDataStream::getLine" ></a><p>
325<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
326  <tr>
327    <td class="mdRow">
328      <table cellpadding="0" cellspacing="0" border="0">
329        <tr>
330          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::DataStream::getLine </td>
331          <td class="md" valign="top">(&nbsp;</td>
332          <td class="md" nowrap valign="top">bool&nbsp;</td>
333          <td class="mdname1" valign="top" nowrap> <em>trimAfter</em> = true          </td>
334          <td class="md" valign="top">&nbsp;)&nbsp;</td>
335          <td class="md" nowrap><code> [virtual, inherited]</code></td>
336        </tr>
337
338      </table>
339    </td>
340  </tr>
341</table>
342<table cellspacing=5 cellpadding=0 border=0>
343  <tr>
344    <td>
345      &nbsp;
346    </td>
347    <td>
348
349<p>
350Returns a String containing the next line of data, optionally trimmed for whitespace.
351<p>
352<dl compact><dt><b>Remarks:</b></dt><dd>This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required. </dd></dl>
353<dl compact><dt><b>Parameters:</b></dt><dd>
354  <table border="0" cellspacing="2" cellpadding="0">
355    <tr><td valign=top><em>trimAfter</em>&nbsp;</td><td>If true, the line is trimmed for whitespace (as in String.trim(true,true))</td></tr>
356  </table>
357</dl>
358    </td>
359  </tr>
360</table>
361<a class="anchor" name="Ogre_1_1ZipDataStreama11" doxytag="Ogre::ZipDataStream::getName" ></a><p>
362<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
363  <tr>
364    <td class="mdRow">
365      <table cellpadding="0" cellspacing="0" border="0">
366        <tr>
367          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::DataStream::getName </td>
368          <td class="md" valign="top">(&nbsp;</td>
369          <td class="md" nowrap valign="top">void&nbsp;</td>
370          <td class="mdname1" valign="top" nowrap>          </td>
371          <td class="md" valign="top">&nbsp;)&nbsp;</td>
372          <td class="md" nowrap><code> [inherited]</code></td>
373        </tr>
374
375      </table>
376    </td>
377  </tr>
378</table>
379<table cellspacing=5 cellpadding=0 border=0>
380  <tr>
381    <td>
382      &nbsp;
383    </td>
384    <td>
385
386<p>
387Returns the name of the stream, if it has one.
388<p>
389
390<p>
391Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00070">70</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.
392<p>
393References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
394  </tr>
395</table>
396<a class="anchor" name="Ogre_1_1ZipDataStreama12" doxytag="Ogre::ZipDataStream::operator>>" ></a><p>
397<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
398  <tr>
399    <td class="mdRow">
400      <table cellpadding="0" cellspacing="0" border="0">
401        <tr>
402          <td class="md" colspan="4">
403template&lt;typename T&gt; </td>
404        </tr>
405        <tr>
406          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DataStream.html">DataStream</a>&amp; Ogre::DataStream::operator&gt;&gt; </td>
407          <td class="md" valign="top">(&nbsp;</td>
408          <td class="md" nowrap valign="top">T &amp;&nbsp;</td>
409          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
410          <td class="md" valign="top">&nbsp;)&nbsp;</td>
411          <td class="md" nowrap><code> [inherited]</code></td>
412        </tr>
413
414      </table>
415    </td>
416  </tr>
417</table>
418<table cellspacing=5 cellpadding=0 border=0>
419  <tr>
420    <td>
421      &nbsp;
422    </td>
423    <td>
424
425<p>
426    </td>
427  </tr>
428</table>
429<a class="anchor" name="Ogre_1_1ZipDataStreama3" doxytag="Ogre::ZipDataStream::read" ></a><p>
430<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
431  <tr>
432    <td class="mdRow">
433      <table cellpadding="0" cellspacing="0" border="0">
434        <tr>
435          <td class="md" nowrap valign="top"> size_t Ogre::ZipDataStream::read </td>
436          <td class="md" valign="top">(&nbsp;</td>
437          <td class="md" nowrap valign="top">void *&nbsp;</td>
438          <td class="mdname" nowrap> <em>buf</em>, </td>
439        </tr>
440        <tr>
441          <td class="md" nowrap align="right"></td>
442          <td></td>
443          <td class="md" nowrap>size_t&nbsp;</td>
444          <td class="mdname" nowrap> <em>count</em></td>
445        </tr>
446        <tr>
447          <td></td>
448          <td class="md">)&nbsp;</td>
449          <td class="md" colspan="2"><code> [virtual]</code></td>
450        </tr>
451
452      </table>
453    </td>
454  </tr>
455</table>
456<table cellspacing=5 cellpadding=0 border=0>
457  <tr>
458    <td>
459      &nbsp;
460    </td>
461    <td>
462
463<p>
464<dl compact><dt><b>Parameters:</b></dt><dd>
465  <table border="0" cellspacing="2" cellpadding="0">
466    <tr><td valign=top><em>buf</em>&nbsp;</td><td>Reference to a buffer pointer </td></tr>
467    <tr><td valign=top><em>count</em>&nbsp;</td><td>Number of bytes to read </td></tr>
468  </table>
469</dl>
470<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl>
471 
472<p>
473
474<p>
475Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama5">Ogre::DataStream</a>.    </td>
476  </tr>
477</table>
478<a class="anchor" name="Ogre_1_1ZipDataStreama4" doxytag="Ogre::ZipDataStream::readLine" ></a><p>
479<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
480  <tr>
481    <td class="mdRow">
482      <table cellpadding="0" cellspacing="0" border="0">
483        <tr>
484          <td class="md" nowrap valign="top"> size_t Ogre::ZipDataStream::readLine </td>
485          <td class="md" valign="top">(&nbsp;</td>
486          <td class="md" nowrap valign="top">char *&nbsp;</td>
487          <td class="mdname" nowrap> <em>buf</em>, </td>
488        </tr>
489        <tr>
490          <td class="md" nowrap align="right"></td>
491          <td></td>
492          <td class="md" nowrap>size_t&nbsp;</td>
493          <td class="mdname" nowrap> <em>maxCount</em>, </td>
494        </tr>
495        <tr>
496          <td class="md" nowrap align="right"></td>
497          <td></td>
498          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
499          <td class="mdname" nowrap> <em>delim</em> = "\n"</td>
500        </tr>
501        <tr>
502          <td></td>
503          <td class="md">)&nbsp;</td>
504          <td class="md" colspan="2"><code> [virtual]</code></td>
505        </tr>
506
507      </table>
508    </td>
509  </tr>
510</table>
511<table cellspacing=5 cellpadding=0 border=0>
512  <tr>
513    <td>
514      &nbsp;
515    </td>
516    <td>
517
518<p>
519<dl compact><dt><b>Parameters:</b></dt><dd>
520  <table border="0" cellspacing="2" cellpadding="0">
521    <tr><td valign=top><em>buf</em>&nbsp;</td><td>Reference to a buffer pointer </td></tr>
522    <tr><td valign=top><em>count</em>&nbsp;</td><td>Number of bytes to read </td></tr>
523  </table>
524</dl>
525<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl>
526 
527<p>
528
529<p>
530Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama6">Ogre::DataStream</a>.    </td>
531  </tr>
532</table>
533<a class="anchor" name="Ogre_1_1ZipDataStreama7" doxytag="Ogre::ZipDataStream::seek" ></a><p>
534<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
535  <tr>
536    <td class="mdRow">
537      <table cellpadding="0" cellspacing="0" border="0">
538        <tr>
539          <td class="md" nowrap valign="top"> void Ogre::ZipDataStream::seek </td>
540          <td class="md" valign="top">(&nbsp;</td>
541          <td class="md" nowrap valign="top">size_t&nbsp;</td>
542          <td class="mdname1" valign="top" nowrap> <em>pos</em>          </td>
543          <td class="md" valign="top">&nbsp;)&nbsp;</td>
544          <td class="md" nowrap><code> [virtual]</code></td>
545        </tr>
546
547      </table>
548    </td>
549  </tr>
550</table>
551<table cellspacing=5 cellpadding=0 border=0>
552  <tr>
553    <td>
554      &nbsp;
555    </td>
556    <td>
557
558<p>
559 
560<p>
561
562<p>
563Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama11">Ogre::DataStream</a>.    </td>
564  </tr>
565</table>
566<a class="anchor" name="Ogre_1_1ZipDataStreama15" doxytag="Ogre::ZipDataStream::size" ></a><p>
567<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
568  <tr>
569    <td class="mdRow">
570      <table cellpadding="0" cellspacing="0" border="0">
571        <tr>
572          <td class="md" nowrap valign="top"> size_t Ogre::DataStream::size </td>
573          <td class="md" valign="top">(&nbsp;</td>
574          <td class="md" nowrap valign="top">void&nbsp;</td>
575          <td class="mdname1" valign="top" nowrap>          </td>
576          <td class="md" valign="top">&nbsp;)&nbsp;</td>
577          <td class="md" nowrap> const<code> [inherited]</code></td>
578        </tr>
579
580      </table>
581    </td>
582  </tr>
583</table>
584<table cellspacing=5 cellpadding=0 border=0>
585  <tr>
586    <td>
587      &nbsp;
588    </td>
589    <td>
590
591<p>
592Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
593<p>
594
595<p>
596Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00138">138</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.    </td>
597  </tr>
598</table>
599<a class="anchor" name="Ogre_1_1ZipDataStreama6" doxytag="Ogre::ZipDataStream::skip" ></a><p>
600<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
601  <tr>
602    <td class="mdRow">
603      <table cellpadding="0" cellspacing="0" border="0">
604        <tr>
605          <td class="md" nowrap valign="top"> void Ogre::ZipDataStream::skip </td>
606          <td class="md" valign="top">(&nbsp;</td>
607          <td class="md" nowrap valign="top">long&nbsp;</td>
608          <td class="mdname1" valign="top" nowrap> <em>count</em>          </td>
609          <td class="md" valign="top">&nbsp;)&nbsp;</td>
610          <td class="md" nowrap><code> [virtual]</code></td>
611        </tr>
612
613      </table>
614    </td>
615  </tr>
616</table>
617<table cellspacing=5 cellpadding=0 border=0>
618  <tr>
619    <td>
620      &nbsp;
621    </td>
622    <td>
623
624<p>
625This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.
626<p>
627
628<p>
629Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama10">Ogre::DataStream</a>.    </td>
630  </tr>
631</table>
632<a class="anchor" name="Ogre_1_1ZipDataStreama5" doxytag="Ogre::ZipDataStream::skipLine" ></a><p>
633<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
634  <tr>
635    <td class="mdRow">
636      <table cellpadding="0" cellspacing="0" border="0">
637        <tr>
638          <td class="md" nowrap valign="top"> size_t Ogre::ZipDataStream::skipLine </td>
639          <td class="md" valign="top">(&nbsp;</td>
640          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
641          <td class="mdname1" valign="top" nowrap> <em>delim</em> = "\n"          </td>
642          <td class="md" valign="top">&nbsp;)&nbsp;</td>
643          <td class="md" nowrap><code> [virtual]</code></td>
644        </tr>
645
646      </table>
647    </td>
648  </tr>
649</table>
650<table cellspacing=5 cellpadding=0 border=0>
651  <tr>
652    <td>
653      &nbsp;
654    </td>
655    <td>
656
657<p>
658<dl compact><dt><b>Parameters:</b></dt><dd>
659  <table border="0" cellspacing="2" cellpadding="0">
660    <tr><td valign=top><em>delim</em>&nbsp;</td><td>The delimiter(s) to stop at </td></tr>
661  </table>
662</dl>
663<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl>
664 
665<p>
666
667<p>
668Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama9">Ogre::DataStream</a>.    </td>
669  </tr>
670</table>
671<a class="anchor" name="Ogre_1_1ZipDataStreama8" doxytag="Ogre::ZipDataStream::tell" ></a><p>
672<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
673  <tr>
674    <td class="mdRow">
675      <table cellpadding="0" cellspacing="0" border="0">
676        <tr>
677          <td class="md" nowrap valign="top"> size_t Ogre::ZipDataStream::tell </td>
678          <td class="md" valign="top">(&nbsp;</td>
679          <td class="md" nowrap valign="top">void&nbsp;</td>
680          <td class="mdname1" valign="top" nowrap>          </td>
681          <td class="md" valign="top">&nbsp;)&nbsp;</td>
682          <td class="md" nowrap> const<code> [virtual]</code></td>
683        </tr>
684
685      </table>
686    </td>
687  </tr>
688</table>
689<table cellspacing=5 cellpadding=0 border=0>
690  <tr>
691    <td>
692      &nbsp;
693    </td>
694    <td>
695
696<p>
697 
698<p>
699
700<p>
701Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama12">Ogre::DataStream</a>.    </td>
702  </tr>
703</table>
704<hr><h2>Member Data Documentation</h2>
705<a class="anchor" name="Ogre_1_1ZipDataStreamp2" doxytag="Ogre::ZipDataStream::mName" ></a><p>
706<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
707  <tr>
708    <td class="mdRow">
709      <table cellpadding="0" cellspacing="0" border="0">
710        <tr>
711          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">Ogre::DataStream::mName</a><code> [protected, inherited]</code>
712      </table>
713    </td>
714  </tr>
715</table>
716<table cellspacing=5 cellpadding=0 border=0>
717  <tr>
718    <td>
719      &nbsp;
720    </td>
721    <td>
722
723<p>
724The name (e.g. resource name) that can be used to identify the source fot his data (optional).
725<p>
726
727<p>
728Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00058">58</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.    </td>
729  </tr>
730</table>
731<a class="anchor" name="Ogre_1_1ZipDataStreamp3" doxytag="Ogre::ZipDataStream::mSize" ></a><p>
732<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
733  <tr>
734    <td class="mdRow">
735      <table cellpadding="0" cellspacing="0" border="0">
736        <tr>
737          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">Ogre::DataStream::mSize</a><code> [protected, inherited]</code>
738      </table>
739    </td>
740  </tr>
741</table>
742<table cellspacing=5 cellpadding=0 border=0>
743  <tr>
744    <td>
745      &nbsp;
746    </td>
747    <td>
748
749<p>
750Size of the data in the stream (may be 0 if size cannot be determined).
751<p>
752
753<p>
754Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00060">60</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.    </td>
755  </tr>
756</table>
757<a class="anchor" name="Ogre_1_1ZipDataStreamp4" doxytag="Ogre::ZipDataStream::mTmpArea" ></a><p>
758<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
759  <tr>
760    <td class="mdRow">
761      <table cellpadding="0" cellspacing="0" border="0">
762        <tr>
763          <td class="md" nowrap valign="top"> char <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">Ogre::DataStream::mTmpArea</a>[OGRE_STREAM_TEMP_SIZE]<code> [protected, inherited]</code>
764      </table>
765    </td>
766  </tr>
767</table>
768<table cellspacing=5 cellpadding=0 border=0>
769  <tr>
770    <td>
771      &nbsp;
772    </td>
773    <td>
774
775<p>
776Temporary buffer area used for formatted read.
777<p>
778
779<p>
780Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00063">63</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.    </td>
781  </tr>
782</table>
783<a class="anchor" name="Ogre_1_1ZipDataStreamp1" doxytag="Ogre::ZipDataStream::mZipTmpArea" ></a><p>
784<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
785  <tr>
786    <td class="mdRow">
787      <table cellpadding="0" cellspacing="0" border="0">
788        <tr>
789          <td class="md" nowrap valign="top"> char <a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreamp1">Ogre::ZipDataStream::mZipTmpArea</a>[OGRE_STREAM_TEMP_SIZE]<code> [protected]</code>
790      </table>
791    </td>
792  </tr>
793</table>
794<table cellspacing=5 cellpadding=0 border=0>
795  <tr>
796    <td>
797      &nbsp;
798    </td>
799    <td>
800
801<p>
802Temporary zip copy area.
803<p>
804
805<p>
806Definition at line <a class="el" href="OgreZip_8h-source.html#l00106">106</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
807  </tr>
808</table>
809<a class="anchor" name="Ogre_1_1ZipDataStreamp0" doxytag="Ogre::ZipDataStream::mZzipFile" ></a><p>
810<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
811  <tr>
812    <td class="mdRow">
813      <table cellpadding="0" cellspacing="0" border="0">
814        <tr>
815          <td class="md" nowrap valign="top"> <a class="el" href="OgreZip_8h.html#a1">ZZIP_FILE</a>* <a class="el" href="classOgre_1_1ZipDataStream.html#Ogre_1_1ZipDataStreamp0">Ogre::ZipDataStream::mZzipFile</a><code> [protected]</code>
816      </table>
817    </td>
818  </tr>
819</table>
820<table cellspacing=5 cellpadding=0 border=0>
821  <tr>
822    <td>
823      &nbsp;
824    </td>
825    <td>
826
827<p>
828
829<p>
830Definition at line <a class="el" href="OgreZip_8h-source.html#l00104">104</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
831  </tr>
832</table>
833<hr>The documentation for this class was generated from the following file:<ul>
834<li><a class="el" href="OgreZip_8h-source.html">OgreZip.h</a></ul>
835<hr>
836<p>
837Copyright &copy; 2000-2005 by The OGRE Team<br />
838<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
839This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
840                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
841                <Work rdf:about="">
842                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
843        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
844                </Work>
845                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
846
847Last modified Sun Feb 12 13:05:06 2006
848</p>
849</body>
850</html>
Note: See TracBrowser for help on using the repository browser.