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

Revision 692, 76.8 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
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="0,0,130,24">
19<area href="classOgre_1_1BspLevel.html" alt="Ogre::BspLevel" shape="rect" coords="140,112,270,136">
20<area href="classOgre_1_1Compositor.html" alt="Ogre::Compositor" shape="rect" coords="140,168,270,192">
21<area href="classOgre_1_1Font.html" alt="Ogre::Font" shape="rect" coords="140,224,270,248">
22<area href="classOgre_1_1GpuProgram.html" alt="Ogre::GpuProgram" shape="rect" coords="140,280,270,304">
23<area href="classOgre_1_1Material.html" alt="Ogre::Material" shape="rect" coords="140,336,270,360">
24<area href="classOgre_1_1Mesh.html" alt="Ogre::Mesh" shape="rect" coords="140,392,270,416">
25<area href="classOgre_1_1Skeleton.html" alt="Ogre::Skeleton" shape="rect" coords="140,448,270,472">
26<area href="classOgre_1_1Texture.html" alt="Ogre::Texture" shape="rect" coords="140,504,270,528">
27</map>
28<a href="classOgre_1_1Resource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
29<tr><td></td></tr>
30<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
31<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#a471">String</a> &amp;name, <a class="el" href="namespaceOgre.html#a529">ResourceHandle</a> handle, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;group, bool isManual=false, <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> *loader=0)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard constructor.  <a href="#Ogre_1_1Resourcea0"></a><br><br></td></tr>
34<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>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor.  <a href="#Ogre_1_1Resourcea1"></a><br><br></td></tr>
37<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>
38
39<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>
40<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>
41
42<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>
43<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>
44
45<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>
46<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>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this resource manually loaded?  <a href="#Ogre_1_1Texturea33"></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_1Texturea34">unload</a> (void)</td></tr>
50
51<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>
52<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>
53
54<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>
55<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>
56
57<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>
58<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">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>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets resource name.  <a href="#Ogre_1_1Texturea37"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a529">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>
62
63<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>
64
65<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>
66<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">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>
67
68<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>
69<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_1Texturea41">changeGroupOwnership</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;newGroup)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the resource group ownership of a <a class="el" href="classOgre_1_1Resource.html">Resource</a>.  <a href="#Ogre_1_1Texturea41"></a><br><br></td></tr>
72<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_1Texturea42">getCreator</a> (void)</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the manager which created this resource.  <a href="#Ogre_1_1Texturea42"></a><br><br></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturea43">getOrigin</a> (void) const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the origin of this resource, e.g.  <a href="#Ogre_1_1Texturea43"></a><br><br></td></tr>
78<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_1Texturea44">_notifyOrigin</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;origin)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Notify this resource of it's origin.  <a href="#Ogre_1_1Texturea44"></a><br><br></td></tr>
81<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_1Texturea45">getParamDictionary</a> (void)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea45"></a><br><br></td></tr>
84<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_1Texturea46">getParamDictionary</a> (void) const </td></tr>
85
86<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a563">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">getParameters</a> (void) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
89<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_1Texturea48">setParameter</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;value)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea48"></a><br><br></td></tr>
92<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_1Texturea49">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a76">NameValuePairList</a> &amp;paramList)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">getParameter</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name) const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea50"></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_1Texturea51">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea51"></a><br><br></td></tr>
101<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
102<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>
103
104<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>
105<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
106<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>
107
108<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>
109<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>
110
111<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>
112<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>
113
114<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>
115<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>
116
117<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>
118<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#a471">String</a> &amp;className)</td></tr>
119
120<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>
121<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
122<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>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creator.  <a href="#Ogre_1_1Texturep17"></a><br><br></td></tr>
125<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep18">mName</a></td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unique name of the resource.  <a href="#Ogre_1_1Texturep18"></a><br><br></td></tr>
128<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep19">mGroup</a></td></tr>
129
130<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>
131<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a529">ResourceHandle</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep20">mHandle</a></td></tr>
132
133<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>
134<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>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the resource currently loaded?  <a href="#Ogre_1_1Texturep21"></a><br><br></td></tr>
137<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>
138
139<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>
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_1Texturep23">mIsManual</a></td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this file manually loaded?  <a href="#Ogre_1_1Texturep23"></a><br><br></td></tr>
143<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep24">mOrigin</a></td></tr>
144
145<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>
146<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>
147
148<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>
149<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
150
151<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>
152<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
153<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a565">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
156</table>
157<hr><a name="_details"></a><h2>Detailed Description</h2>
158Abstract class reprensenting a loadable resource (e.g.
159<p>
160textures, 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>
161<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>
162<dl compact><dt><b></b></dt><dd>Subclasses must implement: <ol>
163<li>
164A 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>
165<li>
166The <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>
167<li>
168<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>
169</ol>
170</dd></dl>
171
172<p>
173
174<p>
175Definition 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>
176<a class="anchor" name="Ogre_1_1Resourceb0" doxytag="Ogre::Resource::Resource" ></a><p>
177<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
178  <tr>
179    <td class="mdRow">
180      <table cellpadding="0" cellspacing="0" border="0">
181        <tr>
182          <td class="md" nowrap valign="top"> Ogre::Resource::Resource </td>
183          <td class="md" valign="top">(&nbsp;</td>
184          <td class="mdname1" valign="top" nowrap>          </td>
185          <td class="md" valign="top">&nbsp;)&nbsp;</td>
186          <td class="md" nowrap><code> [protected]</code></td>
187        </tr>
188
189      </table>
190    </td>
191  </tr>
192</table>
193<table cellspacing=5 cellpadding=0 border=0>
194  <tr>
195    <td>
196      &nbsp;
197    </td>
198    <td>
199
200<p>
201Protected unnamed constructor to prevent default construction.
202<p>
203
204<p>
205Definition 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>
206  </tr>
207</table>
208<a class="anchor" name="Ogre_1_1Resourcea0" doxytag="Ogre::Resource::Resource" ></a><p>
209<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
210  <tr>
211    <td class="mdRow">
212      <table cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td class="md" nowrap valign="top"> Ogre::Resource::Resource </td>
215          <td class="md" valign="top">(&nbsp;</td>
216          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> *&nbsp;</td>
217          <td class="mdname" nowrap> <em>creator</em>, </td>
218        </tr>
219        <tr>
220          <td class="md" nowrap align="right"></td>
221          <td></td>
222          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
223          <td class="mdname" nowrap> <em>name</em>, </td>
224        </tr>
225        <tr>
226          <td class="md" nowrap align="right"></td>
227          <td></td>
228          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a529">ResourceHandle</a>&nbsp;</td>
229          <td class="mdname" nowrap> <em>handle</em>, </td>
230        </tr>
231        <tr>
232          <td class="md" nowrap align="right"></td>
233          <td></td>
234          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
235          <td class="mdname" nowrap> <em>group</em>, </td>
236        </tr>
237        <tr>
238          <td class="md" nowrap align="right"></td>
239          <td></td>
240          <td class="md" nowrap>bool&nbsp;</td>
241          <td class="mdname" nowrap> <em>isManual</em> = false, </td>
242        </tr>
243        <tr>
244          <td class="md" nowrap align="right"></td>
245          <td></td>
246          <td class="md" nowrap><a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> *&nbsp;</td>
247          <td class="mdname" nowrap> <em>loader</em> = 0</td>
248        </tr>
249        <tr>
250          <td></td>
251          <td class="md">)&nbsp;</td>
252          <td class="md" colspan="2"></td>
253        </tr>
254
255      </table>
256    </td>
257  </tr>
258</table>
259<table cellspacing=5 cellpadding=0 border=0>
260  <tr>
261    <td>
262      &nbsp;
263    </td>
264    <td>
265
266<p>
267Standard constructor.
268<p>
269<dl compact><dt><b>Parameters:</b></dt><dd>
270  <table border="0" cellspacing="2" cellpadding="0">
271    <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>
272    <tr><td valign=top><em>name</em>&nbsp;</td><td>The unique name of the resource </td></tr>
273    <tr><td valign=top><em>group</em>&nbsp;</td><td>The name of the resource group to which this resource belongs </td></tr>
274    <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>
275    <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>
276  </table>
277</dl>
278    </td>
279  </tr>
280</table>
281<a class="anchor" name="Ogre_1_1Resourcea1" doxytag="Ogre::Resource::~Resource" ></a><p>
282<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
283  <tr>
284    <td class="mdRow">
285      <table cellpadding="0" cellspacing="0" border="0">
286        <tr>
287          <td class="md" nowrap valign="top"> virtual Ogre::Resource::~<a class="el" href="classOgre_1_1Resource.html">Resource</a> </td>
288          <td class="md" valign="top">(&nbsp;</td>
289          <td class="mdname1" valign="top" nowrap>          </td>
290          <td class="md" valign="top">&nbsp;)&nbsp;</td>
291          <td class="md" nowrap><code> [virtual]</code></td>
292        </tr>
293
294      </table>
295    </td>
296  </tr>
297</table>
298<table cellspacing=5 cellpadding=0 border=0>
299  <tr>
300    <td>
301      &nbsp;
302    </td>
303    <td>
304
305<p>
306Virtual destructor.
307<p>
308Shouldn'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>
309    </td>
310  </tr>
311</table>
312<hr><h2>Member Function Documentation</h2>
313<a class="anchor" name="Ogre_1_1Texturea44" doxytag="Ogre::Resource::_notifyOrigin" ></a><p>
314<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
315  <tr>
316    <td class="mdRow">
317      <table cellpadding="0" cellspacing="0" border="0">
318        <tr>
319          <td class="md" nowrap valign="top"> void Ogre::Resource::_notifyOrigin </td>
320          <td class="md" valign="top">(&nbsp;</td>
321          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
322          <td class="mdname1" valign="top" nowrap> <em>origin</em>          </td>
323          <td class="md" valign="top">&nbsp;)&nbsp;</td>
324          <td class="md" nowrap></td>
325        </tr>
326
327      </table>
328    </td>
329  </tr>
330</table>
331<table cellspacing=5 cellpadding=0 border=0>
332  <tr>
333    <td>
334      &nbsp;
335    </td>
336    <td>
337
338<p>
339Notify this resource of it's origin.
340<p>
341
342<p>
343Definition at line <a class="el" href="OgreResource_8h-source.html#l00223">223</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
344<p>
345References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
346  </tr>
347</table>
348<a class="anchor" name="Ogre_1_1Resourceb3" doxytag="Ogre::Resource::calculateSize" ></a><p>
349<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
350  <tr>
351    <td class="mdRow">
352      <table cellpadding="0" cellspacing="0" border="0">
353        <tr>
354          <td class="md" nowrap valign="top"> virtual size_t Ogre::Resource::calculateSize </td>
355          <td class="md" valign="top">(&nbsp;</td>
356          <td class="md" nowrap valign="top">void&nbsp;</td>
357          <td class="mdname1" valign="top" nowrap>          </td>
358          <td class="md" valign="top">&nbsp;)&nbsp;</td>
359          <td class="md" nowrap> const<code> [protected, pure virtual]</code></td>
360        </tr>
361
362      </table>
363    </td>
364  </tr>
365</table>
366<table cellspacing=5 cellpadding=0 border=0>
367  <tr>
368    <td>
369      &nbsp;
370    </td>
371    <td>
372
373<p>
374Calculate the size of a resource; this will only be called after 'load'.
375<p>
376
377<p>
378Implemented in <a class="el" href="classOgre_1_1Compositor.html#Ogre_1_1Compositorb2">Ogre::Compositor</a>, <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_1Materialb5">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>
379  </tr>
380</table>
381<a class="anchor" name="Ogre_1_1Texturea41" doxytag="Ogre::Resource::changeGroupOwnership" ></a><p>
382<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
383  <tr>
384    <td class="mdRow">
385      <table cellpadding="0" cellspacing="0" border="0">
386        <tr>
387          <td class="md" nowrap valign="top"> void Ogre::Resource::changeGroupOwnership </td>
388          <td class="md" valign="top">(&nbsp;</td>
389          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
390          <td class="mdname1" valign="top" nowrap> <em>newGroup</em>          </td>
391          <td class="md" valign="top">&nbsp;)&nbsp;</td>
392          <td class="md" nowrap></td>
393        </tr>
394
395      </table>
396    </td>
397  </tr>
398</table>
399<table cellspacing=5 cellpadding=0 border=0>
400  <tr>
401    <td>
402      &nbsp;
403    </td>
404    <td>
405
406<p>
407Change the resource group ownership of a <a class="el" href="classOgre_1_1Resource.html">Resource</a>.
408<p>
409<dl compact><dt><b>Remarks:</b></dt><dd>This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another. </dd></dl>
410<dl compact><dt><b>Parameters:</b></dt><dd>
411  <table border="0" cellspacing="2" cellpadding="0">
412    <tr><td valign=top><em>newGroup</em>&nbsp;</td><td>Name of the new group</td></tr>
413  </table>
414</dl>
415    </td>
416  </tr>
417</table>
418<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::Resource::cleanupDictionary" ></a><p>
419<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
420  <tr>
421    <td class="mdRow">
422      <table cellpadding="0" cellspacing="0" border="0">
423        <tr>
424          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
425          <td class="md" valign="top">(&nbsp;</td>
426          <td class="mdname1" valign="top" nowrap>          </td>
427          <td class="md" valign="top">&nbsp;)&nbsp;</td>
428          <td class="md" nowrap><code> [static, 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>
443Cleans 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.
444<p>
445<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
446  </tr>
447</table>
448<a class="anchor" name="Ogre_1_1Texturea51" doxytag="Ogre::Resource::copyParametersTo" ></a><p>
449<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
450  <tr>
451    <td class="mdRow">
452      <table cellpadding="0" cellspacing="0" border="0">
453        <tr>
454          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
455          <td class="md" valign="top">(&nbsp;</td>
456          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
457          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
458          <td class="md" valign="top">&nbsp;)&nbsp;</td>
459          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
460        </tr>
461
462      </table>
463    </td>
464  </tr>
465</table>
466<table cellspacing=5 cellpadding=0 border=0>
467  <tr>
468    <td>
469      &nbsp;
470    </td>
471    <td>
472
473<p>
474Method for copying this object's parameters to another object.
475<p>
476<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>
477<dl compact><dt><b></b></dt><dd><a class="el" href="classOgre_1_1Any.html">Any</a> unrecognised parameters will be ignored as with setParameter method. </dd></dl>
478<dl compact><dt><b>Parameters:</b></dt><dd>
479  <table border="0" cellspacing="2" cellpadding="0">
480    <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>
481  </table>
482</dl>
483
484<p>
485Definition 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>.
486<p>
487References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">Ogre::StringInterface::setParameter()</a>.    </td>
488  </tr>
489</table>
490<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::Resource::createParamDictionary" ></a><p>
491<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
492  <tr>
493    <td class="mdRow">
494      <table cellpadding="0" cellspacing="0" border="0">
495        <tr>
496          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
497          <td class="md" valign="top">(&nbsp;</td>
498          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
499          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
500          <td class="md" valign="top">&nbsp;)&nbsp;</td>
501          <td class="md" nowrap><code> [protected, inherited]</code></td>
502        </tr>
503
504      </table>
505    </td>
506  </tr>
507</table>
508<table cellspacing=5 cellpadding=0 border=0>
509  <tr>
510    <td>
511      &nbsp;
512    </td>
513    <td>
514
515<p>
516Internal method for creating a parameter dictionary for the class, if it does not already exist.
517<p>
518<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>
519<dl compact><dt><b>Parameters:</b></dt><dd>
520  <table border="0" cellspacing="2" cellpadding="0">
521    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
522  </table>
523</dl>
524<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
525
526<p>
527Definition 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>.
528<p>
529References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
530  </tr>
531</table>
532<a class="anchor" name="Ogre_1_1Texturea42" doxytag="Ogre::Resource::getCreator" ></a><p>
533<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
534  <tr>
535    <td class="mdRow">
536      <table cellpadding="0" cellspacing="0" border="0">
537        <tr>
538          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a>* Ogre::Resource::getCreator </td>
539          <td class="md" valign="top">(&nbsp;</td>
540          <td class="md" nowrap valign="top">void&nbsp;</td>
541          <td class="mdname1" valign="top" nowrap>          </td>
542          <td class="md" valign="top">&nbsp;)&nbsp;</td>
543          <td class="md" nowrap></td>
544        </tr>
545
546      </table>
547    </td>
548  </tr>
549</table>
550<table cellspacing=5 cellpadding=0 border=0>
551  <tr>
552    <td>
553      &nbsp;
554    </td>
555    <td>
556
557<p>
558Gets the manager which created this resource.
559<p>
560
561<p>
562Definition 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>.    </td>
563  </tr>
564</table>
565<a class="anchor" name="Ogre_1_1Texturea40" doxytag="Ogre::Resource::getGroup" ></a><p>
566<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
567  <tr>
568    <td class="mdRow">
569      <table cellpadding="0" cellspacing="0" border="0">
570        <tr>
571          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Resource::getGroup </td>
572          <td class="md" valign="top">(&nbsp;</td>
573          <td class="md" nowrap valign="top">void&nbsp;</td>
574          <td class="mdname1" valign="top" nowrap>          </td>
575          <td class="md" valign="top">&nbsp;)&nbsp;</td>
576          <td class="md" nowrap></td>
577        </tr>
578
579      </table>
580    </td>
581  </tr>
582</table>
583<table cellspacing=5 cellpadding=0 border=0>
584  <tr>
585    <td>
586      &nbsp;
587    </td>
588    <td>
589
590<p>
591Gets the group which this resource is a member of.
592<p>
593
594<p>
595Definition 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>.
596<p>
597References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
598  </tr>
599</table>
600<a class="anchor" name="Ogre_1_1Texturea38" doxytag="Ogre::Resource::getHandle" ></a><p>
601<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
602  <tr>
603    <td class="mdRow">
604      <table cellpadding="0" cellspacing="0" border="0">
605        <tr>
606          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a529">ResourceHandle</a> Ogre::Resource::getHandle </td>
607          <td class="md" valign="top">(&nbsp;</td>
608          <td class="md" nowrap valign="top">void&nbsp;</td>
609          <td class="mdname1" valign="top" nowrap>          </td>
610          <td class="md" valign="top">&nbsp;)&nbsp;</td>
611          <td class="md" nowrap> const</td>
612        </tr>
613
614      </table>
615    </td>
616  </tr>
617</table>
618<table cellspacing=5 cellpadding=0 border=0>
619  <tr>
620    <td>
621      &nbsp;
622    </td>
623    <td>
624
625<p>
626
627<p>
628Definition 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>.
629<p>
630References <a class="el" href="OgreResource_8h-source.html#l00035">Ogre::ResourceHandle</a>.    </td>
631  </tr>
632</table>
633<a class="anchor" name="Ogre_1_1Texturea37" doxytag="Ogre::Resource::getName" ></a><p>
634<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
635  <tr>
636    <td class="mdRow">
637      <table cellpadding="0" cellspacing="0" border="0">
638        <tr>
639          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Resource::getName </td>
640          <td class="md" valign="top">(&nbsp;</td>
641          <td class="md" nowrap valign="top">void&nbsp;</td>
642          <td class="mdname1" valign="top" nowrap>          </td>
643          <td class="md" valign="top">&nbsp;)&nbsp;</td>
644          <td class="md" nowrap> const</td>
645        </tr>
646
647      </table>
648    </td>
649  </tr>
650</table>
651<table cellspacing=5 cellpadding=0 border=0>
652  <tr>
653    <td>
654      &nbsp;
655    </td>
656    <td>
657
658<p>
659Gets resource name.
660<p>
661
662<p>
663Definition 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>.
664<p>
665References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
666  </tr>
667</table>
668<a class="anchor" name="Ogre_1_1Texturea43" doxytag="Ogre::Resource::getOrigin" ></a><p>
669<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
670  <tr>
671    <td class="mdRow">
672      <table cellpadding="0" cellspacing="0" border="0">
673        <tr>
674          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Resource::getOrigin </td>
675          <td class="md" valign="top">(&nbsp;</td>
676          <td class="md" nowrap valign="top">void&nbsp;</td>
677          <td class="mdname1" valign="top" nowrap>          </td>
678          <td class="md" valign="top">&nbsp;)&nbsp;</td>
679          <td class="md" nowrap> const</td>
680        </tr>
681
682      </table>
683    </td>
684  </tr>
685</table>
686<table cellspacing=5 cellpadding=0 border=0>
687  <tr>
688    <td>
689      &nbsp;
690    </td>
691    <td>
692
693<p>
694Get the origin of this resource, e.g.
695<p>
696a 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>
697
698<p>
699Definition at line <a class="el" href="OgreResource_8h-source.html#l00221">221</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.
700<p>
701References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
702  </tr>
703</table>
704<a class="anchor" name="Ogre_1_1Texturea46" 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"> const <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> const<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>
730
731<p>
732Definition 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>
733  </tr>
734</table>
735<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::Resource::getParamDictionary" ></a><p>
736<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
737  <tr>
738    <td class="mdRow">
739      <table cellpadding="0" cellspacing="0" border="0">
740        <tr>
741          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
742          <td class="md" valign="top">(&nbsp;</td>
743          <td class="md" nowrap valign="top">void&nbsp;</td>
744          <td class="mdname1" valign="top" nowrap>          </td>
745          <td class="md" valign="top">&nbsp;)&nbsp;</td>
746          <td class="md" nowrap><code> [inherited]</code></td>
747        </tr>
748
749      </table>
750    </td>
751  </tr>
752</table>
753<table cellspacing=5 cellpadding=0 border=0>
754  <tr>
755    <td>
756      &nbsp;
757    </td>
758    <td>
759
760<p>
761Retrieves the parameter dictionary for this class.
762<p>
763<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
764<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>
765
766<p>
767Definition 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>
768  </tr>
769</table>
770<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::Resource::getParameter" ></a><p>
771<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
772  <tr>
773    <td class="mdRow">
774      <table cellpadding="0" cellspacing="0" border="0">
775        <tr>
776          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::StringInterface::getParameter </td>
777          <td class="md" valign="top">(&nbsp;</td>
778          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
779          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
780          <td class="md" valign="top">&nbsp;)&nbsp;</td>
781          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
782        </tr>
783
784      </table>
785    </td>
786  </tr>
787</table>
788<table cellspacing=5 cellpadding=0 border=0>
789  <tr>
790    <td>
791      &nbsp;
792    </td>
793    <td>
794
795<p>
796Generic parameter retrieval method.
797<p>
798<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>
799<dl compact><dt><b>Parameters:</b></dt><dd>
800  <table border="0" cellspacing="2" cellpadding="0">
801    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
802  </table>
803</dl>
804<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
805
806<p>
807Definition 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>.
808<p>
809References <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#l00156">Ogre::String</a>.    </td>
810  </tr>
811</table>
812<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::Resource::getParameters" ></a><p>
813<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
814  <tr>
815    <td class="mdRow">
816      <table cellpadding="0" cellspacing="0" border="0">
817        <tr>
818          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a563">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
819          <td class="md" valign="top">(&nbsp;</td>
820          <td class="md" nowrap valign="top">void&nbsp;</td>
821          <td class="mdname1" valign="top" nowrap>          </td>
822          <td class="md" valign="top">&nbsp;)&nbsp;</td>
823          <td class="md" nowrap> const<code> [inherited]</code></td>
824        </tr>
825
826      </table>
827    </td>
828  </tr>
829</table>
830<table cellspacing=5 cellpadding=0 border=0>
831  <tr>
832    <td>
833      &nbsp;
834    </td>
835    <td>
836
837<p>
838Retrieves a list of parameters valid for this object.
839<p>
840<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>
841    </td>
842  </tr>
843</table>
844<a class="anchor" name="Ogre_1_1Texturea35" doxytag="Ogre::Resource::getSize" ></a><p>
845<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
846  <tr>
847    <td class="mdRow">
848      <table cellpadding="0" cellspacing="0" border="0">
849        <tr>
850          <td class="md" nowrap valign="top"> size_t Ogre::Resource::getSize </td>
851          <td class="md" valign="top">(&nbsp;</td>
852          <td class="md" nowrap valign="top">void&nbsp;</td>
853          <td class="mdname1" valign="top" nowrap>          </td>
854          <td class="md" valign="top">&nbsp;)&nbsp;</td>
855          <td class="md" nowrap> const</td>
856        </tr>
857
858      </table>
859    </td>
860  </tr>
861</table>
862<table cellspacing=5 cellpadding=0 border=0>
863  <tr>
864    <td>
865      &nbsp;
866    </td>
867    <td>
868
869<p>
870Retrieves info about the size of the resource.
871<p>
872
873<p>
874Definition 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>
875  </tr>
876</table>
877<a class="anchor" name="Ogre_1_1Texturea39" doxytag="Ogre::Resource::isLoaded" ></a><p>
878<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
879  <tr>
880    <td class="mdRow">
881      <table cellpadding="0" cellspacing="0" border="0">
882        <tr>
883          <td class="md" nowrap valign="top"> bool Ogre::Resource::isLoaded </td>
884          <td class="md" valign="top">(&nbsp;</td>
885          <td class="md" nowrap valign="top">void&nbsp;</td>
886          <td class="mdname1" valign="top" nowrap>          </td>
887          <td class="md" valign="top">&nbsp;)&nbsp;</td>
888          <td class="md" nowrap> const</td>
889        </tr>
890
891      </table>
892    </td>
893  </tr>
894</table>
895<table cellspacing=5 cellpadding=0 border=0>
896  <tr>
897    <td>
898      &nbsp;
899    </td>
900    <td>
901
902<p>
903Returns true if the <a class="el" href="classOgre_1_1Resource.html">Resource</a> has been loaded, false otherwise.
904<p>
905
906<p>
907Definition 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>.
908<p>
909References <a class="el" href="OgrePrerequisites_8h-source.html#l00173">OGRE_LOCK_AUTO_MUTEX</a>.    </td>
910  </tr>
911</table>
912<a class="anchor" name="Ogre_1_1Texturea33" doxytag="Ogre::Resource::isManuallyLoaded" ></a><p>
913<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
914  <tr>
915    <td class="mdRow">
916      <table cellpadding="0" cellspacing="0" border="0">
917        <tr>
918          <td class="md" nowrap valign="top"> bool Ogre::Resource::isManuallyLoaded </td>
919          <td class="md" valign="top">(&nbsp;</td>
920          <td class="md" nowrap valign="top">void&nbsp;</td>
921          <td class="mdname1" valign="top" nowrap>          </td>
922          <td class="md" valign="top">&nbsp;)&nbsp;</td>
923          <td class="md" nowrap> const</td>
924        </tr>
925
926      </table>
927    </td>
928  </tr>
929</table>
930<table cellspacing=5 cellpadding=0 border=0>
931  <tr>
932    <td>
933      &nbsp;
934    </td>
935    <td>
936
937<p>
938Is this resource manually loaded?
939<p>
940
941<p>
942Definition 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>
943  </tr>
944</table>
945<a class="anchor" name="Ogre_1_1Texturea32" doxytag="Ogre::Resource::isReloadable" ></a><p>
946<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
947  <tr>
948    <td class="mdRow">
949      <table cellpadding="0" cellspacing="0" border="0">
950        <tr>
951          <td class="md" nowrap valign="top"> bool Ogre::Resource::isReloadable </td>
952          <td class="md" valign="top">(&nbsp;</td>
953          <td class="md" nowrap valign="top">void&nbsp;</td>
954          <td class="mdname1" valign="top" nowrap>          </td>
955          <td class="md" valign="top">&nbsp;)&nbsp;</td>
956          <td class="md" nowrap> const</td>
957        </tr>
958
959      </table>
960    </td>
961  </tr>
962</table>
963<table cellspacing=5 cellpadding=0 border=0>
964  <tr>
965    <td>
966      &nbsp;
967    </td>
968    <td>
969
970<p>
971Returns true if the <a class="el" href="classOgre_1_1Resource.html">Resource</a> is reloadable, false otherwise.
972<p>
973
974<p>
975Definition 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>
976  </tr>
977</table>
978<a class="anchor" name="Ogre_1_1Texturea30" doxytag="Ogre::Resource::load" ></a><p>
979<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
980  <tr>
981    <td class="mdRow">
982      <table cellpadding="0" cellspacing="0" border="0">
983        <tr>
984          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::load </td>
985          <td class="md" valign="top">(&nbsp;</td>
986          <td class="md" nowrap valign="top">void&nbsp;</td>
987          <td class="mdname1" valign="top" nowrap>          </td>
988          <td class="md" valign="top">&nbsp;)&nbsp;</td>
989          <td class="md" nowrap><code> [virtual]</code></td>
990        </tr>
991
992      </table>
993    </td>
994  </tr>
995</table>
996<table cellspacing=5 cellpadding=0 border=0>
997  <tr>
998    <td>
999      &nbsp;
1000    </td>
1001    <td>
1002
1003<p>
1004Loads the resource, if it is not already.
1005<p>
1006<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>
1007
1008<p>
1009Reimplemented 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_1GLSLGpuPrograma8">Ogre::GLSLGpuProgram</a>.    </td>
1010  </tr>
1011</table>
1012<a class="anchor" name="Ogre_1_1Textureb5" doxytag="Ogre::Resource::loadImpl" ></a><p>
1013<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1014  <tr>
1015    <td class="mdRow">
1016      <table cellpadding="0" cellspacing="0" border="0">
1017        <tr>
1018          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::loadImpl </td>
1019          <td class="md" valign="top">(&nbsp;</td>
1020          <td class="md" nowrap valign="top">void&nbsp;</td>
1021          <td class="mdname1" valign="top" nowrap>          </td>
1022          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1023          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
1024        </tr>
1025
1026      </table>
1027    </td>
1028  </tr>
1029</table>
1030<table cellspacing=5 cellpadding=0 border=0>
1031  <tr>
1032    <td>
1033      &nbsp;
1034    </td>
1035    <td>
1036
1037<p>
1038Internal 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>.
1039<p>
1040
1041<p>
1042Implemented in <a class="el" href="classOgre_1_1Compositor.html#Ogre_1_1Compositorb0">Ogre::Compositor</a>, <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_1Materialb3">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_1D3D9GpuProgram.html#Ogre_1_1D3D9GpuVertexProgramb2">Ogre::D3D9GpuProgram</a>, <a class="el" href="classOgre_1_1D3D9Texture.html#Ogre_1_1D3D9Textureb17">Ogre::D3D9Texture</a>, and <a class="el" href="classOgre_1_1GLTexture.html#Ogre_1_1GLTextureb1">Ogre::GLTexture</a>.    </td>
1043  </tr>
1044</table>
1045<a class="anchor" name="Ogre_1_1Texturea31" doxytag="Ogre::Resource::reload" ></a><p>
1046<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1047  <tr>
1048    <td class="mdRow">
1049      <table cellpadding="0" cellspacing="0" border="0">
1050        <tr>
1051          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::reload </td>
1052          <td class="md" valign="top">(&nbsp;</td>
1053          <td class="md" nowrap valign="top">void&nbsp;</td>
1054          <td class="mdname1" valign="top" nowrap>          </td>
1055          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1056          <td class="md" nowrap><code> [virtual]</code></td>
1057        </tr>
1058
1059      </table>
1060    </td>
1061  </tr>
1062</table>
1063<table cellspacing=5 cellpadding=0 border=0>
1064  <tr>
1065    <td>
1066      &nbsp;
1067    </td>
1068    <td>
1069
1070<p>
1071Reloads the resource, if it is already loaded.
1072<p>
1073<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>
1074    </td>
1075  </tr>
1076</table>
1077<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::Resource::setParameter" ></a><p>
1078<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1079  <tr>
1080    <td class="mdRow">
1081      <table cellpadding="0" cellspacing="0" border="0">
1082        <tr>
1083          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
1084          <td class="md" valign="top">(&nbsp;</td>
1085          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
1086          <td class="mdname" nowrap> <em>name</em>, </td>
1087        </tr>
1088        <tr>
1089          <td class="md" nowrap align="right"></td>
1090          <td></td>
1091          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
1092          <td class="mdname" nowrap> <em>value</em></td>
1093        </tr>
1094        <tr>
1095          <td></td>
1096          <td class="md">)&nbsp;</td>
1097          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
1098        </tr>
1099
1100      </table>
1101    </td>
1102  </tr>
1103</table>
1104<table cellspacing=5 cellpadding=0 border=0>
1105  <tr>
1106    <td>
1107      &nbsp;
1108    </td>
1109    <td>
1110
1111<p>
1112Generic parameter setting method.
1113<p>
1114<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_1Texturea47">StringInterface::getParameters</a>. </dd></dl>
1115<dl compact><dt><b>Parameters:</b></dt><dd>
1116  <table border="0" cellspacing="2" cellpadding="0">
1117    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
1118    <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>
1119  </table>
1120</dl>
1121<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
1122
1123<p>
1124Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">Ogre::StringInterface::copyParametersTo()</a>.    </td>
1125  </tr>
1126</table>
1127<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::Resource::setParameterList" ></a><p>
1128<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1129  <tr>
1130    <td class="mdRow">
1131      <table cellpadding="0" cellspacing="0" border="0">
1132        <tr>
1133          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
1134          <td class="md" valign="top">(&nbsp;</td>
1135          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a76">NameValuePairList</a> &amp;&nbsp;</td>
1136          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
1137          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1138          <td class="md" nowrap><code> [virtual, inherited]</code></td>
1139        </tr>
1140
1141      </table>
1142    </td>
1143  </tr>
1144</table>
1145<table cellspacing=5 cellpadding=0 border=0>
1146  <tr>
1147    <td>
1148      &nbsp;
1149    </td>
1150    <td>
1151
1152<p>
1153Generic multiple parameter setting method.
1154<p>
1155<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_1Texturea47">StringInterface::getParameters</a>. </dd></dl>
1156<dl compact><dt><b>Parameters:</b></dt><dd>
1157  <table border="0" cellspacing="2" cellpadding="0">
1158    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
1159  </table>
1160</dl>
1161    </td>
1162  </tr>
1163</table>
1164<a class="anchor" name="Ogre_1_1Texturea36" doxytag="Ogre::Resource::touch" ></a><p>
1165<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1166  <tr>
1167    <td class="mdRow">
1168      <table cellpadding="0" cellspacing="0" border="0">
1169        <tr>
1170          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::touch </td>
1171          <td class="md" valign="top">(&nbsp;</td>
1172          <td class="md" nowrap valign="top">void&nbsp;</td>
1173          <td class="mdname1" valign="top" nowrap>          </td>
1174          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1175          <td class="md" nowrap><code> [virtual]</code></td>
1176        </tr>
1177
1178      </table>
1179    </td>
1180  </tr>
1181</table>
1182<table cellspacing=5 cellpadding=0 border=0>
1183  <tr>
1184    <td>
1185      &nbsp;
1186    </td>
1187    <td>
1188
1189<p>
1190'Touches' the resource to indicate it has been used.
1191<p>
1192
1193<p>
1194Reimplemented in <a class="el" href="classOgre_1_1Material.html#Ogre_1_1Materiala53">Ogre::Material</a>.    </td>
1195  </tr>
1196</table>
1197<a class="anchor" name="Ogre_1_1Texturea34" doxytag="Ogre::Resource::unload" ></a><p>
1198<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1199  <tr>
1200    <td class="mdRow">
1201      <table cellpadding="0" cellspacing="0" border="0">
1202        <tr>
1203          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::unload </td>
1204          <td class="md" valign="top">(&nbsp;</td>
1205          <td class="md" nowrap valign="top">void&nbsp;</td>
1206          <td class="mdname1" valign="top" nowrap>          </td>
1207          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1208          <td class="md" nowrap><code> [virtual]</code></td>
1209        </tr>
1210
1211      </table>
1212    </td>
1213  </tr>
1214</table>
1215<table cellspacing=5 cellpadding=0 border=0>
1216  <tr>
1217    <td>
1218      &nbsp;
1219    </td>
1220    <td>
1221
1222<p>
1223Unloads the resource; this is not permanent, the resource can be reloaded later if required.
1224<p>
1225
1226<p>
1227Reimplemented in <a class="el" href="classOgre_1_1GLSLGpuProgram.html#Ogre_1_1GLSLGpuPrograma2">Ogre::GLSLGpuProgram</a>.    </td>
1228  </tr>
1229</table>
1230<a class="anchor" name="Ogre_1_1Resourceb2" doxytag="Ogre::Resource::unloadImpl" ></a><p>
1231<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1232  <tr>
1233    <td class="mdRow">
1234      <table cellpadding="0" cellspacing="0" border="0">
1235        <tr>
1236          <td class="md" nowrap valign="top"> virtual void Ogre::Resource::unloadImpl </td>
1237          <td class="md" valign="top">(&nbsp;</td>
1238          <td class="md" nowrap valign="top">void&nbsp;</td>
1239          <td class="mdname1" valign="top" nowrap>          </td>
1240          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1241          <td class="md" nowrap><code> [protected, pure virtual]</code></td>
1242        </tr>
1243
1244      </table>
1245    </td>
1246  </tr>
1247</table>
1248<table cellspacing=5 cellpadding=0 border=0>
1249  <tr>
1250    <td>
1251      &nbsp;
1252    </td>
1253    <td>
1254
1255<p>
1256Internal 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>.
1257<p>
1258
1259<p>
1260Implemented in <a class="el" href="classOgre_1_1Compositor.html#Ogre_1_1Compositorb1">Ogre::Compositor</a>, <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_1Materialb4">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_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>
1261  </tr>
1262</table>
1263<hr><h2>Member Data Documentation</h2>
1264<a class="anchor" name="Ogre_1_1Texturep17" doxytag="Ogre::Resource::mCreator" ></a><p>
1265<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1266  <tr>
1267    <td class="mdRow">
1268      <table cellpadding="0" cellspacing="0" border="0">
1269        <tr>
1270          <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>
1271      </table>
1272    </td>
1273  </tr>
1274</table>
1275<table cellspacing=5 cellpadding=0 border=0>
1276  <tr>
1277    <td>
1278      &nbsp;
1279    </td>
1280    <td>
1281
1282<p>
1283Creator.
1284<p>
1285
1286<p>
1287Definition 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>
1288  </tr>
1289</table>
1290<a class="anchor" name="Ogre_1_1Texturep19" doxytag="Ogre::Resource::mGroup" ></a><p>
1291<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1292  <tr>
1293    <td class="mdRow">
1294      <table cellpadding="0" cellspacing="0" border="0">
1295        <tr>
1296          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep19">Ogre::Resource::mGroup</a><code> [protected]</code>
1297      </table>
1298    </td>
1299  </tr>
1300</table>
1301<table cellspacing=5 cellpadding=0 border=0>
1302  <tr>
1303    <td>
1304      &nbsp;
1305    </td>
1306    <td>
1307
1308<p>
1309The name of the resource group.
1310<p>
1311
1312<p>
1313Definition 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>
1314  </tr>
1315</table>
1316<a class="anchor" name="Ogre_1_1Texturep20" doxytag="Ogre::Resource::mHandle" ></a><p>
1317<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1318  <tr>
1319    <td class="mdRow">
1320      <table cellpadding="0" cellspacing="0" border="0">
1321        <tr>
1322          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a529">ResourceHandle</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep20">Ogre::Resource::mHandle</a><code> [protected]</code>
1323      </table>
1324    </td>
1325  </tr>
1326</table>
1327<table cellspacing=5 cellpadding=0 border=0>
1328  <tr>
1329    <td>
1330      &nbsp;
1331    </td>
1332    <td>
1333
1334<p>
1335Numeric handle for more efficient look up than name.
1336<p>
1337
1338<p>
1339Definition 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>
1340  </tr>
1341</table>
1342<a class="anchor" name="Ogre_1_1Texturep21" doxytag="Ogre::Resource::mIsLoaded" ></a><p>
1343<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1344  <tr>
1345    <td class="mdRow">
1346      <table cellpadding="0" cellspacing="0" border="0">
1347        <tr>
1348          <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>
1349      </table>
1350    </td>
1351  </tr>
1352</table>
1353<table cellspacing=5 cellpadding=0 border=0>
1354  <tr>
1355    <td>
1356      &nbsp;
1357    </td>
1358    <td>
1359
1360<p>
1361Is the resource currently loaded?
1362<p>
1363
1364<p>
1365Definition 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>
1366  </tr>
1367</table>
1368<a class="anchor" name="Ogre_1_1Texturep23" doxytag="Ogre::Resource::mIsManual" ></a><p>
1369<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1370  <tr>
1371    <td class="mdRow">
1372      <table cellpadding="0" cellspacing="0" border="0">
1373        <tr>
1374          <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>
1375      </table>
1376    </td>
1377  </tr>
1378</table>
1379<table cellspacing=5 cellpadding=0 border=0>
1380  <tr>
1381    <td>
1382      &nbsp;
1383    </td>
1384    <td>
1385
1386<p>
1387Is this file manually loaded?
1388<p>
1389
1390<p>
1391Definition 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>
1392  </tr>
1393</table>
1394<a class="anchor" name="Ogre_1_1Texturep25" doxytag="Ogre::Resource::mLoader" ></a><p>
1395<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1396  <tr>
1397    <td class="mdRow">
1398      <table cellpadding="0" cellspacing="0" border="0">
1399        <tr>
1400          <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>
1401      </table>
1402    </td>
1403  </tr>
1404</table>
1405<table cellspacing=5 cellpadding=0 border=0>
1406  <tr>
1407    <td>
1408      &nbsp;
1409    </td>
1410    <td>
1411
1412<p>
1413Optional manual loader; if provided, data is loaded from here instead of a file.
1414<p>
1415
1416<p>
1417Definition 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>
1418  </tr>
1419</table>
1420<a class="anchor" name="Ogre_1_1Texturep18" doxytag="Ogre::Resource::mName" ></a><p>
1421<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1422  <tr>
1423    <td class="mdRow">
1424      <table cellpadding="0" cellspacing="0" border="0">
1425        <tr>
1426          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep18">Ogre::Resource::mName</a><code> [protected]</code>
1427      </table>
1428    </td>
1429  </tr>
1430</table>
1431<table cellspacing=5 cellpadding=0 border=0>
1432  <tr>
1433    <td>
1434      &nbsp;
1435    </td>
1436    <td>
1437
1438<p>
1439Unique name of the resource.
1440<p>
1441
1442<p>
1443Definition 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>
1444  </tr>
1445</table>
1446<a class="anchor" name="Ogre_1_1Texturep24" doxytag="Ogre::Resource::mOrigin" ></a><p>
1447<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1448  <tr>
1449    <td class="mdRow">
1450      <table cellpadding="0" cellspacing="0" border="0">
1451        <tr>
1452          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Resource.html#Ogre_1_1Texturep24">Ogre::Resource::mOrigin</a><code> [protected]</code>
1453      </table>
1454    </td>
1455  </tr>
1456</table>
1457<table cellspacing=5 cellpadding=0 border=0>
1458  <tr>
1459    <td>
1460      &nbsp;
1461    </td>
1462    <td>
1463
1464<p>
1465Origin of this resource (e.g. script name) - optional.
1466<p>
1467
1468<p>
1469Definition 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>
1470  </tr>
1471</table>
1472<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::Resource::mParamDictName" ></a><p>
1473<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1474  <tr>
1475    <td class="mdRow">
1476      <table cellpadding="0" cellspacing="0" border="0">
1477        <tr>
1478          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected, inherited]</code>
1479      </table>
1480    </td>
1481  </tr>
1482</table>
1483<table cellspacing=5 cellpadding=0 border=0>
1484  <tr>
1485    <td>
1486      &nbsp;
1487    </td>
1488    <td>
1489
1490<p>
1491Class name for this instance to be used as a lookup (must be initialised by subclasses).
1492<p>
1493
1494<p>
1495Definition 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>
1496  </tr>
1497</table>
1498<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::Resource::msDictionary" ></a><p>
1499<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1500  <tr>
1501    <td class="mdRow">
1502      <table cellpadding="0" cellspacing="0" border="0">
1503        <tr>
1504          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a565">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected, inherited]</code>
1505      </table>
1506    </td>
1507  </tr>
1508</table>
1509<table cellspacing=5 cellpadding=0 border=0>
1510  <tr>
1511    <td>
1512      &nbsp;
1513    </td>
1514    <td>
1515
1516<p>
1517Dictionary of parameters.
1518<p>
1519
1520<p>
1521Definition 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>
1522  </tr>
1523</table>
1524<a class="anchor" name="Ogre_1_1Texturep22" doxytag="Ogre::Resource::mSize" ></a><p>
1525<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1526  <tr>
1527    <td class="mdRow">
1528      <table cellpadding="0" cellspacing="0" border="0">
1529        <tr>
1530          <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>
1531      </table>
1532    </td>
1533  </tr>
1534</table>
1535<table cellspacing=5 cellpadding=0 border=0>
1536  <tr>
1537    <td>
1538      &nbsp;
1539    </td>
1540    <td>
1541
1542<p>
1543The size of the resource in bytes.
1544<p>
1545
1546<p>
1547Definition 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>
1548  </tr>
1549</table>
1550<hr>The documentation for this class was generated from the following file:<ul>
1551<li><a class="el" href="OgreResource_8h-source.html">OgreResource.h</a></ul>
1552<hr>
1553<p>
1554Copyright &copy; 2000-2005 by The OGRE Team<br />
1555<!--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/>
1556This 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/>
1557                <!--/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#">
1558                <Work rdf:about="">
1559                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1560        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1561                </Work>
1562                <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> -->
1563
1564Last modified Sun Mar 12 14:42:35 2006
1565</p>
1566</body>
1567</html>
Note: See TracBrowser for help on using the repository browser.