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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreBillboard.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>OgreBillboard.h</h1><a href="OgreBillboard_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 __Billboard_H__</span>
3600027 <span class="preprocessor"></span><span class="preprocessor">#define __Billboard_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="OgreVector3_8h.html">OgreVector3.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreColourValue_8h.html">OgreColourValue.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreCommon_8h.html">OgreCommon.h</a>"</span>
4300034
4400035 <span class="keyword">namespace </span>Ogre {
4500036
46<a name="l00057"></a><a class="code" href="classOgre_1_1Billboard.html">00057</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Billboard
4700058     {
48<a name="l00059"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardn0">00059</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOgre_1_1BillboardSet.html">BillboardSet</a>;
49<a name="l00060"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardn1">00060</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOgre_1_1BillboardParticleRenderer.html">BillboardParticleRenderer</a>;
5000061     <span class="keyword">protected</span>:
51<a name="l00062"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardp0">00062</a>         <span class="keywordtype">bool</span> mOwnDimensions;
52<a name="l00063"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardp1">00063</a>         <span class="keywordtype">bool</span> mUseTexcoordRect;
53<a name="l00064"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardp2">00064</a>         <a class="code" href="namespaceOgre.html#a456">uint16</a> mTexcoordIndex;      <span class="comment">// index into the BillboardSet array of texture coordinates</span>
54<a name="l00065"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardp3">00065</a>         <a class="code" href="structOgre_1_1TRect.html">FloatRect</a> mTexcoordRect;    <span class="comment">// individual texture coordinates</span>
55<a name="l00066"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardp4">00066</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mWidth;
56<a name="l00067"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardp5">00067</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mHeight;
5700068     <span class="keyword">public</span>:
5800069         <span class="comment">// Note the intentional public access to main internal variables used at runtime</span>
5900070         <span class="comment">// Forcing access via get/set would be too costly for 000's of billboards</span>
60<a name="l00071"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardo0">00071</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mPosition;
6100072         <span class="comment">// Normalised direction vector</span>
62<a name="l00073"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardo1">00073</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDirection;
63<a name="l00074"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardo2">00074</a>         <a class="code" href="classOgre_1_1BillboardSet.html">BillboardSet</a>* mParentSet;
64<a name="l00075"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardo3">00075</a>         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> mColour;
65<a name="l00076"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboardo4">00076</a>         <a class="code" href="classOgre_1_1Radian.html">Radian</a> mRotation;
6600077
6700080         Billboard();
6800081
6900084         ~Billboard();
7000085
7100088         Billboard(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; position, <a class="code" href="classOgre_1_1BillboardSet.html">BillboardSet</a>* owner, <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour = ColourValue::White);
7200089
73<a name="l00094"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboarda3">00094</a>         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Radian.html">Radian</a>&amp; getRotation(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRotation; }
7400095
7500100         <span class="keywordtype">void</span> setRotation(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Radian.html">Radian</a>&amp; rotation);
7600101
7700107         <span class="keywordtype">void</span> setPosition(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; position);
7800108
7900114         <span class="keywordtype">void</span> setPosition(<a class="code" href="namespaceOgre.html#a465">Real</a> x, <a class="code" href="namespaceOgre.html#a465">Real</a> y, <a class="code" href="namespaceOgre.html#a465">Real</a> z);
8000115
8100121         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getPosition(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8200122
8300130         <span class="keywordtype">void</span> setDimensions(<a class="code" href="namespaceOgre.html#a465">Real</a> width, <a class="code" href="namespaceOgre.html#a465">Real</a> height);
8400131
85<a name="l00133"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboarda9">00133</a>         <span class="keywordtype">void</span> resetDimensions(<span class="keywordtype">void</span>) { mOwnDimensions = <span class="keyword">false</span>; }
8600140         <span class="keywordtype">void</span> setColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour);
8700141
8800144         <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; getColour(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8900145
9000151         <span class="keywordtype">bool</span> hasOwnDimensions(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9100152
9200154         <a class="code" href="namespaceOgre.html#a465">Real</a> getOwnWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9300155
9400157         <a class="code" href="namespaceOgre.html#a465">Real</a> getOwnHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9500158
9600161         <span class="keywordtype">void</span> _notifyOwner(<a class="code" href="classOgre_1_1BillboardSet.html">BillboardSet</a>* owner);
9700162
98<a name="l00172"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboarda16">00172</a>         <span class="keywordtype">bool</span> isUseTexcoordRect(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUseTexcoordRect; }
9900173
10000181         <span class="keywordtype">void</span> setTexcoordIndex(<a class="code" href="namespaceOgre.html#a456">uint16</a> texcoordIndex);
10100182
102<a name="l00188"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboarda18">00188</a>         <a class="code" href="namespaceOgre.html#a456">uint16</a> getTexcoordIndex(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mTexcoordIndex; }
10300189
10400195         <span class="keywordtype">void</span> setTexcoordRect(<span class="keyword">const</span> <a class="code" href="structOgre_1_1TRect.html">FloatRect</a>&amp; texcoordRect);
10500196
10600202         <span class="keywordtype">void</span> setTexcoordRect(<a class="code" href="namespaceOgre.html#a465">Real</a> u0, <a class="code" href="namespaceOgre.html#a465">Real</a> v0, <a class="code" href="namespaceOgre.html#a465">Real</a> u1, <a class="code" href="namespaceOgre.html#a465">Real</a> v1);
10700203
108<a name="l00208"></a><a class="code" href="classOgre_1_1Billboard.html#Ogre_1_1Billboarda21">00208</a>         <span class="keyword">const</span> <a class="code" href="structOgre_1_1TRect.html">FloatRect</a>&amp; getTexcoordRect(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mTexcoordRect; }
10900209     };
11000210
11100211 }
11200212
11300213 <span class="preprocessor">#endif</span>
114</pre></div><hr>
115<p>
116Copyright &copy; 2000-2005 by The OGRE Team<br />
117<!--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/>
118This 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/>
119                <!--/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#">
120                <Work rdf:about="">
121                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
122        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
123                </Work>
124                <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> -->
125
126Last modified Sun Mar 12 14:37:37 2006
127</p>
128</body>
129</html>
Note: See TracBrowser for help on using the repository browser.