<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Irrlicht 3D Engine: IMeshCache.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Irrlicht 3D Engine
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_i_mesh_cache_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">IMeshCache.h</div> </div>
</div>
<div class="contents">
<a href="_i_mesh_cache_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (C) 2002-2012 Nikolaus Gebhardt</span>
<a name="l00002"></a>00002 <span class="comment">// This file is part of the "Irrlicht Engine".</span>
<a name="l00003"></a>00003 <span class="comment">// For conditions of distribution and use, see copyright notice in irrlicht.h</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="preprocessor">#ifndef __I_MESH_CACHE_H_INCLUDED__</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#define __I_MESH_CACHE_H_INCLUDED__</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include "<a class="code" href="_i_reference_counted_8h.html">IReferenceCounted.h</a>"</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include "<a class="code" href="path_8h.html">path.h</a>"</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="keyword">namespace </span>irr
<a name="l00012"></a>00012 {
<a name="l00013"></a>00013
<a name="l00014"></a>00014 <span class="keyword">namespace </span>scene
<a name="l00015"></a>00015 {
<a name="l00016"></a>00016 <span class="keyword">class </span>IMesh;
<a name="l00017"></a>00017 <span class="keyword">class </span>IAnimatedMesh;
<a name="l00018"></a>00018 <span class="keyword">class </span>IAnimatedMeshSceneNode;
<a name="l00019"></a>00019 <span class="keyword">class </span>IMeshLoader;
<a name="l00020"></a>00020
<a name="l00022"></a>00022
<a name="l00027"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html">00027</a> <span class="keyword">class </span><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html" title="The mesh cache stores already loaded meshes and provides an interface to them.">IMeshCache</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine.">IReferenceCounted</a>
<a name="l00028"></a>00028 {
<a name="l00029"></a>00029 <span class="keyword">public</span>:
<a name="l00030"></a>00030
<a name="l00032"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a6d1bfbd0bda8a559d85cfd6735bc0667">00032</a> <span class="keyword">virtual</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a6d1bfbd0bda8a559d85cfd6735bc0667" title="Destructor.">~IMeshCache</a>() {}
<a name="l00033"></a>00033
<a name="l00035"></a>00035
<a name="l00050"></a>00050 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a2959812a3a393817b1db42761766c49b" title="Adds a mesh to the internal list of loaded meshes.">addMesh</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& name, <a class="code" href="classirr_1_1scene_1_1_i_animated_mesh.html" title="Interface for an animated mesh.">IAnimatedMesh</a>* mesh) = 0;
<a name="l00051"></a>00051
<a name="l00053"></a>00053
<a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#aa82078b06fdcaa332b44a59e4027f921" title="Removes the mesh from the cache.">removeMesh</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh.html" title="Class which holds the geometry of an object.">IMesh</a>* <span class="keyword">const</span> mesh) = 0;
<a name="l00058"></a>00058
<a name="l00060"></a>00060
<a name="l00065"></a>00065 <span class="keyword">virtual</span> <a class="code" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804" title="32 bit unsigned variable.">u32</a> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a9dc99e46309a6ef494ef7672c9b49853" title="Returns amount of loaded meshes in the cache.">getMeshCount</a>() <span class="keyword">const</span> = 0;
<a name="l00066"></a>00066
<a name="l00068"></a>00068
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <a class="code" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6" title="32 bit signed variable.">s32</a> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a2b3512bd3ff11d0b290fa5d2d580eb54" title="Returns current index number of the mesh or -1 when not found.">getMeshIndex</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh.html" title="Class which holds the geometry of an object.">IMesh</a>* <span class="keyword">const</span> mesh) <span class="keyword">const</span> = 0;
<a name="l00071"></a>00071
<a name="l00073"></a>00073
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <a class="code" href="classirr_1_1scene_1_1_i_animated_mesh.html" title="Interface for an animated mesh.">IAnimatedMesh</a>* <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a06e7755013445f9bc3d7339fbd009e31" title="Returns a mesh based on its index number.">getMeshByIndex</a>(<a class="code" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804" title="32 bit unsigned variable.">u32</a> index) = 0;
<a name="l00080"></a>00080
<a name="l00082"></a>00082
<a name="l00084"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#aa3946324e39cc074b1f73e01d57cae70">00084</a> <a class="code" href="irr_types_8h.html#ab68eafeefba066eff1f12c7d78f14814" title="Defines a deprecated macro which generates a warning at compile time.">_IRR_DEPRECATED_</a> <a class="code" href="classirr_1_1scene_1_1_i_animated_mesh.html" title="Interface for an animated mesh.">IAnimatedMesh</a>* <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#aa3946324e39cc074b1f73e01d57cae70" title="Returns a mesh based on its name (often a filename).">getMeshByFilename</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& filename)
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 <span class="keywordflow">return</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a4c93e736bdca8c84d478afc82540d6bb" title="Returns a mesh based on its name.">getMeshByName</a>(filename);
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00090"></a>00090
<a name="l00092"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a981d182125565ef2d115774ea2f2de5e">00092</a> <a class="code" href="irr_types_8h.html#ab68eafeefba066eff1f12c7d78f14814" title="Defines a deprecated macro which generates a warning at compile time.">_IRR_DEPRECATED_</a> <span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a981d182125565ef2d115774ea2f2de5e" title="Get the name of a loaded mesh, based on its index. (Name is often identical to the filename)...">getMeshFilename</a>(<a class="code" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804" title="32 bit unsigned variable.">u32</a> index)<span class="keyword"> const</span>
<a name="l00093"></a>00093 <span class="keyword"> </span>{
<a name="l00094"></a>00094 <span class="keywordflow">return</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#af06efb8fb21f6bba16e52d879b5d3ddd" title="Get the name of a loaded mesh, based on its index.">getMeshName</a>(index).<a class="code" href="structirr_1_1io_1_1_s_named_path.html#ab491ba694139f03d2a8ece5d3efdd7ed">getInternalName</a>();
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096
<a name="l00098"></a>00098
<a name="l00100"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a194468ebfebdaa70fb57622479d5db11">00100</a> <a class="code" href="irr_types_8h.html#ab68eafeefba066eff1f12c7d78f14814" title="Defines a deprecated macro which generates a warning at compile time.">_IRR_DEPRECATED_</a> <span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a981d182125565ef2d115774ea2f2de5e" title="Get the name of a loaded mesh, based on its index. (Name is often identical to the filename)...">getMeshFilename</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh.html" title="Class which holds the geometry of an object.">IMesh</a>* <span class="keyword">const</span> mesh)<span class="keyword"> const</span>
<a name="l00101"></a>00101 <span class="keyword"> </span>{
<a name="l00102"></a>00102 <span class="keywordflow">return</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#af06efb8fb21f6bba16e52d879b5d3ddd" title="Get the name of a loaded mesh, based on its index.">getMeshName</a>(mesh).<a class="code" href="structirr_1_1io_1_1_s_named_path.html#ab491ba694139f03d2a8ece5d3efdd7ed">getInternalName</a>();
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104
<a name="l00106"></a>00106
<a name="l00108"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a5b87031dbfdb70a59c00a1b892b74c3d">00108</a> <a class="code" href="irr_types_8h.html#ab68eafeefba066eff1f12c7d78f14814" title="Defines a deprecated macro which generates a warning at compile time.">_IRR_DEPRECATED_</a> <span class="keywordtype">bool</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a5b87031dbfdb70a59c00a1b892b74c3d" title="Renames a loaded mesh.">setMeshFilename</a>(<a class="code" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804" title="32 bit unsigned variable.">u32</a> index, <span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& filename)
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <span class="keywordflow">return</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a820743b703cdc4362a3dbe6664271bcb" title="Renames a loaded mesh.">renameMesh</a>(index, filename);
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00114"></a>00114
<a name="l00116"></a><a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a9b7770a23859ddd045b3c22dfbecbcaf">00116</a> <a class="code" href="irr_types_8h.html#ab68eafeefba066eff1f12c7d78f14814" title="Defines a deprecated macro which generates a warning at compile time.">_IRR_DEPRECATED_</a> <span class="keywordtype">bool</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a5b87031dbfdb70a59c00a1b892b74c3d" title="Renames a loaded mesh.">setMeshFilename</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh.html" title="Class which holds the geometry of an object.">IMesh</a>* <span class="keyword">const</span> mesh, <span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& filename)
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <span class="keywordflow">return</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a820743b703cdc4362a3dbe6664271bcb" title="Renames a loaded mesh.">renameMesh</a>(mesh, filename);
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120
<a name="l00122"></a>00122
<a name="l00124"></a>00124 <span class="keyword">virtual</span> <a class="code" href="classirr_1_1scene_1_1_i_animated_mesh.html" title="Interface for an animated mesh.">IAnimatedMesh</a>* <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a4c93e736bdca8c84d478afc82540d6bb" title="Returns a mesh based on its name.">getMeshByName</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& name) = 0;
<a name="l00125"></a>00125
<a name="l00127"></a>00127
<a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="structirr_1_1io_1_1_s_named_path.html" title="Used in places where we identify objects by a filename, but don't actually work with the real filenam...">io::SNamedPath</a>& <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#af06efb8fb21f6bba16e52d879b5d3ddd" title="Get the name of a loaded mesh, based on its index.">getMeshName</a>(<a class="code" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804" title="32 bit unsigned variable.">u32</a> index) <span class="keyword">const</span> = 0;
<a name="l00130"></a>00130
<a name="l00132"></a>00132
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="structirr_1_1io_1_1_s_named_path.html" title="Used in places where we identify objects by a filename, but don't actually work with the real filenam...">io::SNamedPath</a>& <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#af06efb8fb21f6bba16e52d879b5d3ddd" title="Get the name of a loaded mesh, based on its index.">getMeshName</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh.html" title="Class which holds the geometry of an object.">IMesh</a>* <span class="keyword">const</span> mesh) <span class="keyword">const</span> = 0;
<a name="l00135"></a>00135
<a name="l00137"></a>00137
<a name="l00143"></a>00143 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a820743b703cdc4362a3dbe6664271bcb" title="Renames a loaded mesh.">renameMesh</a>(<a class="code" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804" title="32 bit unsigned variable.">u32</a> index, <span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& name) = 0;
<a name="l00144"></a>00144
<a name="l00146"></a>00146
<a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a820743b703cdc4362a3dbe6664271bcb" title="Renames a loaded mesh.">renameMesh</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh.html" title="Class which holds the geometry of an object.">IMesh</a>* <span class="keyword">const</span> mesh, <span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& name) = 0;
<a name="l00153"></a>00153
<a name="l00155"></a>00155
<a name="l00157"></a>00157 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a42a13fab5b76ab7142a1d47dac80548b" title="Check if a mesh was already loaded.">isMeshLoaded</a>(<span class="keyword">const</span> <a class="code" href="classirr_1_1core_1_1string.html">io::path</a>& name) = 0;
<a name="l00158"></a>00158
<a name="l00160"></a>00160
<a name="l00164"></a>00164 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#ad92d924e558c3a7504f9154ee29b1569" title="Clears the whole mesh cache, removing all meshes.">clear</a>() = 0;
<a name="l00165"></a>00165
<a name="l00167"></a>00167
<a name="l00169"></a>00169 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classirr_1_1scene_1_1_i_mesh_cache.html#a9f3e20b8e0f66d59bc454a311d13bbee" title="Clears all meshes that are held in the mesh cache but not used anywhere else.">clearUnusedMeshes</a>() = 0;
<a name="l00170"></a>00170 };
<a name="l00171"></a>00171
<a name="l00172"></a>00172
<a name="l00173"></a>00173 } <span class="comment">// end namespace scene</span>
<a name="l00174"></a>00174 } <span class="comment">// end namespace irr</span>
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="preprocessor">#endif</span>
<a name="l00177"></a>00177 <span class="preprocessor"></span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="_i_mesh_cache_8h.html">IMeshCache.h</a> </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<li class="footer">
<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:39 for Irrlicht 3D Engine by
<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
</ul>
</div>
</body>
</html>
