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

Revision 692, 15.6 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreRibbonTrail.h Source File - 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>OgreRibbonTrail.h</h1><a href="OgreRibbonTrail_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">(Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025
3500026 <span class="preprocessor">#ifndef __RibbonTrail_H__</span>
3600027 <span class="preprocessor"></span><span class="preprocessor">#define __RibbonTrail_H__</span>
3700028 <span class="preprocessor"></span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030
4000031 <span class="preprocessor">#include "<a class="code" href="OgreBillboardChain_8h.html">OgreBillboardChain.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreNode_8h.html">OgreNode.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
4300034 <span class="preprocessor">#include "<a class="code" href="OgreFrameListener_8h.html">OgreFrameListener.h</a>"</span>
4400035 <span class="preprocessor">#include "<a class="code" href="OgreControllerManager_8h.html">OgreControllerManager.h</a>"</span>
4500036
4600037 <span class="keyword">namespace </span>Ogre {
4700038
48<a name="l00061"></a><a class="code" href="classOgre_1_1RibbonTrail.html">00061</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> RibbonTrail : <span class="keyword">public</span> <a class="code" href="classOgre_1_1BillboardChain.html">BillboardChain</a>, <span class="keyword">public</span> <a class="code" href="classOgre_1_1Node.html">Node</a>::Listener
4900062     {
5000063     <span class="keyword">public</span>:
5100073         RibbonTrail(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, size_t maxElements = 20, size_t numberOfChains = 1,
5200074             <span class="keywordtype">bool</span> useTextureCoords = <span class="keyword">true</span>, <span class="keywordtype">bool</span> useColours = <span class="keyword">true</span>);
5300076         <span class="keyword">virtual</span> ~RibbonTrail();
5400077
55<a name="l00078"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailw0">00078</a>         <span class="keyword">typedef</span> std::vector&lt;Node*&gt; <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailw0">NodeList</a>;
56<a name="l00079"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailw1">00079</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstVectorIterator.html">ConstVectorIterator&lt;NodeList&gt;</a> <a class="code" href="classOgre_1_1ConstVectorIterator.html">NodeIterator</a>;
5700080
5800084         <span class="keyword">virtual</span> <span class="keywordtype">void</span> addNode(<a class="code" href="classOgre_1_1Node.html">Node</a>* n);
5900086         <span class="keyword">virtual</span> <span class="keywordtype">void</span> removeNode(<a class="code" href="classOgre_1_1Node.html">Node</a>* n);
6000088         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1ConstVectorIterator.html">NodeIterator</a> getNodeIterator(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6100089
6200096         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTrailLength(<a class="code" href="namespaceOgre.html#a465">Real</a> len);
63<a name="l00098"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTraila6">00098</a>         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a465">Real</a> getTrailLength(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mTrailLength; }
6400099
6500101         <span class="keywordtype">void</span> setMaxChainElements(size_t maxElements);
6600103         <span class="keywordtype">void</span> setNumberOfChains(size_t numChains);
6700104
6800111         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setInitialColour(size_t chainIndex, <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; col);
6900118         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setInitialColour(size_t chainIndex, <a class="code" href="namespaceOgre.html#a465">Real</a> r, <a class="code" href="namespaceOgre.html#a465">Real</a> g, <a class="code" href="namespaceOgre.html#a465">Real</a> b, <a class="code" href="namespaceOgre.html#a465">Real</a> a = 1.0);
7000120         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; getInitialColour(size_t chainIndex) <span class="keyword">const</span>;
7100121
7200126         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setColourChange(size_t chainIndex, <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; valuePerSecond);
7300127
7400132         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setInitialWidth(size_t chainIndex, <a class="code" href="namespaceOgre.html#a465">Real</a> width);
7500134         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a465">Real</a> getInitialWidth(size_t chainIndex) <span class="keyword">const</span>;
7600135         
7700140         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setWidthChange(size_t chainIndex, <a class="code" href="namespaceOgre.html#a465">Real</a> widthDeltaPerSecond);
7800142         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a465">Real</a> getWidthChange(size_t chainIndex) <span class="keyword">const</span>;
7900143
8000148         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setColourChange(size_t chainIndex, <a class="code" href="namespaceOgre.html#a465">Real</a> r, <a class="code" href="namespaceOgre.html#a465">Real</a> g, <a class="code" href="namespaceOgre.html#a465">Real</a> b, <a class="code" href="namespaceOgre.html#a465">Real</a> a);
8100149
8200151         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; getColourChange(size_t chainIndex) <span class="keyword">const</span>;
8300152
8400154         <span class="keywordtype">void</span> nodeUpdated(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Node.html">Node</a>* node);
8500156         <span class="keywordtype">void</span> nodeDestroyed(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Node.html">Node</a>* node);
8600157
8700159         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _timeUpdate(<a class="code" href="namespaceOgre.html#a465">Real</a> time);
8800160
8900161     <span class="keyword">protected</span>:
90<a name="l00163"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp0">00163</a>         <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailw0">NodeList</a> mNodeList;
91<a name="l00165"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp1">00165</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mTrailLength;
92<a name="l00167"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp2">00167</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mElemLength;
93<a name="l00169"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp3">00169</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mSquaredElemLength;
94<a name="l00170"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx0">00170</a>         <span class="keyword">typedef</span> std::vector&lt;ColourValue&gt; <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx0">ColourValueList</a>;
95<a name="l00171"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx1">00171</a>         <span class="keyword">typedef</span> std::vector&lt;Real&gt; <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx1">RealList</a>;
96<a name="l00173"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp4">00173</a>         <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx0">ColourValueList</a> mInitialColour;
97<a name="l00175"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp5">00175</a>         <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx0">ColourValueList</a> mDeltaColour;
98<a name="l00177"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp6">00177</a>         <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx1">RealList</a> mInitialWidth;
99<a name="l00179"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp7">00179</a>         <a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailx1">RealList</a> mDeltaWidth;
100<a name="l00181"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp8">00181</a>         <a class="code" href="classOgre_1_1Controller.html">Controller&lt;Real&gt;</a>* mFadeController;
101<a name="l00183"></a><a class="code" href="classOgre_1_1RibbonTrail.html#Ogre_1_1RibbonTrailp9">00183</a>         <a class="code" href="classOgre_1_1SharedPtr.html">ControllerValueRealPtr</a> mTimeControllerValue;
10200184
10300186         <span class="keyword">virtual</span> <span class="keywordtype">void</span> manageController(<span class="keywordtype">void</span>);
10400188         <span class="keyword">virtual</span> <span class="keywordtype">void</span> updateTrail(size_t index, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Node.html">Node</a>* node);
10500189
10600190
10700191     };
10800192
10900193
110<a name="l00195"></a><a class="code" href="classOgre_1_1RibbonTrailFactory.html">00195</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> RibbonTrailFactory : <span class="keyword">public</span> <a class="code" href="classOgre_1_1MovableObjectFactory.html">MovableObjectFactory</a>
11100196     {
11200197     <span class="keyword">protected</span>:
11300198         <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* createInstanceImpl( <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a76">NameValuePairList</a>* params);
11400199     <span class="keyword">public</span>:
115<a name="l00200"></a><a class="code" href="classOgre_1_1RibbonTrailFactory.html#Ogre_1_1RibbonTrailFactorya0">00200</a>         RibbonTrailFactory() {}
116<a name="l00201"></a><a class="code" href="classOgre_1_1RibbonTrailFactory.html#Ogre_1_1RibbonTrailFactorya1">00201</a>         ~RibbonTrailFactory() {}
11700202
118<a name="l00203"></a><a class="code" href="classOgre_1_1RibbonTrailFactory.html#Ogre_1_1RibbonTrailFactorys0">00203</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a471">String</a> FACTORY_TYPE_NAME;
11900204
12000205         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12100206         <span class="keywordtype">void</span> destroyInstance( <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* obj); 
12200207
12300208     };
12400209
12500210 }
12600211
12700212 <span class="preprocessor">#endif</span>
128</pre></div><hr>
129<p>
130Copyright &copy; 2000-2005 by The OGRE Team<br />
131<!--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/>
132This 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/>
133                <!--/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#">
134                <Work rdf:about="">
135                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
136        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
137                </Work>
138                <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> -->
139
140Last modified Sun Mar 12 14:37:48 2006
141</p>
142</body>
143</html>
Note: See TracBrowser for help on using the repository browser.