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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::Resource class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::Resource Class Reference</h1>Abstract class reprensenting a loadable resource (e.g. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::Resource:
16<p><center><img src="classOgre_1_1Resource.png" usemap="#Ogre::Resource_map" border="0" alt=""></center>
17<map name="Ogre::Resource_map">
18<area href="classOgre_1_1StringInterface.html" alt="Ogre::StringInterface" shape="rect" coords="555,0,730,24">
19<area href="classOgre_1_1BspLevel.html" alt="Ogre::BspLevel" shape="rect" coords="0,112,175,136">
20<area href="classOgre_1_1Font.html" alt="Ogre::Font" shape="rect" coords="185,112,360,136">
21<area href="classOgre_1_1GpuProgram.html" alt="Ogre::GpuProgram" shape="rect" coords="370,112,545,136">
22<area href="classOgre_1_1Material.html" alt="Ogre::Material" shape="rect" coords="555,112,730,136">
23<area href="classOgre_1_1Mesh.html" alt="Ogre::Mesh" shape="rect" coords="740,112,915,136">
24<area href="classOgre_1_1Skeleton.html" alt="Ogre::Skeleton" shape="rect" coords="925,112,1100,136">
25<area href="classOgre_1_1Texture.html" alt="Ogre::Texture" shape="rect" coords="1110,112,1285,136">
26<area href="classOgre_1_1D3D7GpuProgram.html" alt="Ogre::D3D7GpuProgram" shape="rect" coords="555,168,730,192">
27<area href="classOgre_1_1D3D9GpuProgram.html" alt="Ogre::D3D9GpuProgram" shape="rect" coords="555,224,730,248">
28<area href="classOgre_1_1GLGpuProgram.html" alt="Ogre::GLGpuProgram" shape="rect" coords="555,280,730,304">
29<area href="classOgre_1_1HighLevelGpuProgram.html" alt="Ogre::HighLevelGpuProgram" shape="rect" coords="555,336,730,360">
30<area href="classOgre_1_1PatchMesh.html" alt="Ogre::PatchMesh" shape="rect" coords="740,168,915,192">
31<area href="classOgre_1_1SkeletonInstance.html" alt="Ogre::SkeletonInstance" shape="rect" coords="925,168,1100,192">
32<area href="classOgre_1_1D3D9Texture.html" alt="Ogre::D3D9Texture" shape="rect" coords="1295,168,1470,192">
33<area href="classOgre_1_1D3DTexture.html" alt="Ogre::D3DTexture" shape="rect" coords="1295,224,1470,248">
34<area href="classOgre_1_1GLTexture.html" alt="Ogre::GLTexture" shape="rect" coords="1295,280,1470,304">
35<area href="classOgre_1_1RenderTargetTexture.html" alt="Ogre::RenderTargetTexture" shape="rect" coords="1295,336,1470,360">
36</map>
37<a href="classOgre_1_1Resource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
38<tr><td></td></tr>
39<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Resourcea0">Resource</a> (<a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> *creator, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, <a class="el" href="namespaceOgre.html#a485">ResourceHandle</a> handle, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;group, bool isManual=false, <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> *loader=0)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard constructor.  <a href="#Ogre_1_1Resourcea0"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Resourcea1">~Resource</a> ()</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor.  <a href="#Ogre_1_1Resourcea1"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea30">load</a> (void)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads the resource, if it is not already.  <a href="#Ogre_1_1Texturea30"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea31">reload</a> (void)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reloads the resource, if it is already loaded.  <a href="#Ogre_1_1Texturea31"></a><br><br></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea32">isReloadable</a> (void) const </td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the <a class="el" href="classOgre_1_1Resource.html">Resource</a> is reloadable, false otherwise.  <a href="#Ogre_1_1Texturea32"></a><br><br></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea33">isManuallyLoaded</a> (void) const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this resource manually loaded?  <a href="#Ogre_1_1Texturea33"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea34">unload</a> (void)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unloads the resource; this is not permanent, the resource can be reloaded later if required.  <a href="#Ogre_1_1Texturea34"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea35">getSize</a> (void) const </td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves info about the size of the resource.  <a href="#Ogre_1_1Texturea35"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea36">touch</a> (void)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">'Touches' the resource to indicate it has been used.  <a href="#Ogre_1_1Texturea36"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea37">getName</a> (void) const </td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets resource name.  <a href="#Ogre_1_1Texturea37"></a><br><br></td></tr>
70<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a485">ResourceHandle</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea38">getHandle</a> (void) const </td></tr>
71
72<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea39">isLoaded</a> (void) const </td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the <a class="el" href="classOgre_1_1Resource.html">Resource</a> has been loaded, false otherwise.  <a href="#Ogre_1_1Texturea39"></a><br><br></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea40">getGroup</a> (void)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the group which this resource is a member of.  <a href="#Ogre_1_1Texturea40"></a><br><br></td></tr>
78<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea41">getCreator</a> (void)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the manager which created this resource.  <a href="#Ogre_1_1Texturea41"></a><br><br></td></tr>
81<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea42">getOrigin</a> (void) const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the origin of this resource, e.g.  <a href="#Ogre_1_1Texturea42"></a><br><br></td></tr>
84<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea43">_notifyOrigin</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;origin)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Notify this resource of it's origin.  <a href="#Ogre_1_1Texturea43"></a><br><br></td></tr>
87<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea44">getParamDictionary</a> (void)</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea44"></a><br><br></td></tr>
90<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea45">getParamDictionary</a> (void) const </td></tr>
91
92<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a518">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">getParameters</a> (void) const </td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea46"></a><br><br></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">setParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;value)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
98<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;paramList)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea48"></a><br><br></td></tr>
101<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea49">getParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name) const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
104<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea50"></a><br><br></td></tr>
107<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
108<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturee0">cleanupDictionary</a> ()</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.  <a href="#Ogre_1_1Texturee0"></a><br><br></td></tr>
111<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
112<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Resourceb0">Resource</a> ()</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected unnamed constructor to prevent default construction.  <a href="#Ogre_1_1Resourceb0"></a><br><br></td></tr>
115<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Textureb5">loadImpl</a> (void)=0</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal implementation of the 'load' action, only called if this resource is not being loaded from a <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>.  <a href="#Ogre_1_1Textureb5"></a><br><br></td></tr>
118<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Resourceb2">unloadImpl</a> (void)=0</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>.  <a href="#Ogre_1_1Resourceb2"></a><br><br></td></tr>
121<tr><td class="memItemLeft" nowrap align=right valign=top>virtual size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Resourceb3">calculateSize</a> (void) const=0</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the size of a resource; this will only be called after 'load'.  <a href="#Ogre_1_1Resourceb3"></a><br><br></td></tr>
124<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Textureb6">createParamDictionary</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;className)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for creating a parameter dictionary for the class, if it does not already exist.  <a href="#Ogre_1_1Textureb6"></a><br><br></td></tr>
127<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
128<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep17">mCreator</a></td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creator.  <a href="#Ogre_1_1Texturep17"></a><br><br></td></tr>
131<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep18">mName</a></td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unique name of the resource.  <a href="#Ogre_1_1Texturep18"></a><br><br></td></tr>
134<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep19">mGroup</a></td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the resource group.  <a href="#Ogre_1_1Texturep19"></a><br><br></td></tr>
137<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a485">ResourceHandle</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep20">mHandle</a></td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Numeric handle for more efficient look up than name.  <a href="#Ogre_1_1Texturep20"></a><br><br></td></tr>
140<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep21">mIsLoaded</a></td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the resource currently loaded?  <a href="#Ogre_1_1Texturep21"></a><br><br></td></tr>
143<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep22">mSize</a></td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The size of the resource in bytes.  <a href="#Ogre_1_1Texturep22"></a><br><br></td></tr>
146<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep23">mIsManual</a></td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this file manually loaded?  <a href="#Ogre_1_1Texturep23"></a><br><br></td></tr>
149<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep24">mOrigin</a></td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Origin of this resource (e.g. script name) - optional.  <a href="#Ogre_1_1Texturep24"></a><br><br></td></tr>
152<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep25">mLoader</a></td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Optional manual loader; if provided, data is loaded from here instead of a file.  <a href="#Ogre_1_1Texturep25"></a><br><br></td></tr>
155<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class name for this instance to be used as a lookup (must be initialised by subclasses).  <a href="#Ogre_1_1Texturep26"></a><br><br></td></tr>
158<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
159<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
160
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
162</table>
163<hr><a name="_details"></a><h2>Detailed Description</h2>
164Abstract class reprensenting a loadable resource (e.g.
165<p>
166textures, sounds etc) <dl compact><dt><b>Remarks:</b></dt><dd>Resources are data objects that must be loaded and managed throughout an application. A resource might be a mesh, a texture, or any other piece of data - the key thing is that they must be identified by a name which is unique, must be loaded only once, must be managed efficiently in terms of retrieval, and they may also be unloadable to free memory up when they have not been used for a while and the memory budget is under stress. </dd></dl>
167<dl compact><dt><b></b></dt><dd>All <a class="el" href="classOgre_1_1Resource.html">Resource</a> instances must be a member of a resource group; see <a class="el" href="classOgre_1_1ResourceGroupManager.html">ResourceGroupManager</a> for full details. </dd></dl>
168<dl compact><dt><b></b></dt><dd>Subclasses must implement: <ol>
169<li>
170A constructor, overriding the same parameters as the constructor defined by this class. Subclasses are not allowed to define constructors with other parameters; other settings must be settable through accessor methods before loading. </li>
171<li>
172The <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Textureb5">loadImpl()</a> and <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Resourceb2">unloadImpl()</a> methods - mSize must be set after <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Textureb5">loadImpl()</a> </li>
173<li>
174<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> and <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> setups in order to allow setting of core parameters (prior to load) through a generic interface. </li>
175</ol>
176</dd></dl>
177
178<p>
179
180<p>
181Definition at line <a class="el" href="OgreResource_8h-source.html#l00067">67</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
182<a class="anchor" name="Ogre_1_1Resourceb0" doxytag="Ogre::Resource::Resource" ></a><p>
183<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
184  <tr>
185    <td class="mdRow">
186      <table cellpadding="0" cellspacing="0" border="0">
187        <tr>
188          <td class="md" nowrap valign="top"> Ogre::Resource::Resource </td>
189          <td class="md" valign="top">(&nbsp;</td>
190          <td class="mdname1" valign="top" nowrap>          </td>
191          <td class="md" valign="top">&nbsp;)&nbsp;</td>
192          <td class="md" nowrap><code> [protected]</code></td>
193        </tr>
194
195      </table>
196    </td>
197  </tr>
198</table>
199<table cellspacing=5 cellpadding=0 border=0>
200  <tr>
201    <td>
202      &nbsp;
203    </td>
204    <td>
205
206<p>
207Protected unnamed constructor to prevent default construction.
208<p>
209
210<p>
211Definition at line <a class="el" href="OgreResource_8h-source.html#l00093">93</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
212  </tr>
213</table>
214<a class="anchor" name="Ogre_1_1Resourcea0" doxytag="Ogre::Resource::Resource" ></a><p>
215<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
216  <tr>
217    <td class="mdRow">
218      <table cellpadding="0" cellspacing="0" border="0">
219        <tr>
220          <td class="md" nowrap valign="top"> Ogre::Resource::Resource </td>
221          <td class="md" valign="top">(&nbsp;</td>
222          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> *&nbsp;</td>
223          <td class="mdname" nowrap> <em>creator</em>, </td>
224        </tr>
225        <tr>
226          <td class="md" nowrap align="right"></td>
227          <td></td>
228          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
229          <td class="mdname" nowrap> <em>name</em>, </td>
230        </tr>
231        <tr>
232          <td class="md" nowrap align="right"></td>
233          <td></td>
234          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a485">ResourceHandle</a>&nbsp;</td>
235          <td class="mdname" nowrap> <em>handle</em>, </td>
236        </tr>
237        <tr>
238          <td class="md" nowrap align="right"></td>
239          <td></td>
240          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
241          <td class="mdname" nowrap> <em>group</em>, </td>
242        </tr>
243        <tr>
244          <td class="md" nowrap align="right"></td>
245          <td></td>
246          <td class="md" nowrap>bool&nbsp;</td>
247          <td class="mdname" nowrap> <em>isManual</em> = false, </td>
248        </tr>
249        <tr>
250          <td class="md" nowrap align="right"></td>
251          <td></td>
252          <td class="md" nowrap><a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> *&nbsp;</td>
253          <td class="mdname" nowrap> <em>loader</em> = 0</td>
254        </tr>
255        <tr>
256          <td></td>
257          <td class="md">)&nbsp;</td>
258          <td class="md" colspan="2"></td>
259        </tr>
260
261      </table>
262    </td>
263  </tr>
264</table>
265<table cellspacing=5 cellpadding=0 border=0>
266  <tr>
267    <td>
268      &nbsp;
269    </td>
270    <td>
271
272<p>
273Standard constructor.
274<p>
275<dl compact><dt><b>Parameters:</b></dt><dd>
276  <table border="0" cellspacing="2" cellpadding="0">
277    <tr><td valign=top><em>creator</em>&nbsp;</td><td>Pointer to the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> that is creating this resource </td></tr>
278    <tr><td valign=top><em>name</em>&nbsp;</td><td>The unique name of the resource </td></tr>
279    <tr><td valign=top><em>group</em>&nbsp;</td><td>The name of the resource group to which this resource belongs </td></tr>
280    <tr><td valign=top><em>isManual</em>&nbsp;</td><td>Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required. </td></tr>
281    <tr><td valign=top><em>loader</em>&nbsp;</td><td>Pointer to a <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> implementation which will be called when the <a class="el" href="classOgre_1_1Resource.html">Resource</a> wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the <a class="el" href="classOgre_1_1Resource.html">Resource</a> will never be able to reload if anything ever causes it to unload. Therefore provision of a proper <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> instance is strongly recommended.</td></tr>
282  </table>
283</dl>
284    </td>
285  </tr>
286</table>
287<a class="anchor" name="Ogre_1_1Resourcea1" doxytag="Ogre::Resource::~Resource" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top"> virtual Ogre::Resource::~<a class="el" href="classOgre_1_1Resource.html">Resource</a> </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="mdname1" valign="top" nowrap>          </td>
296          <td class="md" valign="top">&nbsp;)&nbsp;</td>
297          <td class="md" nowrap><code> [virtual]</code></td>
298        </tr>
299
300      </table>
301    </td>
302  </tr>
303</table>
304<table cellspacing=5 cellpadding=0 border=0>
305  <tr>
306    <td>
307      &nbsp;
308    </td>
309    <td>
310
311<p>
312Virtual destructor.
313<p>
314Shouldn't need to be overloaded, as the resource deallocation code should reside in <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea34">unload()</a> <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea34">Resource::unload()</a> </dd></dl>
315    </td>
316  </tr>
317</table>
318<hr><h2>Member Function Documentation</h2>
319<a class="anchor" name="Ogre_1_1Texturea43" doxytag="Ogre::Resource::_notifyOrigin" ></a><p>
320<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
321  <tr>
322    <td class="mdRow">
323      <table cellpadding="0" cellspacing="0" border="0">
324        <tr>
325          <td class="md" nowrap valign="top"> void Ogre::Resource::_notifyOrigin </td>
326          <td class="md" valign="top">(&nbsp;</td>
327          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
328          <td class="mdname1" valign="top" nowrap> <em>origin</em>          </td>
329          <td class="md" valign="top">&nbsp;)&nbsp;</td>
330          <td class="md" nowrap></td>
331        </tr>
332
333      </table>
334    </td>
335  </tr>
336</table>
337<table cellspacing=5 cellpadding=0 border=0>
338  <tr>
339    <td>
340      &nbsp;
341    </td>
342    <td>
343
344<p>
345Notify this resource of it's origin.
346<p>
347
348<p>
349Definition at line <a class="el" href="OgreResource_8h-source.html#l00214">214</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
350<p>
351References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
352  </tr>
353</table>
354<a class="anchor" name="Ogre_1_1Resourceb3" doxytag="Ogre::Resource::calculateSize" ></a><p>
355<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
356  <tr>
357    <td class="mdRow">
358      <table cellpadding="0" cellspacing="0" border="0">
359        <tr>
360          <td class="md" nowrap valign="top"> virtual size_t Ogre::Resource::calculateSize </td>
361          <td class="md" valign="top">(&nbsp;</td>
362          <td class="md" nowrap valign="top">void&nbsp;</td>
363          <td class="mdname1" valign="top" nowrap>          </td>
364          <td class="md" valign="top">&nbsp;)&nbsp;</td>
365          <td class="md" nowrap> const<code> [protected, pure 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      &nbsp;
376    </td>
377    <td>
378
379<p>
380Calculate the size of a resource; this will only be called after 'load'.
381<p>
382
383<p>
384Implemented in <a class="el" href="classOgre_1_1Font.html#Ogre_1_1Fontb3">Ogre::Font</a>, <a class="el" href="classOgre_1_1GpuProgram.html#Ogre_1_1HighLevelGpuProgramb9">Ogre::GpuProgram</a>, <a class="el" href="classOgre_1_1Material.html#Ogre_1_1Materialb4">Ogre::Material</a>, <a class="el" href="classOgre_1_1Mesh.html#Ogre_1_1PatchMeshb5">Ogre::Mesh</a>, <a class="el" href="classOgre_1_1Skeleton.html#Ogre_1_1SkeletonInstanceb5">Ogre::Skeleton</a>, <a class="el" href="classOgre_1_1Texture.html#Ogre_1_1Textureb0">Ogre::Texture</a>, and <a class="el" href="classOgre_1_1BspLevel.html#Ogre_1_1BspLevelb2">Ogre::BspLevel</a>.    </td>
385  </tr>
386</table>
387<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::Resource::cleanupDictionary" ></a><p>
388<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
389  <tr>
390    <td class="mdRow">
391      <table cellpadding="0" cellspacing="0" border="0">
392        <tr>
393          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
394          <td class="md" valign="top">(&nbsp;</td>
395          <td class="mdname1" valign="top" nowrap>          </td>
396          <td class="md" valign="top">&nbsp;)&nbsp;</td>
397          <td class="md" nowrap><code> [static, inherited]</code></td>
398        </tr>
399
400      </table>
401    </td>
402  </tr>
403</table>
404<table cellspacing=5 cellpadding=0 border=0>
405  <tr>
406    <td>
407      &nbsp;
408    </td>
409    <td>
410
411<p>
412Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.
413<p>
414<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
415  </tr>
416</table>
417<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::Resource::copyParametersTo" ></a><p>
418<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
419  <tr>
420    <td class="mdRow">
421      <table cellpadding="0" cellspacing="0" border="0">
422        <tr>
423          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
424          <td class="md" valign="top">(&nbsp;</td>
425          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
426          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
427          <td class="md" valign="top">&nbsp;)&nbsp;</td>
428          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
429        </tr>
430
431      </table>
432    </td>
433  </tr>
434</table>
435<table cellspacing=5 cellpadding=0 border=0>
436  <tr>
437    <td>
438      &nbsp;
439    </td>
440    <td>
441
442<p>
443Method for copying this object's parameters to another object.
444<p>
445<dl compact><dt><b>Remarks:</b></dt><dd>This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. </dd></dl>
446<dl compact><dt><b></b></dt><dd>Any unrecognised parameters will be ignored as with setParameter method. </dd></dl>
447<dl compact><dt><b>Parameters:</b></dt><dd>
448  <table border="0" cellspacing="2" cellpadding="0">
449    <tr><td valign=top><em>dest</em>&nbsp;</td><td>Pointer to object to have it's parameters set the same as this object. </td></tr>
450  </table>
451</dl>
452
453<p>
454Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00296">296</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
455<p>
456References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">Ogre::StringInterface::setParameter()</a>.    </td>
457  </tr>
458</table>
459<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::Resource::createParamDictionary" ></a><p>
460<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
461  <tr>
462    <td class="mdRow">
463      <table cellpadding="0" cellspacing="0" border="0">
464        <tr>
465          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
466          <td class="md" valign="top">(&nbsp;</td>
467          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
468          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
469          <td class="md" valign="top">&nbsp;)&nbsp;</td>
470          <td class="md" nowrap><code> [protected, inherited]</code></td>
471        </tr>
472
473      </table>
474    </td>
475  </tr>
476</table>
477<table cellspacing=5 cellpadding=0 border=0>
478  <tr>
479    <td>
480      &nbsp;
481    </td>
482    <td>
483
484<p>
485Internal method for creating a parameter dictionary for the class, if it does not already exist.
486<p>
487<dl compact><dt><b>Remarks:</b></dt><dd>This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance). </dd></dl>
488<dl compact><dt><b>Parameters:</b></dt><dd>
489  <table border="0" cellspacing="2" cellpadding="0">
490    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
491  </table>
492</dl>
493<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
494
495<p>
496Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00172">172</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
497<p>
498References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
499  </tr>
500</table>
501<a class="anchor" name="Ogre_1_1Texturea41" doxytag="Ogre::Resource::getCreator" ></a><p>
502<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
503  <tr>
504    <td class="mdRow">
505      <table cellpadding="0" cellspacing="0" border="0">
506        <tr>
507          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a>* Ogre::Resource::getCreator </td>
508          <td class="md" valign="top">(&nbsp;</td>
509          <td class="md" nowrap valign="top">void&nbsp;</td>
510          <td class="mdname1" valign="top" nowrap>          </td>
511          <td class="md" valign="top">&nbsp;)&nbsp;</td>
512          <td class="md" nowrap></td>
513        </tr>
514
515      </table>
516    </td>
517  </tr>
518</table>
519<table cellspacing=5 cellpadding=0 border=0>
520  <tr>
521    <td>
522      &nbsp;
523    </td>
524    <td>
525
526<p>
527Gets the manager which created this resource.
528<p>
529
530<p>
531Definition at line <a class="el" href="OgreResource_8h-source.html#l00205">205</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
532  </tr>
533</table>
534<a class="anchor" name="Ogre_1_1Texturea40" doxytag="Ogre::Resource::getGroup" ></a><p>
535<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
536  <tr>
537    <td class="mdRow">
538      <table cellpadding="0" cellspacing="0" border="0">
539        <tr>
540          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Resource::getGroup </td>
541          <td class="md" valign="top">(&nbsp;</td>
542          <td class="md" nowrap valign="top">void&nbsp;</td>
543          <td class="mdname1" valign="top" nowrap>          </td>
544          <td class="md" valign="top">&nbsp;)&nbsp;</td>
545          <td class="md" nowrap></td>
546        </tr>
547
548      </table>
549    </td>
550  </tr>
551</table>
552<table cellspacing=5 cellpadding=0 border=0>
553  <tr>
554    <td>
555      &nbsp;
556    </td>
557    <td>
558
559<p>
560Gets the group which this resource is a member of.
561<p>
562
563<p>
564Definition at line <a class="el" href="OgreResource_8h-source.html#l00202">202</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
565<p>
566References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
567  </tr>
568</table>
569<a class="anchor" name="Ogre_1_1Texturea38" doxytag="Ogre::Resource::getHandle" ></a><p>
570<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
571  <tr>
572    <td class="mdRow">
573      <table cellpadding="0" cellspacing="0" border="0">
574        <tr>
575          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a485">ResourceHandle</a> Ogre::Resource::getHandle </td>
576          <td class="md" valign="top">(&nbsp;</td>
577          <td class="md" nowrap valign="top">void&nbsp;</td>
578          <td class="mdname1" valign="top" nowrap>          </td>
579          <td class="md" valign="top">&nbsp;)&nbsp;</td>
580          <td class="md" nowrap> const</td>
581        </tr>
582
583      </table>
584    </td>
585  </tr>
586</table>
587<table cellspacing=5 cellpadding=0 border=0>
588  <tr>
589    <td>
590      &nbsp;
591    </td>
592    <td>
593
594<p>
595
596<p>
597Definition at line <a class="el" href="OgreResource_8h-source.html#l00188">188</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
598<p>
599References <a class="el" href="OgreResource_8h-source.html#l00035">Ogre::ResourceHandle</a>.    </td>
600  </tr>
601</table>
602<a class="anchor" name="Ogre_1_1Texturea37" doxytag="Ogre::Resource::getName" ></a><p>
603<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
604  <tr>
605    <td class="mdRow">
606      <table cellpadding="0" cellspacing="0" border="0">
607        <tr>
608          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Resource::getName </td>
609          <td class="md" valign="top">(&nbsp;</td>
610          <td class="md" nowrap valign="top">void&nbsp;</td>
611          <td class="mdname1" valign="top" nowrap>          </td>
612          <td class="md" valign="top">&nbsp;)&nbsp;</td>
613          <td class="md" nowrap> const</td>
614        </tr>
615
616      </table>
617    </td>
618  </tr>
619</table>
620<table cellspacing=5 cellpadding=0 border=0>
621  <tr>
622    <td>
623      &nbsp;
624    </td>
625    <td>
626
627<p>
628Gets resource name.
629<p>
630
631<p>
632Definition at line <a class="el" href="OgreResource_8h-source.html#l00183">183</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
633<p>
634References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
635  </tr>
636</table>
637<a class="anchor" name="Ogre_1_1Texturea42" doxytag="Ogre::Resource::getOrigin" ></a><p>
638<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
639  <tr>
640    <td class="mdRow">
641      <table cellpadding="0" cellspacing="0" border="0">
642        <tr>
643          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Resource::getOrigin </td>
644          <td class="md" valign="top">(&nbsp;</td>
645          <td class="md" nowrap valign="top">void&nbsp;</td>
646          <td class="mdname1" valign="top" nowrap>          </td>
647          <td class="md" valign="top">&nbsp;)&nbsp;</td>
648          <td class="md" nowrap> const</td>
649        </tr>
650
651      </table>
652    </td>
653  </tr>
654</table>
655<table cellspacing=5 cellpadding=0 border=0>
656  <tr>
657    <td>
658      &nbsp;
659    </td>
660    <td>
661
662<p>
663Get the origin of this resource, e.g.
664<p>
665a script file name. <dl compact><dt><b>Remarks:</b></dt><dd>This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.</dd></dl>
666
667<p>
668Definition at line <a class="el" href="OgreResource_8h-source.html#l00212">212</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
669<p>
670References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
671  </tr>
672</table>
673<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::Resource::getParamDictionary" ></a><p>
674<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
675  <tr>
676    <td class="mdRow">
677      <table cellpadding="0" cellspacing="0" border="0">
678        <tr>
679          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
680          <td class="md" valign="top">(&nbsp;</td>
681          <td class="md" nowrap valign="top">void&nbsp;</td>
682          <td class="mdname1" valign="top" nowrap>          </td>
683          <td class="md" valign="top">&nbsp;)&nbsp;</td>
684          <td class="md" nowrap> const<code> [inherited]</code></td>
685        </tr>
686
687      </table>
688    </td>
689  </tr>
690</table>
691<table cellspacing=5 cellpadding=0 border=0>
692  <tr>
693    <td>
694      &nbsp;
695    </td>
696    <td>
697
698<p>
699
700<p>
701Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00209">209</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
702  </tr>
703</table>
704<a class="anchor" name="Ogre_1_1Texturea44" doxytag="Ogre::Resource::getParamDictionary" ></a><p>
705<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
706  <tr>
707    <td class="mdRow">
708      <table cellpadding="0" cellspacing="0" border="0">
709        <tr>
710          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
711          <td class="md" valign="top">(&nbsp;</td>
712          <td class="md" nowrap valign="top">void&nbsp;</td>
713          <td class="mdname1" valign="top" nowrap>          </td>
714          <td class="md" valign="top">&nbsp;)&nbsp;</td>
715          <td class="md" nowrap><code> [inherited]</code></td>
716        </tr>
717
718      </table>
719    </td>
720  </tr>
721</table>
722<table cellspacing=5 cellpadding=0 border=0>
723  <tr>
724    <td>
725      &nbsp;
726    </td>
727    <td>
728
729<p>
730Retrieves the parameter dictionary for this class.
731<p>
732<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
733<dl compact><dt><b>Returns:</b></dt><dd>Pointer to <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> shared by all instances of this class which you can add parameters to, retrieve parameters etc. </dd></dl>
734
735<p>
736Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00196">196</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
737  </tr>
738</table>
739<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::Resource::getParameter" ></a><p>
740<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
741  <tr>
742    <td class="mdRow">
743      <table cellpadding="0" cellspacing="0" border="0">
744        <tr>
745          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::StringInterface::getParameter </td>
746          <td class="md" valign="top">(&nbsp;</td>
747          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
748          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
749          <td class="md" valign="top">&nbsp;)&nbsp;</td>
750          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
751        </tr>
752
753      </table>
754    </td>
755  </tr>
756</table>
757<table cellspacing=5 cellpadding=0 border=0>
758  <tr>
759    <td>
760      &nbsp;
761    </td>
762    <td>
763
764<p>
765Generic parameter retrieval method.
766<p>
767<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> to convert this string back into a native type. </dd></dl>
768<dl compact><dt><b>Parameters:</b></dt><dd>
769  <table border="0" cellspacing="2" cellpadding="0">
770    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
771  </table>
772</dl>
773<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
774
775<p>
776Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00265">265</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
777<p>
778References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda0">Ogre::ParamCommand::doGet()</a>, <a class="el" href="OgreStringInterface_8h-source.html#l00090">Ogre::ParamDictionary::getParamCommand()</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
779  </tr>
780</table>
781<a class="anchor" name="Ogre_1_1Texturea46" doxytag="Ogre::Resource::getParameters" ></a><p>
782<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
783  <tr>
784    <td class="mdRow">
785      <table cellpadding="0" cellspacing="0" border="0">
786        <tr>
787          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a518">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
788          <td class="md" valign="top">(&nbsp;</td>
789          <td class="md" nowrap valign="top">void&nbsp;</td>
790          <td class="mdname1" valign="top" nowrap>          </td>
791          <td class="md" valign="top">&nbsp;)&nbsp;</td>
792          <td class="md" nowrap> const<code> [inherited]</code></td>
793        </tr>
794
795      </table>
796    </td>
797  </tr>
798</table>
799<table cellspacing=5 cellpadding=0 border=0>
800  <tr>
801    <td>
802      &nbsp;
803    </td>
804    <td>
805
806<p>
807Retrieves a list of parameters valid for this object.
808<p>
809<dl compact><dt><b>Returns:</b></dt><dd>A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dd></dl>
810    </td>
811  </tr>
812</table>
813<a class="anchor" name="Ogre_1_1Texturea35" doxytag="Ogre::Resource::getSize" ></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"> size_t Ogre::Resource::getSize </td>
820          <td class="md" valign="top">(&nbsp;</td>
821          <td class="md" nowrap valign="top">void&nbsp;</td>
822          <td class="mdname1" valign="top" nowrap>          </td>
823          <td class="md" valign="top">&nbsp;)&nbsp;</td>
824          <td class="md" nowrap> const</td>
825        </tr>
826
827      </table>
828    </td>
829  </tr>
830</table>
831<table cellspacing=5 cellpadding=0 border=0>
832  <tr>
833    <td>
834      &nbsp;
835    </td>
836    <td>
837
838<p>
839Retrieves info about the size of the resource.
840<p>
841
842<p>
843Definition at line <a class="el" href="OgreResource_8h-source.html#l00172">172</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
844  </tr>
845</table>
846<a class="anchor" name="Ogre_1_1Texturea39" doxytag="Ogre::Resource::isLoaded" ></a><p>
847<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
848  <tr>
849    <td class="mdRow">
850      <table cellpadding="0" cellspacing="0" border="0">
851        <tr>
852          <td class="md" nowrap valign="top"> bool Ogre::Resource::isLoaded </td>
853          <td class="md" valign="top">(&nbsp;</td>
854          <td class="md" nowrap valign="top">void&nbsp;</td>
855          <td class="mdname1" valign="top" nowrap>          </td>
856          <td class="md" valign="top">&nbsp;)&nbsp;</td>
857          <td class="md" nowrap> const</td>
858        </tr>
859
860      </table>
861    </td>
862  </tr>
863</table>
864<table cellspacing=5 cellpadding=0 border=0>
865  <tr>
866    <td>
867      &nbsp;
868    </td>
869    <td>
870
871<p>
872Returns true if the <a class="el" href="classOgre_1_1Resource.html">Resource</a> has been loaded, false otherwise.
873<p>
874
875<p>
876Definition at line <a class="el" href="OgreResource_8h-source.html#l00195">195</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
877<p>
878References <a class="el" href="OgrePrerequisites_8h-source.html#l00171">OGRE_LOCK_AUTO_MUTEX</a>.    </td>
879  </tr>
880</table>
881<a class="anchor" name="Ogre_1_1Texturea33" doxytag="Ogre::Resource::isManuallyLoaded" ></a><p>
882<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
883  <tr>
884    <td class="mdRow">
885      <table cellpadding="0" cellspacing="0" border="0">
886        <tr>
887          <td class="md" nowrap valign="top"> bool Ogre::Resource::isManuallyLoaded </td>
888          <td class="md" valign="top">(&nbsp;</td>
889          <td class="md" nowrap valign="top">void&nbsp;</td>
890          <td class="mdname1" valign="top" nowrap>          </td>
891          <td class="md" valign="top">&nbsp;)&nbsp;</td>
892          <td class="md" nowrap> const</td>
893        </tr>
894
895      </table>
896    </td>
897  </tr>
898</table>
899<table cellspacing=5 cellpadding=0 border=0>
900  <tr>
901    <td>
902      &nbsp;
903    </td>
904    <td>
905
906<p>
907Is this resource manually loaded?
908<p>
909
910<p>
911Definition at line <a class="el" href="OgreResource_8h-source.html#l00160">160</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
912  </tr>
913</table>
914<a class="anchor" name="Ogre_1_1Texturea32" doxytag="Ogre::Resource::isReloadable" ></a><p>
915<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
916  <tr>
917    <td class="mdRow">
918      <table cellpadding="0" cellspacing="0" border="0">
919        <tr>
920          <td class="md" nowrap valign="top"> bool Ogre::Resource::isReloadable </td>
921          <td class="md" valign="top">(&nbsp;</td>
922          <td class="md" nowrap valign="top">void&nbsp;</td>
923          <td class="mdname1" valign="top" nowrap>          </td>
924          <td class="md" valign="top">&nbsp;)&nbsp;</td>
925          <td class="md" nowrap> const</td>
926        </tr>
927
928      </table>
929    </td>
930  </tr>
931</table>
932<table cellspacing=5 cellpadding=0 border=0>
933  <tr>
934    <td>
935      &nbsp;
936    </td>
937    <td>
938
939<p>
940Returns true if the <a class="el" href="classOgre_1_1Resource.html">Resource</a> is reloadable, false otherwise.
941<p>
942
943<p>
944Definition at line <a class="el" href="OgreResource_8h-source.html#l00153">153</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
945  </tr>
946</table>
947<a class="anchor" name="Ogre_1_1Texturea30" doxytag="Ogre::Resource::load" ></a><p>
948<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
949  <tr>
950    <td class="mdRow">
951      <table cellpadding="0" cellspacing="0" border="0">
952        <tr>
953          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::load </td>
954          <td class="md" valign="top">(&nbsp;</td>
955          <td class="md" nowrap valign="top">void&nbsp;</td>
956          <td class="mdname1" valign="top" nowrap>          </td>
957          <td class="md" valign="top">&nbsp;)&nbsp;</td>
958          <td class="md" nowrap><code> [virtual]</code></td>
959        </tr>
960
961      </table>
962    </td>
963  </tr>
964</table>
965<table cellspacing=5 cellpadding=0 border=0>
966  <tr>
967    <td>
968      &nbsp;
969    </td>
970    <td>
971
972<p>
973Loads the resource, if it is not already.
974<p>
975<dl compact><dt><b>Remarks:</b></dt><dd>If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own</dd></dl>
976
977<p>
978Reimplemented in <a class="el" href="classOgre_1_1Mesh.html#Ogre_1_1PatchMesha3">Ogre::Mesh</a>, and <a class="el" href="classOgre_1_1GLSLGpuProgram.html#Ogre_1_1GLSLGpuPrograma7">Ogre::GLSLGpuProgram</a>.    </td>
979  </tr>
980</table>
981<a class="anchor" name="Ogre_1_1Textureb5" doxytag="Ogre::Resource::loadImpl" ></a><p>
982<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
983  <tr>
984    <td class="mdRow">
985      <table cellpadding="0" cellspacing="0" border="0">
986        <tr>
987          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::loadImpl </td>
988          <td class="md" valign="top">(&nbsp;</td>
989          <td class="md" nowrap valign="top">void&nbsp;</td>
990          <td class="mdname1" valign="top" nowrap>          </td>
991          <td class="md" valign="top">&nbsp;)&nbsp;</td>
992          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
993        </tr>
994
995      </table>
996    </td>
997  </tr>
998</table>
999<table cellspacing=5 cellpadding=0 border=0>
1000  <tr>
1001    <td>
1002      &nbsp;
1003    </td>
1004    <td>
1005
1006<p>
1007Internal implementation of the 'load' action, only called if this resource is not being loaded from a <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>.
1008<p>
1009
1010<p>
1011Implemented in <a class="el" href="classOgre_1_1Font.html#Ogre_1_1Fontb1">Ogre::Font</a>, <a class="el" href="classOgre_1_1GpuProgram.html#Ogre_1_1GpuProgramb2">Ogre::GpuProgram</a>, <a class="el" href="classOgre_1_1HighLevelGpuProgram.html#Ogre_1_1HighLevelGpuProgramb6">Ogre::HighLevelGpuProgram</a>, <a class="el" href="classOgre_1_1Material.html#Ogre_1_1Materialb2">Ogre::Material</a>, <a class="el" href="classOgre_1_1Mesh.html#Ogre_1_1Meshb3">Ogre::Mesh</a>, <a class="el" href="classOgre_1_1PatchMesh.html#Ogre_1_1PatchMeshb0">Ogre::PatchMesh</a>, <a class="el" href="classOgre_1_1Skeleton.html#Ogre_1_1Skeletonb3">Ogre::Skeleton</a>, <a class="el" href="classOgre_1_1SkeletonInstance.html#Ogre_1_1SkeletonInstanceb1">Ogre::SkeletonInstance</a>, <a class="el" href="classOgre_1_1BspLevel.html#Ogre_1_1BspLevelb0">Ogre::BspLevel</a>, <a class="el" href="classOgre_1_1D3DTexture.html#Ogre_1_1D3DTextureb0">Ogre::D3DTexture</a>, <a class="el" href="classOgre_1_1D3D9GpuProgram.html#Ogre_1_1D3D9GpuVertexProgramb2">Ogre::D3D9GpuProgram</a>, <a class="el" href="classOgre_1_1D3D9Texture.html#Ogre_1_1D3D9Textureb18">Ogre::D3D9Texture</a>, and <a class="el" href="classOgre_1_1GLTexture.html#Ogre_1_1GLTextureb1">Ogre::GLTexture</a>.    </td>
1012  </tr>
1013</table>
1014<a class="anchor" name="Ogre_1_1Texturea31" doxytag="Ogre::Resource::reload" ></a><p>
1015<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1016  <tr>
1017    <td class="mdRow">
1018      <table cellpadding="0" cellspacing="0" border="0">
1019        <tr>
1020          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::reload </td>
1021          <td class="md" valign="top">(&nbsp;</td>
1022          <td class="md" nowrap valign="top">void&nbsp;</td>
1023          <td class="mdname1" valign="top" nowrap>          </td>
1024          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1025          <td class="md" nowrap><code> [virtual]</code></td>
1026        </tr>
1027
1028      </table>
1029    </td>
1030  </tr>
1031</table>
1032<table cellspacing=5 cellpadding=0 border=0>
1033  <tr>
1034    <td>
1035      &nbsp;
1036    </td>
1037    <td>
1038
1039<p>
1040Reloads the resource, if it is already loaded.
1041<p>
1042<dl compact><dt><b>Remarks:</b></dt><dd>Calls <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea34">unload()</a> and then <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea30">load()</a> again, if the resource is already loaded. If it is not loaded already, then nothing happens.</dd></dl>
1043    </td>
1044  </tr>
1045</table>
1046<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::Resource::setParameter" ></a><p>
1047<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1048  <tr>
1049    <td class="mdRow">
1050      <table cellpadding="0" cellspacing="0" border="0">
1051        <tr>
1052          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
1053          <td class="md" valign="top">(&nbsp;</td>
1054          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
1055          <td class="mdname" nowrap> <em>name</em>, </td>
1056        </tr>
1057        <tr>
1058          <td class="md" nowrap align="right"></td>
1059          <td></td>
1060          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
1061          <td class="mdname" nowrap> <em>value</em></td>
1062        </tr>
1063        <tr>
1064          <td></td>
1065          <td class="md">)&nbsp;</td>
1066          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
1067        </tr>
1068
1069      </table>
1070    </td>
1071  </tr>
1072</table>
1073<table cellspacing=5 cellpadding=0 border=0>
1074  <tr>
1075    <td>
1076      &nbsp;
1077    </td>
1078    <td>
1079
1080<p>
1081Generic parameter setting method.
1082<p>
1083<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
1084<dl compact><dt><b>Parameters:</b></dt><dd>
1085  <table border="0" cellspacing="2" cellpadding="0">
1086    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
1087    <tr><td valign=top><em>value</em>&nbsp;</td><td>String value. Must be in the right format for the type specified in the parameter definition. See the <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> class for more information. </td></tr>
1088  </table>
1089</dl>
1090<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
1091
1092<p>
1093Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">Ogre::StringInterface::copyParametersTo()</a>.    </td>
1094  </tr>
1095</table>
1096<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::Resource::setParameterList" ></a><p>
1097<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1098  <tr>
1099    <td class="mdRow">
1100      <table cellpadding="0" cellspacing="0" border="0">
1101        <tr>
1102          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
1103          <td class="md" valign="top">(&nbsp;</td>
1104          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;&nbsp;</td>
1105          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
1106          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1107          <td class="md" nowrap><code> [virtual, inherited]</code></td>
1108        </tr>
1109
1110      </table>
1111    </td>
1112  </tr>
1113</table>
1114<table cellspacing=5 cellpadding=0 border=0>
1115  <tr>
1116    <td>
1117      &nbsp;
1118    </td>
1119    <td>
1120
1121<p>
1122Generic multiple parameter setting method.
1123<p>
1124<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
1125<dl compact><dt><b>Parameters:</b></dt><dd>
1126  <table border="0" cellspacing="2" cellpadding="0">
1127    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
1128  </table>
1129</dl>
1130    </td>
1131  </tr>
1132</table>
1133<a class="anchor" name="Ogre_1_1Texturea36" doxytag="Ogre::Resource::touch" ></a><p>
1134<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1135  <tr>
1136    <td class="mdRow">
1137      <table cellpadding="0" cellspacing="0" border="0">
1138        <tr>
1139          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::touch </td>
1140          <td class="md" valign="top">(&nbsp;</td>
1141          <td class="md" nowrap valign="top">void&nbsp;</td>
1142          <td class="mdname1" valign="top" nowrap>          </td>
1143          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1144          <td class="md" nowrap><code> [virtual]</code></td>
1145        </tr>
1146
1147      </table>
1148    </td>
1149  </tr>
1150</table>
1151<table cellspacing=5 cellpadding=0 border=0>
1152  <tr>
1153    <td>
1154      &nbsp;
1155    </td>
1156    <td>
1157
1158<p>
1159'Touches' the resource to indicate it has been used.
1160<p>
1161
1162<p>
1163Reimplemented in <a class="el" href="classOgre_1_1Material.html#Ogre_1_1Materiala50">Ogre::Material</a>.    </td>
1164  </tr>
1165</table>
1166<a class="anchor" name="Ogre_1_1Texturea34" doxytag="Ogre::Resource::unload" ></a><p>
1167<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1168  <tr>
1169    <td class="mdRow">
1170      <table cellpadding="0" cellspacing="0" border="0">
1171        <tr>
1172          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::unload </td>
1173          <td class="md" valign="top">(&nbsp;</td>
1174          <td class="md" nowrap valign="top">void&nbsp;</td>
1175          <td class="mdname1" valign="top" nowrap>          </td>
1176          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1177          <td class="md" nowrap><code> [virtual]</code></td>
1178        </tr>
1179
1180      </table>
1181    </td>
1182  </tr>
1183</table>
1184<table cellspacing=5 cellpadding=0 border=0>
1185  <tr>
1186    <td>
1187      &nbsp;
1188    </td>
1189    <td>
1190
1191<p>
1192Unloads the resource; this is not permanent, the resource can be reloaded later if required.
1193<p>
1194
1195<p>
1196Reimplemented in <a class="el" href="classOgre_1_1GLSLGpuProgram.html#Ogre_1_1GLSLGpuPrograma2">Ogre::GLSLGpuProgram</a>.    </td>
1197  </tr>
1198</table>
1199<a class="anchor" name="Ogre_1_1Resourceb2" doxytag="Ogre::Resource::unloadImpl" ></a><p>
1200<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1201  <tr>
1202    <td class="mdRow">
1203      <table cellpadding="0" cellspacing="0" border="0">
1204        <tr>
1205          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::unloadImpl </td>
1206          <td class="md" valign="top">(&nbsp;</td>
1207          <td class="md" nowrap valign="top">void&nbsp;</td>
1208          <td class="mdname1" valign="top" nowrap>          </td>
1209          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1210          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
1211        </tr>
1212
1213      </table>
1214    </td>
1215  </tr>
1216</table>
1217<table cellspacing=5 cellpadding=0 border=0>
1218  <tr>
1219    <td>
1220      &nbsp;
1221    </td>
1222    <td>
1223
1224<p>
1225Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>.
1226<p>
1227
1228<p>
1229Implemented in <a class="el" href="classOgre_1_1Font.html#Ogre_1_1Fontb2">Ogre::Font</a>, <a class="el" href="classOgre_1_1HighLevelGpuProgram.html#Ogre_1_1HighLevelGpuProgramb7">Ogre::HighLevelGpuProgram</a>, <a class="el" href="classOgre_1_1Material.html#Ogre_1_1Materialb3">Ogre::Material</a>, <a class="el" href="classOgre_1_1Mesh.html#Ogre_1_1PatchMeshb4">Ogre::Mesh</a>, <a class="el" href="classOgre_1_1Skeleton.html#Ogre_1_1Skeletonb4">Ogre::Skeleton</a>, <a class="el" href="classOgre_1_1SkeletonInstance.html#Ogre_1_1SkeletonInstanceb2">Ogre::SkeletonInstance</a>, <a class="el" href="classOgre_1_1Texture.html#Ogre_1_1Textureb4">Ogre::Texture</a>, <a class="el" href="classOgre_1_1BspLevel.html#Ogre_1_1BspLevelb1">Ogre::BspLevel</a>, <a class="el" href="classOgre_1_1D3D7GpuProgram.html#Ogre_1_1D3D7GpuProgramb1">Ogre::D3D7GpuProgram</a>, <a class="el" href="classOgre_1_1D3D9GpuVertexProgram.html#Ogre_1_1D3D9GpuVertexProgramb0">Ogre::D3D9GpuVertexProgram</a>, <a class="el" href="classOgre_1_1D3D9GpuFragmentProgram.html#Ogre_1_1D3D9GpuFragmentProgramb0">Ogre::D3D9GpuFragmentProgram</a>, <a class="el" href="classOgre_1_1GLGpuNvparseProgram.html#Ogre_1_1GLGpuNvparseProgramb0">Ogre::GLGpuNvparseProgram</a>, <a class="el" href="classOgre_1_1GLGpuProgram.html#Ogre_1_1GLSLGpuProgramb1">Ogre::GLGpuProgram</a>, and <a class="el" href="classOgre_1_1GLArbGpuProgram.html#Ogre_1_1GLArbGpuProgramb1">Ogre::GLArbGpuProgram</a>.    </td>
1230  </tr>
1231</table>
1232<hr><h2>Member Data Documentation</h2>
1233<a class="anchor" name="Ogre_1_1Texturep17" doxytag="Ogre::Resource::mCreator" ></a><p>
1234<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1235  <tr>
1236    <td class="mdRow">
1237      <table cellpadding="0" cellspacing="0" border="0">
1238        <tr>
1239          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a>* <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep17">Ogre::Resource::mCreator</a><code> [protected]</code>
1240      </table>
1241    </td>
1242  </tr>
1243</table>
1244<table cellspacing=5 cellpadding=0 border=0>
1245  <tr>
1246    <td>
1247      &nbsp;
1248    </td>
1249    <td>
1250
1251<p>
1252Creator.
1253<p>
1254
1255<p>
1256Definition at line <a class="el" href="OgreResource_8h-source.html#l00073">73</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1257  </tr>
1258</table>
1259<a class="anchor" name="Ogre_1_1Texturep19" doxytag="Ogre::Resource::mGroup" ></a><p>
1260<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1261  <tr>
1262    <td class="mdRow">
1263      <table cellpadding="0" cellspacing="0" border="0">
1264        <tr>
1265          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep19">Ogre::Resource::mGroup</a><code> [protected]</code>
1266      </table>
1267    </td>
1268  </tr>
1269</table>
1270<table cellspacing=5 cellpadding=0 border=0>
1271  <tr>
1272    <td>
1273      &nbsp;
1274    </td>
1275    <td>
1276
1277<p>
1278The name of the resource group.
1279<p>
1280
1281<p>
1282Definition at line <a class="el" href="OgreResource_8h-source.html#l00077">77</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1283  </tr>
1284</table>
1285<a class="anchor" name="Ogre_1_1Texturep20" doxytag="Ogre::Resource::mHandle" ></a><p>
1286<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1287  <tr>
1288    <td class="mdRow">
1289      <table cellpadding="0" cellspacing="0" border="0">
1290        <tr>
1291          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a485">ResourceHandle</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep20">Ogre::Resource::mHandle</a><code> [protected]</code>
1292      </table>
1293    </td>
1294  </tr>
1295</table>
1296<table cellspacing=5 cellpadding=0 border=0>
1297  <tr>
1298    <td>
1299      &nbsp;
1300    </td>
1301    <td>
1302
1303<p>
1304Numeric handle for more efficient look up than name.
1305<p>
1306
1307<p>
1308Definition at line <a class="el" href="OgreResource_8h-source.html#l00079">79</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1309  </tr>
1310</table>
1311<a class="anchor" name="Ogre_1_1Texturep21" doxytag="Ogre::Resource::mIsLoaded" ></a><p>
1312<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1313  <tr>
1314    <td class="mdRow">
1315      <table cellpadding="0" cellspacing="0" border="0">
1316        <tr>
1317          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep21">Ogre::Resource::mIsLoaded</a><code> [protected]</code>
1318      </table>
1319    </td>
1320  </tr>
1321</table>
1322<table cellspacing=5 cellpadding=0 border=0>
1323  <tr>
1324    <td>
1325      &nbsp;
1326    </td>
1327    <td>
1328
1329<p>
1330Is the resource currently loaded?
1331<p>
1332
1333<p>
1334Definition at line <a class="el" href="OgreResource_8h-source.html#l00081">81</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1335  </tr>
1336</table>
1337<a class="anchor" name="Ogre_1_1Texturep23" doxytag="Ogre::Resource::mIsManual" ></a><p>
1338<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1339  <tr>
1340    <td class="mdRow">
1341      <table cellpadding="0" cellspacing="0" border="0">
1342        <tr>
1343          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep23">Ogre::Resource::mIsManual</a><code> [protected]</code>
1344      </table>
1345    </td>
1346  </tr>
1347</table>
1348<table cellspacing=5 cellpadding=0 border=0>
1349  <tr>
1350    <td>
1351      &nbsp;
1352    </td>
1353    <td>
1354
1355<p>
1356Is this file manually loaded?
1357<p>
1358
1359<p>
1360Definition at line <a class="el" href="OgreResource_8h-source.html#l00085">85</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1361  </tr>
1362</table>
1363<a class="anchor" name="Ogre_1_1Texturep25" doxytag="Ogre::Resource::mLoader" ></a><p>
1364<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1365  <tr>
1366    <td class="mdRow">
1367      <table cellpadding="0" cellspacing="0" border="0">
1368        <tr>
1369          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>* <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep25">Ogre::Resource::mLoader</a><code> [protected]</code>
1370      </table>
1371    </td>
1372  </tr>
1373</table>
1374<table cellspacing=5 cellpadding=0 border=0>
1375  <tr>
1376    <td>
1377      &nbsp;
1378    </td>
1379    <td>
1380
1381<p>
1382Optional manual loader; if provided, data is loaded from here instead of a file.
1383<p>
1384
1385<p>
1386Definition at line <a class="el" href="OgreResource_8h-source.html#l00089">89</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1387  </tr>
1388</table>
1389<a class="anchor" name="Ogre_1_1Texturep18" doxytag="Ogre::Resource::mName" ></a><p>
1390<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1391  <tr>
1392    <td class="mdRow">
1393      <table cellpadding="0" cellspacing="0" border="0">
1394        <tr>
1395          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep18">Ogre::Resource::mName</a><code> [protected]</code>
1396      </table>
1397    </td>
1398  </tr>
1399</table>
1400<table cellspacing=5 cellpadding=0 border=0>
1401  <tr>
1402    <td>
1403      &nbsp;
1404    </td>
1405    <td>
1406
1407<p>
1408Unique name of the resource.
1409<p>
1410
1411<p>
1412Definition at line <a class="el" href="OgreResource_8h-source.html#l00075">75</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1413  </tr>
1414</table>
1415<a class="anchor" name="Ogre_1_1Texturep24" doxytag="Ogre::Resource::mOrigin" ></a><p>
1416<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1417  <tr>
1418    <td class="mdRow">
1419      <table cellpadding="0" cellspacing="0" border="0">
1420        <tr>
1421          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep24">Ogre::Resource::mOrigin</a><code> [protected]</code>
1422      </table>
1423    </td>
1424  </tr>
1425</table>
1426<table cellspacing=5 cellpadding=0 border=0>
1427  <tr>
1428    <td>
1429      &nbsp;
1430    </td>
1431    <td>
1432
1433<p>
1434Origin of this resource (e.g. script name) - optional.
1435<p>
1436
1437<p>
1438Definition at line <a class="el" href="OgreResource_8h-source.html#l00087">87</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1439  </tr>
1440</table>
1441<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::Resource::mParamDictName" ></a><p>
1442<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1443  <tr>
1444    <td class="mdRow">
1445      <table cellpadding="0" cellspacing="0" border="0">
1446        <tr>
1447          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected, inherited]</code>
1448      </table>
1449    </td>
1450  </tr>
1451</table>
1452<table cellspacing=5 cellpadding=0 border=0>
1453  <tr>
1454    <td>
1455      &nbsp;
1456    </td>
1457    <td>
1458
1459<p>
1460Class name for this instance to be used as a lookup (must be initialised by subclasses).
1461<p>
1462
1463<p>
1464Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00160">160</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
1465  </tr>
1466</table>
1467<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::Resource::msDictionary" ></a><p>
1468<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1469  <tr>
1470    <td class="mdRow">
1471      <table cellpadding="0" cellspacing="0" border="0">
1472        <tr>
1473          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected, inherited]</code>
1474      </table>
1475    </td>
1476  </tr>
1477</table>
1478<table cellspacing=5 cellpadding=0 border=0>
1479  <tr>
1480    <td>
1481      &nbsp;
1482    </td>
1483    <td>
1484
1485<p>
1486Dictionary of parameters.
1487<p>
1488
1489<p>
1490Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00157">157</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
1491  </tr>
1492</table>
1493<a class="anchor" name="Ogre_1_1Texturep22" doxytag="Ogre::Resource::mSize" ></a><p>
1494<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1495  <tr>
1496    <td class="mdRow">
1497      <table cellpadding="0" cellspacing="0" border="0">
1498        <tr>
1499          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep22">Ogre::Resource::mSize</a><code> [protected]</code>
1500      </table>
1501    </td>
1502  </tr>
1503</table>
1504<table cellspacing=5 cellpadding=0 border=0>
1505  <tr>
1506    <td>
1507      &nbsp;
1508    </td>
1509    <td>
1510
1511<p>
1512The size of the resource in bytes.
1513<p>
1514
1515<p>
1516Definition at line <a class="el" href="OgreResource_8h-source.html#l00083">83</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
1517  </tr>
1518</table>
1519<hr>The documentation for this class was generated from the following file:<ul>
1520<li><a class="el" href="OgreResource_8h-source.html">OgreResource.h</a></ul>
1521<hr>
1522<p>
1523Copyright &copy; 2000-2005 by The OGRE Team<br />
1524<!--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/>
1525This 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/>
1526                <!--/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#">
1527                <Work rdf:about="">
1528                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1529        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1530                </Work>
1531                <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> -->
1532
1533Last modified Sun Feb 12 13:02:47 2006
1534</p>
1535</body>
1536</html>
Note: See TracBrowser for help on using the repository browser.