1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::FileSystemArchive 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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>Ogre::FileSystemArchive Class Reference</h1>Specialisation of the <a class="el" href="classOgre_1_1Archive.html">Archive</a> class to allow reading of files from filesystem folders / directories. |
---|
11 | <a href="#_details">More...</a> |
---|
12 | <p> |
---|
13 | <code>#include <<a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a>></code> |
---|
14 | <p> |
---|
15 | <p>Inheritance diagram for Ogre::FileSystemArchive: |
---|
16 | <p><center><img src="classOgre_1_1FileSystemArchive.png" usemap="#Ogre::FileSystemArchive_map" border="0" alt=""></center> |
---|
17 | <map name="Ogre::FileSystemArchive_map"> |
---|
18 | <area href="classOgre_1_1Archive.html" alt="Ogre::Archive" shape="rect" coords="0,0,153,24"> |
---|
19 | </map> |
---|
20 | <a href="classOgre_1_1FileSystemArchive-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> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea0">FileSystemArchive</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &name, const <a class="el" href="namespaceOgre.html#a426">String</a> &archType)</td></tr> |
---|
24 | |
---|
25 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea1">~FileSystemArchive</a> ()</td></tr> |
---|
26 | |
---|
27 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea2">isCaseSensitive</a> (void) const </td></tr> |
---|
28 | |
---|
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileSystemArchivea2"></a><br><br></td></tr> |
---|
30 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea3">load</a> ()</td></tr> |
---|
31 | |
---|
32 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Remarks:</b></dt><dd>This initializes all the internal data of the class. </dd></dl> |
---|
33 | <dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl> |
---|
34 | <a href="#Ogre_1_1FileSystemArchivea3"></a><br><br></td></tr> |
---|
35 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea4">unload</a> ()</td></tr> |
---|
36 | |
---|
37 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl> |
---|
38 | <a href="#Ogre_1_1FileSystemArchivea4"></a><br><br></td></tr> |
---|
39 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea5">open</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &filename) const </td></tr> |
---|
40 | |
---|
41 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Note:</b></dt><dd>There is no equivalent 'close' method; the returned stream controls the lifecycle of this file operation. </dd></dl> |
---|
42 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
43 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
44 | <tr><td valign=top><em>filename</em> </td><td>The fully qualified name of the file </td></tr> |
---|
45 | </table> |
---|
46 | </dl> |
---|
47 | <dl compact><dt><b>Returns:</b></dt><dd>A shared pointer to a <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which can be used to read / write the file. If the file is not present, returns a null shared pointer.</dd></dl> |
---|
48 | <a href="#Ogre_1_1FileSystemArchivea5"></a><br><br></td></tr> |
---|
49 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea6">list</a> (bool recursive=true)</td></tr> |
---|
50 | |
---|
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using listFileInfo. </dd></dl> |
---|
52 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
53 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
54 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
55 | </table> |
---|
56 | </dl> |
---|
57 | <dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl> |
---|
58 | <a href="#Ogre_1_1FileSystemArchivea6"></a><br><br></td></tr> |
---|
59 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea7">listFileInfo</a> (bool recursive=true)</td></tr> |
---|
60 | |
---|
61 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
62 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
63 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
64 | </table> |
---|
65 | </dl> |
---|
66 | <dl compact><dt><b>Returns:</b></dt><dd>A list of structures detailing quite a lot of information about all the files in the archive.</dd></dl> |
---|
67 | <a href="#Ogre_1_1FileSystemArchivea7"></a><br><br></td></tr> |
---|
68 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea8">find</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &pattern, bool recursive=true)</td></tr> |
---|
69 | |
---|
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using findFileInfo. </dd></dl> |
---|
71 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
72 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
73 | <tr><td valign=top><em>pattern</em> </td><td>The pattern to search for; wildcards (*) are allowed </td></tr> |
---|
74 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
75 | </table> |
---|
76 | </dl> |
---|
77 | <dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl> |
---|
78 | <a href="#Ogre_1_1FileSystemArchivea8"></a><br><br></td></tr> |
---|
79 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea9">findFileInfo</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &pattern, bool recursive=true)</td></tr> |
---|
80 | |
---|
81 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
82 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
83 | <tr><td valign=top><em>pattern</em> </td><td>The pattern to search for; wildcards (*) are allowed </td></tr> |
---|
84 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
85 | </table> |
---|
86 | </dl> |
---|
87 | <dl compact><dt><b>Returns:</b></dt><dd>A list of file information structures for all files matching the criteria.</dd></dl> |
---|
88 | <a href="#Ogre_1_1FileSystemArchivea9"></a><br><br></td></tr> |
---|
89 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea10">exists</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &filename)</td></tr> |
---|
90 | |
---|
91 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileSystemArchivea10"></a><br><br></td></tr> |
---|
92 | <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivea11">getName</a> (void) const </td></tr> |
---|
93 | |
---|
94 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this archive. <a href="#Ogre_1_1ZipArchivea11"></a><br><br></td></tr> |
---|
95 | <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivea12">getType</a> (void) const </td></tr> |
---|
96 | |
---|
97 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type code of this <a class="el" href="classOgre_1_1Archive.html">Archive</a>. <a href="#Ogre_1_1ZipArchivea12"></a><br><br></td></tr> |
---|
98 | <tr><td colspan=2><br><h2>Protected Types</h2></td></tr> |
---|
99 | <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::deque< <a class="el" href="namespaceOgre.html#a426">String</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivex0">DirectoryStack</a></td></tr> |
---|
100 | |
---|
101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Directory stack of previous directories. <a href="#Ogre_1_1FileSystemArchivex0"></a><br><br></td></tr> |
---|
102 | <tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> |
---|
103 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchiveb0">findFiles</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &pattern, bool recursive, <a class="el" href="namespaceOgre.html#a535">StringVector</a> *simpleList, <a class="el" href="namespaceOgre.html#a2">FileInfoList</a> *detailList, const <a class="el" href="namespaceOgre.html#a426">String</a> &currentDir="")</td></tr> |
---|
104 | |
---|
105 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to retrieve all files in a directory matching pattern. <a href="#Ogre_1_1FileSystemArchiveb0"></a><br><br></td></tr> |
---|
106 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchiveb1">changeDirectory</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &dir) const </td></tr> |
---|
107 | |
---|
108 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to change the current directory. <a href="#Ogre_1_1FileSystemArchiveb1"></a><br><br></td></tr> |
---|
109 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchiveb2">pushDirectory</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &dir) const </td></tr> |
---|
110 | |
---|
111 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to change directory and push the current directory onto a stack. <a href="#Ogre_1_1FileSystemArchiveb2"></a><br><br></td></tr> |
---|
112 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchiveb3">popDirectory</a> (void) const </td></tr> |
---|
113 | |
---|
114 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Utility method to pop a previous directory off the stack and change to it. <a href="#Ogre_1_1FileSystemArchiveb3"></a><br><br></td></tr> |
---|
115 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
116 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivep0">mBasePath</a></td></tr> |
---|
117 | |
---|
118 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Base path; actually the same as mName, but for clarity. <a href="#Ogre_1_1FileSystemArchivep0"></a><br><br></td></tr> |
---|
119 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivex0">DirectoryStack</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivep1">mDirectoryStack</a></td></tr> |
---|
120 | |
---|
121 | <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivep2">mTmpPath</a> [OGRE_MAX_PATH]</td></tr> |
---|
122 | |
---|
123 | <tr><td class="mdescLeft"> </td><td class="mdescRight">temporary C-string to retrieve paths <a href="#Ogre_1_1FileSystemArchivep2"></a><br><br></td></tr> |
---|
124 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep2">mName</a></td></tr> |
---|
125 | |
---|
126 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOgre_1_1Archive.html">Archive</a> name. <a href="#Ogre_1_1ZipArchivep2"></a><br><br></td></tr> |
---|
127 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep3">mType</a></td></tr> |
---|
128 | |
---|
129 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOgre_1_1Archive.html">Archive</a> type code. <a href="#Ogre_1_1ZipArchivep3"></a><br><br></td></tr> |
---|
130 | </table> |
---|
131 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
132 | Specialisation of the <a class="el" href="classOgre_1_1Archive.html">Archive</a> class to allow reading of files from filesystem folders / directories. |
---|
133 | <p> |
---|
134 | |
---|
135 | <p> |
---|
136 | Definition at line <a class="el" href="OgreFileSystem_8h-source.html#l00038">38</a> of file <a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a>.<hr><h2>Member Typedef Documentation</h2> |
---|
137 | <a class="anchor" name="Ogre_1_1FileSystemArchivex0" doxytag="Ogre::FileSystemArchive::DirectoryStack" ></a><p> |
---|
138 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
139 | <tr> |
---|
140 | <td class="mdRow"> |
---|
141 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
142 | <tr> |
---|
143 | <td class="md" nowrap valign="top"> typedef std::deque<<a class="el" href="namespaceOgre.html#a426">String</a>> <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivex0">Ogre::FileSystemArchive::DirectoryStack</a><code> [protected]</code> |
---|
144 | </table> |
---|
145 | </td> |
---|
146 | </tr> |
---|
147 | </table> |
---|
148 | <table cellspacing=5 cellpadding=0 border=0> |
---|
149 | <tr> |
---|
150 | <td> |
---|
151 | |
---|
152 | </td> |
---|
153 | <td> |
---|
154 | |
---|
155 | <p> |
---|
156 | Directory stack of previous directories. |
---|
157 | <p> |
---|
158 | |
---|
159 | <p> |
---|
160 | Definition at line <a class="el" href="OgreFileSystem_8h-source.html#l00047">47</a> of file <a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a>. </td> |
---|
161 | </tr> |
---|
162 | </table> |
---|
163 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
164 | <a class="anchor" name="Ogre_1_1FileSystemArchivea0" doxytag="Ogre::FileSystemArchive::FileSystemArchive" ></a><p> |
---|
165 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
166 | <tr> |
---|
167 | <td class="mdRow"> |
---|
168 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
169 | <tr> |
---|
170 | <td class="md" nowrap valign="top"> Ogre::FileSystemArchive::FileSystemArchive </td> |
---|
171 | <td class="md" valign="top">( </td> |
---|
172 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
173 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
174 | </tr> |
---|
175 | <tr> |
---|
176 | <td class="md" nowrap align="right"></td> |
---|
177 | <td></td> |
---|
178 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
179 | <td class="mdname" nowrap> <em>archType</em></td> |
---|
180 | </tr> |
---|
181 | <tr> |
---|
182 | <td></td> |
---|
183 | <td class="md">) </td> |
---|
184 | <td class="md" colspan="2"></td> |
---|
185 | </tr> |
---|
186 | |
---|
187 | </table> |
---|
188 | </td> |
---|
189 | </tr> |
---|
190 | </table> |
---|
191 | <table cellspacing=5 cellpadding=0 border=0> |
---|
192 | <tr> |
---|
193 | <td> |
---|
194 | |
---|
195 | </td> |
---|
196 | <td> |
---|
197 | |
---|
198 | <p> |
---|
199 | </td> |
---|
200 | </tr> |
---|
201 | </table> |
---|
202 | <a class="anchor" name="Ogre_1_1FileSystemArchivea1" doxytag="Ogre::FileSystemArchive::~FileSystemArchive" ></a><p> |
---|
203 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
204 | <tr> |
---|
205 | <td class="mdRow"> |
---|
206 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
207 | <tr> |
---|
208 | <td class="md" nowrap valign="top"> Ogre::FileSystemArchive::~<a class="el" href="classOgre_1_1FileSystemArchive.html">FileSystemArchive</a> </td> |
---|
209 | <td class="md" valign="top">( </td> |
---|
210 | <td class="mdname1" valign="top" nowrap> </td> |
---|
211 | <td class="md" valign="top"> ) </td> |
---|
212 | <td class="md" nowrap></td> |
---|
213 | </tr> |
---|
214 | |
---|
215 | </table> |
---|
216 | </td> |
---|
217 | </tr> |
---|
218 | </table> |
---|
219 | <table cellspacing=5 cellpadding=0 border=0> |
---|
220 | <tr> |
---|
221 | <td> |
---|
222 | |
---|
223 | </td> |
---|
224 | <td> |
---|
225 | |
---|
226 | <p> |
---|
227 | </td> |
---|
228 | </tr> |
---|
229 | </table> |
---|
230 | <hr><h2>Member Function Documentation</h2> |
---|
231 | <a class="anchor" name="Ogre_1_1FileSystemArchiveb1" doxytag="Ogre::FileSystemArchive::changeDirectory" ></a><p> |
---|
232 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
233 | <tr> |
---|
234 | <td class="mdRow"> |
---|
235 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
236 | <tr> |
---|
237 | <td class="md" nowrap valign="top"> void Ogre::FileSystemArchive::changeDirectory </td> |
---|
238 | <td class="md" valign="top">( </td> |
---|
239 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
240 | <td class="mdname1" valign="top" nowrap> <em>dir</em> </td> |
---|
241 | <td class="md" valign="top"> ) </td> |
---|
242 | <td class="md" nowrap> const<code> [protected]</code></td> |
---|
243 | </tr> |
---|
244 | |
---|
245 | </table> |
---|
246 | </td> |
---|
247 | </tr> |
---|
248 | </table> |
---|
249 | <table cellspacing=5 cellpadding=0 border=0> |
---|
250 | <tr> |
---|
251 | <td> |
---|
252 | |
---|
253 | </td> |
---|
254 | <td> |
---|
255 | |
---|
256 | <p> |
---|
257 | Utility method to change the current directory. |
---|
258 | <p> |
---|
259 | </td> |
---|
260 | </tr> |
---|
261 | </table> |
---|
262 | <a class="anchor" name="Ogre_1_1FileSystemArchivea10" doxytag="Ogre::FileSystemArchive::exists" ></a><p> |
---|
263 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
264 | <tr> |
---|
265 | <td class="mdRow"> |
---|
266 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
267 | <tr> |
---|
268 | <td class="md" nowrap valign="top"> bool Ogre::FileSystemArchive::exists </td> |
---|
269 | <td class="md" valign="top">( </td> |
---|
270 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
271 | <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> |
---|
272 | <td class="md" valign="top"> ) </td> |
---|
273 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
274 | </tr> |
---|
275 | |
---|
276 | </table> |
---|
277 | </td> |
---|
278 | </tr> |
---|
279 | </table> |
---|
280 | <table cellspacing=5 cellpadding=0 border=0> |
---|
281 | <tr> |
---|
282 | <td> |
---|
283 | |
---|
284 | </td> |
---|
285 | <td> |
---|
286 | |
---|
287 | <p> |
---|
288 | |
---|
289 | <p> |
---|
290 | |
---|
291 | <p> |
---|
292 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea10">Ogre::Archive</a>. </td> |
---|
293 | </tr> |
---|
294 | </table> |
---|
295 | <a class="anchor" name="Ogre_1_1FileSystemArchivea8" doxytag="Ogre::FileSystemArchive::find" ></a><p> |
---|
296 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
297 | <tr> |
---|
298 | <td class="mdRow"> |
---|
299 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
300 | <tr> |
---|
301 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> Ogre::FileSystemArchive::find </td> |
---|
302 | <td class="md" valign="top">( </td> |
---|
303 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
304 | <td class="mdname" nowrap> <em>pattern</em>, </td> |
---|
305 | </tr> |
---|
306 | <tr> |
---|
307 | <td class="md" nowrap align="right"></td> |
---|
308 | <td></td> |
---|
309 | <td class="md" nowrap>bool </td> |
---|
310 | <td class="mdname" nowrap> <em>recursive</em> = true</td> |
---|
311 | </tr> |
---|
312 | <tr> |
---|
313 | <td></td> |
---|
314 | <td class="md">) </td> |
---|
315 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
316 | </tr> |
---|
317 | |
---|
318 | </table> |
---|
319 | </td> |
---|
320 | </tr> |
---|
321 | </table> |
---|
322 | <table cellspacing=5 cellpadding=0 border=0> |
---|
323 | <tr> |
---|
324 | <td> |
---|
325 | |
---|
326 | </td> |
---|
327 | <td> |
---|
328 | |
---|
329 | <p> |
---|
330 | <dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using findFileInfo. </dd></dl> |
---|
331 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
332 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
333 | <tr><td valign=top><em>pattern</em> </td><td>The pattern to search for; wildcards (*) are allowed </td></tr> |
---|
334 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
335 | </table> |
---|
336 | </dl> |
---|
337 | <dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl> |
---|
338 | |
---|
339 | <p> |
---|
340 | |
---|
341 | <p> |
---|
342 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea9">Ogre::Archive</a>. </td> |
---|
343 | </tr> |
---|
344 | </table> |
---|
345 | <a class="anchor" name="Ogre_1_1FileSystemArchivea9" doxytag="Ogre::FileSystemArchive::findFileInfo" ></a><p> |
---|
346 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
347 | <tr> |
---|
348 | <td class="mdRow"> |
---|
349 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
350 | <tr> |
---|
351 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> Ogre::FileSystemArchive::findFileInfo </td> |
---|
352 | <td class="md" valign="top">( </td> |
---|
353 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
354 | <td class="mdname" nowrap> <em>pattern</em>, </td> |
---|
355 | </tr> |
---|
356 | <tr> |
---|
357 | <td class="md" nowrap align="right"></td> |
---|
358 | <td></td> |
---|
359 | <td class="md" nowrap>bool </td> |
---|
360 | <td class="mdname" nowrap> <em>recursive</em> = true</td> |
---|
361 | </tr> |
---|
362 | <tr> |
---|
363 | <td></td> |
---|
364 | <td class="md">) </td> |
---|
365 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
366 | </tr> |
---|
367 | |
---|
368 | </table> |
---|
369 | </td> |
---|
370 | </tr> |
---|
371 | </table> |
---|
372 | <table cellspacing=5 cellpadding=0 border=0> |
---|
373 | <tr> |
---|
374 | <td> |
---|
375 | |
---|
376 | </td> |
---|
377 | <td> |
---|
378 | |
---|
379 | <p> |
---|
380 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
381 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
382 | <tr><td valign=top><em>pattern</em> </td><td>The pattern to search for; wildcards (*) are allowed </td></tr> |
---|
383 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
384 | </table> |
---|
385 | </dl> |
---|
386 | <dl compact><dt><b>Returns:</b></dt><dd>A list of file information structures for all files matching the criteria.</dd></dl> |
---|
387 | |
---|
388 | <p> |
---|
389 | |
---|
390 | <p> |
---|
391 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea11">Ogre::Archive</a>. </td> |
---|
392 | </tr> |
---|
393 | </table> |
---|
394 | <a class="anchor" name="Ogre_1_1FileSystemArchiveb0" doxytag="Ogre::FileSystemArchive::findFiles" ></a><p> |
---|
395 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
396 | <tr> |
---|
397 | <td class="mdRow"> |
---|
398 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
399 | <tr> |
---|
400 | <td class="md" nowrap valign="top"> void Ogre::FileSystemArchive::findFiles </td> |
---|
401 | <td class="md" valign="top">( </td> |
---|
402 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
403 | <td class="mdname" nowrap> <em>pattern</em>, </td> |
---|
404 | </tr> |
---|
405 | <tr> |
---|
406 | <td class="md" nowrap align="right"></td> |
---|
407 | <td></td> |
---|
408 | <td class="md" nowrap>bool </td> |
---|
409 | <td class="mdname" nowrap> <em>recursive</em>, </td> |
---|
410 | </tr> |
---|
411 | <tr> |
---|
412 | <td class="md" nowrap align="right"></td> |
---|
413 | <td></td> |
---|
414 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a535">StringVector</a> * </td> |
---|
415 | <td class="mdname" nowrap> <em>simpleList</em>, </td> |
---|
416 | </tr> |
---|
417 | <tr> |
---|
418 | <td class="md" nowrap align="right"></td> |
---|
419 | <td></td> |
---|
420 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a2">FileInfoList</a> * </td> |
---|
421 | <td class="mdname" nowrap> <em>detailList</em>, </td> |
---|
422 | </tr> |
---|
423 | <tr> |
---|
424 | <td class="md" nowrap align="right"></td> |
---|
425 | <td></td> |
---|
426 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
427 | <td class="mdname" nowrap> <em>currentDir</em> = ""</td> |
---|
428 | </tr> |
---|
429 | <tr> |
---|
430 | <td></td> |
---|
431 | <td class="md">) </td> |
---|
432 | <td class="md" colspan="2"><code> [protected]</code></td> |
---|
433 | </tr> |
---|
434 | |
---|
435 | </table> |
---|
436 | </td> |
---|
437 | </tr> |
---|
438 | </table> |
---|
439 | <table cellspacing=5 cellpadding=0 border=0> |
---|
440 | <tr> |
---|
441 | <td> |
---|
442 | |
---|
443 | </td> |
---|
444 | <td> |
---|
445 | |
---|
446 | <p> |
---|
447 | Utility method to retrieve all files in a directory matching pattern. |
---|
448 | <p> |
---|
449 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
450 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
451 | <tr><td valign=top><em>pattern</em> </td><td>File pattern </td></tr> |
---|
452 | <tr><td valign=top><em>recursive</em> </td><td>Whether to cascade down directories </td></tr> |
---|
453 | <tr><td valign=top><em>simpleList</em> </td><td>Populated if retrieving a simple list </td></tr> |
---|
454 | <tr><td valign=top><em>detailList</em> </td><td>Populated if retrieving a detailed list </td></tr> |
---|
455 | <tr><td valign=top><em>currentDir</em> </td><td>The current directory relative to the base of the archive, for file naming </td></tr> |
---|
456 | </table> |
---|
457 | </dl> |
---|
458 | </td> |
---|
459 | </tr> |
---|
460 | </table> |
---|
461 | <a class="anchor" name="Ogre_1_1ZipArchivea11" doxytag="Ogre::FileSystemArchive::getName" ></a><p> |
---|
462 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
463 | <tr> |
---|
464 | <td class="mdRow"> |
---|
465 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
466 | <tr> |
---|
467 | <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>& Ogre::Archive::getName </td> |
---|
468 | <td class="md" valign="top">( </td> |
---|
469 | <td class="md" nowrap valign="top">void </td> |
---|
470 | <td class="mdname1" valign="top" nowrap> </td> |
---|
471 | <td class="md" valign="top"> ) </td> |
---|
472 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
473 | </tr> |
---|
474 | |
---|
475 | </table> |
---|
476 | </td> |
---|
477 | </tr> |
---|
478 | </table> |
---|
479 | <table cellspacing=5 cellpadding=0 border=0> |
---|
480 | <tr> |
---|
481 | <td> |
---|
482 | |
---|
483 | </td> |
---|
484 | <td> |
---|
485 | |
---|
486 | <p> |
---|
487 | Get the name of this archive. |
---|
488 | <p> |
---|
489 | |
---|
490 | <p> |
---|
491 | Definition at line <a class="el" href="OgreArchive_8h-source.html#l00096">96</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>. |
---|
492 | <p> |
---|
493 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>. </td> |
---|
494 | </tr> |
---|
495 | </table> |
---|
496 | <a class="anchor" name="Ogre_1_1ZipArchivea12" doxytag="Ogre::FileSystemArchive::getType" ></a><p> |
---|
497 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
498 | <tr> |
---|
499 | <td class="mdRow"> |
---|
500 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
501 | <tr> |
---|
502 | <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>& Ogre::Archive::getType </td> |
---|
503 | <td class="md" valign="top">( </td> |
---|
504 | <td class="md" nowrap valign="top">void </td> |
---|
505 | <td class="mdname1" valign="top" nowrap> </td> |
---|
506 | <td class="md" valign="top"> ) </td> |
---|
507 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
508 | </tr> |
---|
509 | |
---|
510 | </table> |
---|
511 | </td> |
---|
512 | </tr> |
---|
513 | </table> |
---|
514 | <table cellspacing=5 cellpadding=0 border=0> |
---|
515 | <tr> |
---|
516 | <td> |
---|
517 | |
---|
518 | </td> |
---|
519 | <td> |
---|
520 | |
---|
521 | <p> |
---|
522 | Return the type code of this <a class="el" href="classOgre_1_1Archive.html">Archive</a>. |
---|
523 | <p> |
---|
524 | |
---|
525 | <p> |
---|
526 | Definition at line <a class="el" href="OgreArchive_8h-source.html#l00172">172</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>. |
---|
527 | <p> |
---|
528 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>. </td> |
---|
529 | </tr> |
---|
530 | </table> |
---|
531 | <a class="anchor" name="Ogre_1_1FileSystemArchivea2" doxytag="Ogre::FileSystemArchive::isCaseSensitive" ></a><p> |
---|
532 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
533 | <tr> |
---|
534 | <td class="mdRow"> |
---|
535 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
536 | <tr> |
---|
537 | <td class="md" nowrap valign="top"> bool Ogre::FileSystemArchive::isCaseSensitive </td> |
---|
538 | <td class="md" valign="top">( </td> |
---|
539 | <td class="md" nowrap valign="top">void </td> |
---|
540 | <td class="mdname1" valign="top" nowrap> </td> |
---|
541 | <td class="md" valign="top"> ) </td> |
---|
542 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
543 | </tr> |
---|
544 | |
---|
545 | </table> |
---|
546 | </td> |
---|
547 | </tr> |
---|
548 | </table> |
---|
549 | <table cellspacing=5 cellpadding=0 border=0> |
---|
550 | <tr> |
---|
551 | <td> |
---|
552 | |
---|
553 | </td> |
---|
554 | <td> |
---|
555 | |
---|
556 | <p> |
---|
557 | |
---|
558 | <p> |
---|
559 | |
---|
560 | <p> |
---|
561 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea3">Ogre::Archive</a>. </td> |
---|
562 | </tr> |
---|
563 | </table> |
---|
564 | <a class="anchor" name="Ogre_1_1FileSystemArchivea6" doxytag="Ogre::FileSystemArchive::list" ></a><p> |
---|
565 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
566 | <tr> |
---|
567 | <td class="mdRow"> |
---|
568 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
569 | <tr> |
---|
570 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> Ogre::FileSystemArchive::list </td> |
---|
571 | <td class="md" valign="top">( </td> |
---|
572 | <td class="md" nowrap valign="top">bool </td> |
---|
573 | <td class="mdname1" valign="top" nowrap> <em>recursive</em> = true </td> |
---|
574 | <td class="md" valign="top"> ) </td> |
---|
575 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
576 | </tr> |
---|
577 | |
---|
578 | </table> |
---|
579 | </td> |
---|
580 | </tr> |
---|
581 | </table> |
---|
582 | <table cellspacing=5 cellpadding=0 border=0> |
---|
583 | <tr> |
---|
584 | <td> |
---|
585 | |
---|
586 | </td> |
---|
587 | <td> |
---|
588 | |
---|
589 | <p> |
---|
590 | <dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using listFileInfo. </dd></dl> |
---|
591 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
592 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
593 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
594 | </table> |
---|
595 | </dl> |
---|
596 | <dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl> |
---|
597 | |
---|
598 | <p> |
---|
599 | |
---|
600 | <p> |
---|
601 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea7">Ogre::Archive</a>. </td> |
---|
602 | </tr> |
---|
603 | </table> |
---|
604 | <a class="anchor" name="Ogre_1_1FileSystemArchivea7" doxytag="Ogre::FileSystemArchive::listFileInfo" ></a><p> |
---|
605 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
606 | <tr> |
---|
607 | <td class="mdRow"> |
---|
608 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
609 | <tr> |
---|
610 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> Ogre::FileSystemArchive::listFileInfo </td> |
---|
611 | <td class="md" valign="top">( </td> |
---|
612 | <td class="md" nowrap valign="top">bool </td> |
---|
613 | <td class="mdname1" valign="top" nowrap> <em>recursive</em> = true </td> |
---|
614 | <td class="md" valign="top"> ) </td> |
---|
615 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
616 | </tr> |
---|
617 | |
---|
618 | </table> |
---|
619 | </td> |
---|
620 | </tr> |
---|
621 | </table> |
---|
622 | <table cellspacing=5 cellpadding=0 border=0> |
---|
623 | <tr> |
---|
624 | <td> |
---|
625 | |
---|
626 | </td> |
---|
627 | <td> |
---|
628 | |
---|
629 | <p> |
---|
630 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
631 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
632 | <tr><td valign=top><em>recursive</em> </td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr> |
---|
633 | </table> |
---|
634 | </dl> |
---|
635 | <dl compact><dt><b>Returns:</b></dt><dd>A list of structures detailing quite a lot of information about all the files in the archive.</dd></dl> |
---|
636 | |
---|
637 | <p> |
---|
638 | |
---|
639 | <p> |
---|
640 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea8">Ogre::Archive</a>. </td> |
---|
641 | </tr> |
---|
642 | </table> |
---|
643 | <a class="anchor" name="Ogre_1_1FileSystemArchivea3" doxytag="Ogre::FileSystemArchive::load" ></a><p> |
---|
644 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
645 | <tr> |
---|
646 | <td class="mdRow"> |
---|
647 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
648 | <tr> |
---|
649 | <td class="md" nowrap valign="top"> void Ogre::FileSystemArchive::load </td> |
---|
650 | <td class="md" valign="top">( </td> |
---|
651 | <td class="mdname1" valign="top" nowrap> </td> |
---|
652 | <td class="md" valign="top"> ) </td> |
---|
653 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
654 | </tr> |
---|
655 | |
---|
656 | </table> |
---|
657 | </td> |
---|
658 | </tr> |
---|
659 | </table> |
---|
660 | <table cellspacing=5 cellpadding=0 border=0> |
---|
661 | <tr> |
---|
662 | <td> |
---|
663 | |
---|
664 | </td> |
---|
665 | <td> |
---|
666 | |
---|
667 | <p> |
---|
668 | <dl compact><dt><b>Remarks:</b></dt><dd>This initializes all the internal data of the class. </dd></dl> |
---|
669 | <dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl> |
---|
670 | |
---|
671 | <p> |
---|
672 | |
---|
673 | <p> |
---|
674 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea4">Ogre::Archive</a>. </td> |
---|
675 | </tr> |
---|
676 | </table> |
---|
677 | <a class="anchor" name="Ogre_1_1FileSystemArchivea5" doxytag="Ogre::FileSystemArchive::open" ></a><p> |
---|
678 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
679 | <tr> |
---|
680 | <td class="mdRow"> |
---|
681 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
682 | <tr> |
---|
683 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> Ogre::FileSystemArchive::open </td> |
---|
684 | <td class="md" valign="top">( </td> |
---|
685 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
686 | <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> |
---|
687 | <td class="md" valign="top"> ) </td> |
---|
688 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
689 | </tr> |
---|
690 | |
---|
691 | </table> |
---|
692 | </td> |
---|
693 | </tr> |
---|
694 | </table> |
---|
695 | <table cellspacing=5 cellpadding=0 border=0> |
---|
696 | <tr> |
---|
697 | <td> |
---|
698 | |
---|
699 | </td> |
---|
700 | <td> |
---|
701 | |
---|
702 | <p> |
---|
703 | <dl compact><dt><b>Note:</b></dt><dd>There is no equivalent 'close' method; the returned stream controls the lifecycle of this file operation. </dd></dl> |
---|
704 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
705 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
706 | <tr><td valign=top><em>filename</em> </td><td>The fully qualified name of the file </td></tr> |
---|
707 | </table> |
---|
708 | </dl> |
---|
709 | <dl compact><dt><b>Returns:</b></dt><dd>A shared pointer to a <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which can be used to read / write the file. If the file is not present, returns a null shared pointer.</dd></dl> |
---|
710 | |
---|
711 | <p> |
---|
712 | |
---|
713 | <p> |
---|
714 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea6">Ogre::Archive</a>. </td> |
---|
715 | </tr> |
---|
716 | </table> |
---|
717 | <a class="anchor" name="Ogre_1_1FileSystemArchiveb3" doxytag="Ogre::FileSystemArchive::popDirectory" ></a><p> |
---|
718 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
719 | <tr> |
---|
720 | <td class="mdRow"> |
---|
721 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
722 | <tr> |
---|
723 | <td class="md" nowrap valign="top"> void Ogre::FileSystemArchive::popDirectory </td> |
---|
724 | <td class="md" valign="top">( </td> |
---|
725 | <td class="md" nowrap valign="top">void </td> |
---|
726 | <td class="mdname1" valign="top" nowrap> </td> |
---|
727 | <td class="md" valign="top"> ) </td> |
---|
728 | <td class="md" nowrap> const<code> [protected]</code></td> |
---|
729 | </tr> |
---|
730 | |
---|
731 | </table> |
---|
732 | </td> |
---|
733 | </tr> |
---|
734 | </table> |
---|
735 | <table cellspacing=5 cellpadding=0 border=0> |
---|
736 | <tr> |
---|
737 | <td> |
---|
738 | |
---|
739 | </td> |
---|
740 | <td> |
---|
741 | |
---|
742 | <p> |
---|
743 | Utility method to pop a previous directory off the stack and change to it. |
---|
744 | <p> |
---|
745 | </td> |
---|
746 | </tr> |
---|
747 | </table> |
---|
748 | <a class="anchor" name="Ogre_1_1FileSystemArchiveb2" doxytag="Ogre::FileSystemArchive::pushDirectory" ></a><p> |
---|
749 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
750 | <tr> |
---|
751 | <td class="mdRow"> |
---|
752 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
753 | <tr> |
---|
754 | <td class="md" nowrap valign="top"> void Ogre::FileSystemArchive::pushDirectory </td> |
---|
755 | <td class="md" valign="top">( </td> |
---|
756 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
757 | <td class="mdname1" valign="top" nowrap> <em>dir</em> </td> |
---|
758 | <td class="md" valign="top"> ) </td> |
---|
759 | <td class="md" nowrap> const<code> [protected]</code></td> |
---|
760 | </tr> |
---|
761 | |
---|
762 | </table> |
---|
763 | </td> |
---|
764 | </tr> |
---|
765 | </table> |
---|
766 | <table cellspacing=5 cellpadding=0 border=0> |
---|
767 | <tr> |
---|
768 | <td> |
---|
769 | |
---|
770 | </td> |
---|
771 | <td> |
---|
772 | |
---|
773 | <p> |
---|
774 | Utility method to change directory and push the current directory onto a stack. |
---|
775 | <p> |
---|
776 | </td> |
---|
777 | </tr> |
---|
778 | </table> |
---|
779 | <a class="anchor" name="Ogre_1_1FileSystemArchivea4" doxytag="Ogre::FileSystemArchive::unload" ></a><p> |
---|
780 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
781 | <tr> |
---|
782 | <td class="mdRow"> |
---|
783 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
784 | <tr> |
---|
785 | <td class="md" nowrap valign="top"> void Ogre::FileSystemArchive::unload </td> |
---|
786 | <td class="md" valign="top">( </td> |
---|
787 | <td class="mdname1" valign="top" nowrap> </td> |
---|
788 | <td class="md" valign="top"> ) </td> |
---|
789 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
790 | </tr> |
---|
791 | |
---|
792 | </table> |
---|
793 | </td> |
---|
794 | </tr> |
---|
795 | </table> |
---|
796 | <table cellspacing=5 cellpadding=0 border=0> |
---|
797 | <tr> |
---|
798 | <td> |
---|
799 | |
---|
800 | </td> |
---|
801 | <td> |
---|
802 | |
---|
803 | <p> |
---|
804 | <dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl> |
---|
805 | |
---|
806 | <p> |
---|
807 | |
---|
808 | <p> |
---|
809 | Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea5">Ogre::Archive</a>. </td> |
---|
810 | </tr> |
---|
811 | </table> |
---|
812 | <hr><h2>Member Data Documentation</h2> |
---|
813 | <a class="anchor" name="Ogre_1_1FileSystemArchivep0" doxytag="Ogre::FileSystemArchive::mBasePath" ></a><p> |
---|
814 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
815 | <tr> |
---|
816 | <td class="mdRow"> |
---|
817 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
818 | <tr> |
---|
819 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivep0">Ogre::FileSystemArchive::mBasePath</a><code> [protected]</code> |
---|
820 | </table> |
---|
821 | </td> |
---|
822 | </tr> |
---|
823 | </table> |
---|
824 | <table cellspacing=5 cellpadding=0 border=0> |
---|
825 | <tr> |
---|
826 | <td> |
---|
827 | |
---|
828 | </td> |
---|
829 | <td> |
---|
830 | |
---|
831 | <p> |
---|
832 | Base path; actually the same as mName, but for clarity. |
---|
833 | <p> |
---|
834 | |
---|
835 | <p> |
---|
836 | Definition at line <a class="el" href="OgreFileSystem_8h-source.html#l00044">44</a> of file <a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a>. </td> |
---|
837 | </tr> |
---|
838 | </table> |
---|
839 | <a class="anchor" name="Ogre_1_1FileSystemArchivep1" doxytag="Ogre::FileSystemArchive::mDirectoryStack" ></a><p> |
---|
840 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
841 | <tr> |
---|
842 | <td class="mdRow"> |
---|
843 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
844 | <tr> |
---|
845 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivex0">DirectoryStack</a> <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivep1">Ogre::FileSystemArchive::mDirectoryStack</a><code> [mutable, protected]</code> |
---|
846 | </table> |
---|
847 | </td> |
---|
848 | </tr> |
---|
849 | </table> |
---|
850 | <table cellspacing=5 cellpadding=0 border=0> |
---|
851 | <tr> |
---|
852 | <td> |
---|
853 | |
---|
854 | </td> |
---|
855 | <td> |
---|
856 | |
---|
857 | <p> |
---|
858 | |
---|
859 | <p> |
---|
860 | Definition at line <a class="el" href="OgreFileSystem_8h-source.html#l00048">48</a> of file <a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a>. </td> |
---|
861 | </tr> |
---|
862 | </table> |
---|
863 | <a class="anchor" name="Ogre_1_1ZipArchivep2" doxytag="Ogre::FileSystemArchive::mName" ></a><p> |
---|
864 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
865 | <tr> |
---|
866 | <td class="mdRow"> |
---|
867 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
868 | <tr> |
---|
869 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep2">Ogre::Archive::mName</a><code> [protected, inherited]</code> |
---|
870 | </table> |
---|
871 | </td> |
---|
872 | </tr> |
---|
873 | </table> |
---|
874 | <table cellspacing=5 cellpadding=0 border=0> |
---|
875 | <tr> |
---|
876 | <td> |
---|
877 | |
---|
878 | </td> |
---|
879 | <td> |
---|
880 | |
---|
881 | <p> |
---|
882 | <a class="el" href="classOgre_1_1Archive.html">Archive</a> name. |
---|
883 | <p> |
---|
884 | |
---|
885 | <p> |
---|
886 | Definition at line <a class="el" href="OgreArchive_8h-source.html#l00080">80</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>. </td> |
---|
887 | </tr> |
---|
888 | </table> |
---|
889 | <a class="anchor" name="Ogre_1_1FileSystemArchivep2" doxytag="Ogre::FileSystemArchive::mTmpPath" ></a><p> |
---|
890 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
891 | <tr> |
---|
892 | <td class="mdRow"> |
---|
893 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
894 | <tr> |
---|
895 | <td class="md" nowrap valign="top"> char <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivep2">Ogre::FileSystemArchive::mTmpPath</a>[OGRE_MAX_PATH]<code> [mutable, protected]</code> |
---|
896 | </table> |
---|
897 | </td> |
---|
898 | </tr> |
---|
899 | </table> |
---|
900 | <table cellspacing=5 cellpadding=0 border=0> |
---|
901 | <tr> |
---|
902 | <td> |
---|
903 | |
---|
904 | </td> |
---|
905 | <td> |
---|
906 | |
---|
907 | <p> |
---|
908 | temporary C-string to retrieve paths |
---|
909 | <p> |
---|
910 | |
---|
911 | <p> |
---|
912 | Definition at line <a class="el" href="OgreFileSystem_8h-source.html#l00052">52</a> of file <a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a>. </td> |
---|
913 | </tr> |
---|
914 | </table> |
---|
915 | <a class="anchor" name="Ogre_1_1ZipArchivep3" doxytag="Ogre::FileSystemArchive::mType" ></a><p> |
---|
916 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
917 | <tr> |
---|
918 | <td class="mdRow"> |
---|
919 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
920 | <tr> |
---|
921 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep3">Ogre::Archive::mType</a><code> [protected, inherited]</code> |
---|
922 | </table> |
---|
923 | </td> |
---|
924 | </tr> |
---|
925 | </table> |
---|
926 | <table cellspacing=5 cellpadding=0 border=0> |
---|
927 | <tr> |
---|
928 | <td> |
---|
929 | |
---|
930 | </td> |
---|
931 | <td> |
---|
932 | |
---|
933 | <p> |
---|
934 | <a class="el" href="classOgre_1_1Archive.html">Archive</a> type code. |
---|
935 | <p> |
---|
936 | |
---|
937 | <p> |
---|
938 | Definition at line <a class="el" href="OgreArchive_8h-source.html#l00082">82</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>. </td> |
---|
939 | </tr> |
---|
940 | </table> |
---|
941 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
942 | <li><a class="el" href="OgreFileSystem_8h-source.html">OgreFileSystem.h</a></ul> |
---|
943 | <hr> |
---|
944 | <p> |
---|
945 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
946 | <!--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/> |
---|
947 | This 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/> |
---|
948 | <!--/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#"> |
---|
949 | <Work rdf:about=""> |
---|
950 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
951 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
952 | </Work> |
---|
953 | <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> --> |
---|
954 | |
---|
955 | Last modified Sun Feb 12 13:00:28 2006 |
---|
956 | </p> |
---|
957 | </body> |
---|
958 | </html> |
---|