<!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>FIFE: FIFE::ResourceLocation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FIFE <span id="projectnumber">2008.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<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>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</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('class_f_i_f_e_1_1_resource_location.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">FIFE::ResourceLocation Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::ResourceLocation" -->
<p><code>#include <<a class="el" href="resource__location_8h_source.html">resource_location.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FIFE::ResourceLocation:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_resource_location__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_resource_location_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_resource_location_inherit__map" id="_f_i_f_e_1_1_resource_location_inherit__map">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_image_location.html" title="{FIFE::ImageLocation\n|- m_xshift\l- m_yshift\l- m_width\l- m_height\l- m_parent_image\l|+ ImageLocation()\l+ setXShift()\l+ getXShift()\l+ setYShift()\l+ getYShift()\l+ setWidth()\l+ getWidth()\l+ setHeight()\l+ getHeight()\l+ setParentSource()\l+ getParentSource()\l+ operator==()\l+ operator\<()\l+ clone()\l}" alt="" coords="15,262,159,642"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_f_i_f_e_1_1_resource_location-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_resource_location.html#a010b1472eaaab279d74abd79229cd028">ResourceLocation</a> (const std::string &filename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_resource_location.html#a54ac721a48a942b1f2259217a27442b3">~ResourceLocation</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_resource_location.html#a6fc2be7dde119dc1c482ce3b58fe20e5">getFilename</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_resource_location.html#a6631cea99008d9296d2505d0b2dd8522">operator==</a> (const <a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a> &loc) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_resource_location.html#ad318a950a95f92b475e11dff4fefa9c4">operator<</a> (const <a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a> &loc) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_resource_location.html#aafa82d59b6bea0414cab7d7bac531d86">clone</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Contains information about the Location of a Resource</p>
<p>This class is used to give ResoureProvider the information where to find the data.</p>
<p>WARNING: It is <b>very</b> important that the comparison operators work correctly, otherwise the pools will silently consume more and more memory. So before you change something there, think about the implications. Please. </p>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00051">51</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a010b1472eaaab279d74abd79229cd028"></a><!-- doxytag: member="FIFE::ResourceLocation::ResourceLocation" ref="a010b1472eaaab279d74abd79229cd028" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::ResourceLocation::ResourceLocation </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00057">57</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
<p>Referenced by <a class="el" href="resource__location_8h_source.html#l00098">clone()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_resource_location_a010b1472eaaab279d74abd79229cd028_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_resource_location_a010b1472eaaab279d74abd79229cd028_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_resource_location_a010b1472eaaab279d74abd79229cd028_icgraph" id="class_f_i_f_e_1_1_resource_location_a010b1472eaaab279d74abd79229cd028_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_resource_location.html#aafa82d59b6bea0414cab7d7bac531d86" title="FIFE::ResourceLocation::clone" alt="" coords="331,32,533,61"/><area shape="rect" id="node5" href="class_f_i_f_e_1_1_pool.html#a3407a81bc1f5497cde2f75db5d911f8c" title="FIFE::Pool::addResourceFromLocation" alt="" coords="597,5,845,35"/><area shape="rect" id="node11" href="class_f_i_f_e_1_1_resource_class.html#a843ee8fb4bc3af4c4a645dbc59289818" title="FIFE::ResourceClass::setResourceLocation" alt="" coords="581,59,861,88"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_pool.html#a31b406b9de7aa7949e9d4c1f64ee2ac0" title="FIFE::Pool::addResourceFromFile" alt="" coords="909,5,1131,35"/><area shape="rect" id="node9" href="class_f_i_f_e_1_1_sub_image_font.html#aad27038d9560c70eec3fd638e06b5168" title="FIFE::SubImageFont::SubImageFont" alt="" coords="1179,5,1416,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a54ac721a48a942b1f2259217a27442b3"></a><!-- doxytag: member="FIFE::ResourceLocation::~ResourceLocation" ref="a54ac721a48a942b1f2259217a27442b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FIFE::ResourceLocation::~ResourceLocation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00061">61</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aafa82d59b6bea0414cab7d7bac531d86"></a><!-- doxytag: member="FIFE::ResourceLocation::clone" ref="aafa82d59b6bea0414cab7d7bac531d86" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a>* FIFE::ResourceLocation::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates copy of this location All derived classes must implement this and return their corresponding instance </p>
<p>Reimplemented in <a class="el" href="class_f_i_f_e_1_1_image_location.html#a5c403fd834610848b42af1cad7d06db7">FIFE::ImageLocation</a>.</p>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00098">98</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
<p>References <a class="el" href="resource__location_8h_source.html#l00057">ResourceLocation()</a>.</p>
<p>Referenced by <a class="el" href="pool_8cpp_source.html#l00095">FIFE::Pool::addResourceFromLocation()</a>, and <a class="el" href="resourceclass_8cpp_source.html#l00057">FIFE::ResourceClass::setResourceLocation()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_resource_location_aafa82d59b6bea0414cab7d7bac531d86_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_resource_location_aafa82d59b6bea0414cab7d7bac531d86_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_resource_location_aafa82d59b6bea0414cab7d7bac531d86_icgraph" id="class_f_i_f_e_1_1_resource_location_aafa82d59b6bea0414cab7d7bac531d86_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_pool.html#a3407a81bc1f5497cde2f75db5d911f8c" title="FIFE::Pool::addResourceFromLocation" alt="" coords="272,5,520,35"/><area shape="rect" id="node9" href="class_f_i_f_e_1_1_resource_class.html#a843ee8fb4bc3af4c4a645dbc59289818" title="FIFE::ResourceClass::setResourceLocation" alt="" coords="256,59,536,88"/><area shape="rect" id="node5" href="class_f_i_f_e_1_1_pool.html#a31b406b9de7aa7949e9d4c1f64ee2ac0" title="FIFE::Pool::addResourceFromFile" alt="" coords="584,5,805,35"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_sub_image_font.html#aad27038d9560c70eec3fd638e06b5168" title="FIFE::SubImageFont::SubImageFont" alt="" coords="853,5,1091,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a6fc2be7dde119dc1c482ce3b58fe20e5"></a><!-- doxytag: member="FIFE::ResourceLocation::getFilename" ref="a6fc2be7dde119dc1c482ce3b58fe20e5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& FIFE::ResourceLocation::getFilename </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the filename. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The filename. </dd></dl>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00066">66</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
<p>Referenced by <a class="el" href="image__location_8cpp_source.html#l00112">FIFE::ImageLocation::clone()</a>, <a class="el" href="image__location_8cpp_source.html#l00072">FIFE::ImageLocation::operator<()</a>, and <a class="el" href="image__location_8cpp_source.html#l00043">FIFE::ImageLocation::operator==()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_resource_location_a6fc2be7dde119dc1c482ce3b58fe20e5_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_resource_location_a6fc2be7dde119dc1c482ce3b58fe20e5_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_resource_location_a6fc2be7dde119dc1c482ce3b58fe20e5_icgraph" id="class_f_i_f_e_1_1_resource_location_a6fc2be7dde119dc1c482ce3b58fe20e5_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_image_location.html#a5c403fd834610848b42af1cad7d06db7" title="FIFE::ImageLocation::clone" alt="" coords="313,5,495,35"/><area shape="rect" id="node5" href="class_f_i_f_e_1_1_image_location.html#ab08ae8a7b8219f773e4476536286d752" title="FIFE::ImageLocation::operator\<" alt="" coords="301,59,507,88"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_image_location.html#a1ed5ad55a11756df75d0b12211534e8b" title="FIFE::ImageLocation::operator==" alt="" coords="297,112,511,141"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ad318a950a95f92b475e11dff4fefa9c4"></a><!-- doxytag: member="FIFE::ResourceLocation::operator<" ref="ad318a950a95f92b475e11dff4fefa9c4" args="(const ResourceLocation &loc) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FIFE::ResourceLocation::operator< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a> & </td>
<td class="paramname"><em>loc</em></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares two ResourceLocations This is needed as the locations should be stored in a <code>std::map</code> </p>
<p>Reimplemented in <a class="el" href="class_f_i_f_e_1_1_image_location.html#ab08ae8a7b8219f773e4476536286d752">FIFE::ImageLocation</a>.</p>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00087">87</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6631cea99008d9296d2505d0b2dd8522"></a><!-- doxytag: member="FIFE::ResourceLocation::operator==" ref="a6631cea99008d9296d2505d0b2dd8522" args="(const ResourceLocation &loc) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FIFE::ResourceLocation::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a> & </td>
<td class="paramname"><em>loc</em></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares two ResourceLocations for equality. </p>
<p>Reimplemented in <a class="el" href="class_f_i_f_e_1_1_image_location.html#a1ed5ad55a11756df75d0b12211534e8b">FIFE::ImageLocation</a>.</p>
<p>Definition at line <a class="el" href="resource__location_8h_source.html#l00070">70</a> of file <a class="el" href="resource__location_8h_source.html">resource_location.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>engine/core/util/resource/<a class="el" href="resource__location_8h_source.html">resource_location.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a> </li>
<li class="navelem"><a class="el" href="class_f_i_f_e_1_1_resource_location.html">ResourceLocation</a> </li>
<li class="footer">Generated on Sun Jul 10 2011 for FIFE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- 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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</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>
</body>
</html>
