[894] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
---|
| 3 | <title>GameTools Illumination Module: OgreRenderable Class Reference</title> |
---|
| 4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
| 5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
---|
| 6 | </head><body> |
---|
| 7 | <!-- Generated by Doxygen 1.4.6-NO --> |
---|
| 8 | <div class="tabs"> |
---|
| 9 | <ul> |
---|
| 10 | <li><a href="index.html"><span>Main Page</span></a></li> |
---|
| 11 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
---|
| 12 | <li id="current"><a href="annotated.html"><span>Classes</span></a></li> |
---|
| 13 | </ul></div> |
---|
| 14 | <div class="tabs"> |
---|
| 15 | <ul> |
---|
| 16 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
| 17 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
| 18 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
| 19 | </ul></div> |
---|
| 20 | <h1>OgreRenderable Class Reference</h1><!-- doxytag: class="OgreRenderable" --><!-- doxytag: inherits="ElementaryRenderable" -->Class to wrap different Ogre Renderable types. |
---|
| 21 | <a href="#_details">More...</a> |
---|
| 22 | <p> |
---|
| 23 | <p>Inheritance diagram for OgreRenderable: |
---|
| 24 | <p><center><img src="class_ogre_renderable.png" usemap="#OgreRenderable_map" border="0" alt=""></center> |
---|
| 25 | <map name="OgreRenderable_map"> |
---|
| 26 | <area href="class_elementary_renderable.html" alt="ElementaryRenderable" shape="rect" coords="0,0,140,24"> |
---|
| 27 | </map> |
---|
| 28 | <a href="class_ogre_renderable-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#e20235166bb34ab1f34775e6e6096189">OgreRenderable</a> (SubEntity *sube, Entity *<a class="el" href="class_ogre_renderable.html#8dad4181b2d91a3ec4699b9e60915f90">parentEntity</a>)</td></tr> |
---|
| 32 | |
---|
| 33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#e20235166bb34ab1f34775e6e6096189"></a><br></td></tr> |
---|
| 34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#ed97204e7dfd85bc4b02d54998392756">OgreRenderable</a> (Entity *<a class="el" href="class_ogre_renderable.html#8dad4181b2d91a3ec4699b9e60915f90">parentEntity</a>, int subEntityNum)</td></tr> |
---|
| 35 | |
---|
| 36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ed97204e7dfd85bc4b02d54998392756"></a><br></td></tr> |
---|
| 37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#a44d68886f0a3df83d73da54465664d8">OgreRenderable</a> (BillboardSet *billboardset)</td></tr> |
---|
| 38 | |
---|
| 39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a44d68886f0a3df83d73da54465664d8"></a><br></td></tr> |
---|
| 40 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54e376bde8f79aefd05b94f4919a0ada"></a><!-- doxytag: member="OgreRenderable::~OgreRenderable" ref="54e376bde8f79aefd05b94f4919a0ada" args="(void)" --> |
---|
| 41 | </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#54e376bde8f79aefd05b94f4919a0ada">~OgreRenderable</a> (void)</td></tr> |
---|
| 42 | |
---|
| 43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr> |
---|
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#95459c482dad92853c019386cd8acffa">setVisible</a> (bool visible)</td></tr> |
---|
| 45 | |
---|
| 46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the visibility of the wrapped renderable. <a href="#95459c482dad92853c019386cd8acffa"></a><br></td></tr> |
---|
| 47 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#e8b72fa34ff6142da63e93fcff922d59">setRenderGroup</a> (unsigned char groupID)</td></tr> |
---|
| 48 | |
---|
| 49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the rendergroup of the wrapped renderable. <a href="#e8b72fa34ff6142da63e93fcff922d59"></a><br></td></tr> |
---|
| 50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6bceed861c03085f1374b3fdb84c986"></a><!-- doxytag: member="OgreRenderable::isVisible" ref="e6bceed861c03085f1374b3fdb84c986" args="()" --> |
---|
| 51 | bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#e6bceed861c03085f1374b3fdb84c986">isVisible</a> ()</td></tr> |
---|
| 52 | |
---|
| 53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves if the renderable is hided or shown. <br></td></tr> |
---|
| 54 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#94a937f4240058e8ada8399777f71a96">setMaterialName</a> (String &<a class="el" href="class_ogre_renderable.html#88a66bea6e19a113d61d85f753bb62b4">name</a>)</td></tr> |
---|
| 55 | |
---|
| 56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the material to be used by the renderable. <a href="#94a937f4240058e8ada8399777f71a96"></a><br></td></tr> |
---|
| 57 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const MaterialPtr & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#f0e26ef78b32e498eac14aae2e9f2c10">getMaterialPtr</a> ()</td></tr> |
---|
| 58 | |
---|
| 59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a resource pointer to the material used by the renderable. <a href="#f0e26ef78b32e498eac14aae2e9f2c10"></a><br></td></tr> |
---|
| 60 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const String & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#9a6dbd0c76464dc1b7eda671be34f5e7">getMaterialName</a> ()</td></tr> |
---|
| 61 | |
---|
| 62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of the material used by the renderable. <a href="#9a6dbd0c76464dc1b7eda671be34f5e7"></a><br></td></tr> |
---|
| 63 | <tr><td class="memItemLeft" nowrap align="right" valign="top">Material * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#21a55537d5387b1c77ea74560e4986ac">getMaterial</a> ()</td></tr> |
---|
| 64 | |
---|
| 65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a pointer to the material used by the renderable. <a href="#21a55537d5387b1c77ea74560e4986ac"></a><br></td></tr> |
---|
| 66 | <tr><td class="memItemLeft" nowrap align="right" valign="top">AxisAlignedBox & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#be8fd6cb4d5fee7fd657b4ba6fb24f1e">getBoundingBox</a> ()</td></tr> |
---|
| 67 | |
---|
| 68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the axis-aligned bouding box of the renderable. <a href="#be8fd6cb4d5fee7fd657b4ba6fb24f1e"></a><br></td></tr> |
---|
| 69 | <tr><td class="memItemLeft" nowrap align="right" valign="top">Sphere & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#70352e10e1662408fc55aa7b6d0cac73">getBoundingSphere</a> ()</td></tr> |
---|
| 70 | |
---|
| 71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the bouding sphere of the renderable. <a href="#70352e10e1662408fc55aa7b6d0cac73"></a><br></td></tr> |
---|
| 72 | <tr><td class="memItemLeft" nowrap align="right" valign="top">String & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#4912fda0214eca227407f3a19b6060dc">getName</a> ()</td></tr> |
---|
| 73 | |
---|
| 74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the unique name assigned to the renderable. <a href="#4912fda0214eca227407f3a19b6060dc"></a><br></td></tr> |
---|
| 75 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ffefd76294633f050ef1a76ac439df3"></a><!-- doxytag: member="OgreRenderable::updateBounds" ref="3ffefd76294633f050ef1a76ac439df3" args="()" --> |
---|
| 76 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#3ffefd76294633f050ef1a76ac439df3">updateBounds</a> ()</td></tr> |
---|
| 77 | |
---|
| 78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates bounding volumes. <br></td></tr> |
---|
| 79 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#85979edec035c6d5302984f0b0aa4586">notifyCamera</a> (Camera *cam)</td></tr> |
---|
| 80 | |
---|
| 81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls notifyCamera for the wrapped Renderable. <a href="#85979edec035c6d5302984f0b0aa4586"></a><br></td></tr> |
---|
| 82 | <tr><td class="memItemLeft" nowrap align="right" valign="top">Renderable * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#1aaac43ea55c0af68cb3851071ad8388">getRenderable</a> ()</td></tr> |
---|
| 83 | |
---|
| 84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the wrapped Renderable. <a href="#1aaac43ea55c0af68cb3851071ad8388"></a><br></td></tr> |
---|
| 85 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
| 86 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="88a66bea6e19a113d61d85f753bb62b4"></a><!-- doxytag: member="OgreRenderable::name" ref="88a66bea6e19a113d61d85f753bb62b4" args="" --> |
---|
| 87 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#88a66bea6e19a113d61d85f753bb62b4">name</a></td></tr> |
---|
| 88 | |
---|
| 89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">unique name assigned to the renderable <br></td></tr> |
---|
| 90 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8dad4181b2d91a3ec4699b9e60915f90"></a><!-- doxytag: member="OgreRenderable::parentEntity" ref="8dad4181b2d91a3ec4699b9e60915f90" args="" --> |
---|
| 91 | Entity * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#8dad4181b2d91a3ec4699b9e60915f90">parentEntity</a></td></tr> |
---|
| 92 | |
---|
| 93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the parent Entity if the renderable is a Subentity <br></td></tr> |
---|
| 94 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6eddc364402ba8cd509ff14c1f565130"></a><!-- doxytag: member="OgreRenderable::subEntityRenderable" ref="6eddc364402ba8cd509ff14c1f565130" args="" --> |
---|
| 95 | SubEntity * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#6eddc364402ba8cd509ff14c1f565130">subEntityRenderable</a></td></tr> |
---|
| 96 | |
---|
| 97 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the wrapped Subentity (if the renderable is a Subentity) <br></td></tr> |
---|
| 98 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72cebea74bee7e713235a0f09eb4b2f8"></a><!-- doxytag: member="OgreRenderable::billboardSetRenderable" ref="72cebea74bee7e713235a0f09eb4b2f8" args="" --> |
---|
| 99 | BillboardSet * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#72cebea74bee7e713235a0f09eb4b2f8">billboardSetRenderable</a></td></tr> |
---|
| 100 | |
---|
| 101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the wrapped BillboardSet (if the renderable is a BillboardSet) <br></td></tr> |
---|
| 102 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2ee31fdfb73e5f910709bd01d60dfa7"></a><!-- doxytag: member="OgreRenderable::boundingBox" ref="e2ee31fdfb73e5f910709bd01d60dfa7" args="" --> |
---|
| 103 | AxisAlignedBox </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#e2ee31fdfb73e5f910709bd01d60dfa7">boundingBox</a></td></tr> |
---|
| 104 | |
---|
| 105 | <tr><td class="mdescLeft"> </td><td class="mdescRight">axis-aligned bounding box of the wrapped renderable in world space <br></td></tr> |
---|
| 106 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dbfa21532e1d9b6cd184b4890d41456"></a><!-- doxytag: member="OgreRenderable::boundingSphere" ref="9dbfa21532e1d9b6cd184b4890d41456" args="" --> |
---|
| 107 | Sphere </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#9dbfa21532e1d9b6cd184b4890d41456">boundingSphere</a></td></tr> |
---|
| 108 | |
---|
| 109 | <tr><td class="mdescLeft"> </td><td class="mdescRight">bounding sphere of the wrapped renderable in world space <br></td></tr> |
---|
| 110 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d69bb53c11293677ef29d415ac10330"></a><!-- doxytag: member="OgreRenderable::renderableType" ref="2d69bb53c11293677ef29d415ac10330" args="" --> |
---|
| 111 | Ogre_RenderableType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_renderable.html#2d69bb53c11293677ef29d415ac10330">renderableType</a></td></tr> |
---|
| 112 | |
---|
| 113 | <tr><td class="mdescLeft"> </td><td class="mdescRight">type of the renderable (see Ogre_RenderableType) <br></td></tr> |
---|
| 114 | </table> |
---|
| 115 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 116 | Class to wrap different Ogre Renderable types. |
---|
| 117 | <p> |
---|
| 118 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 119 | <a class="anchor" name="e20235166bb34ab1f34775e6e6096189"></a><!-- doxytag: member="OgreRenderable::OgreRenderable" ref="e20235166bb34ab1f34775e6e6096189" args="(SubEntity *sube, Entity *parentEntity)" --><p> |
---|
| 120 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 121 | <tr> |
---|
| 122 | <td class="mdRow"> |
---|
| 123 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 124 | <tr> |
---|
| 125 | <td class="md" nowrap valign="top">OgreRenderable::OgreRenderable </td> |
---|
| 126 | <td class="md" valign="top">( </td> |
---|
| 127 | <td class="md" nowrap valign="top">SubEntity * </td> |
---|
| 128 | <td class="mdname" nowrap> <em>sube</em>, </td> |
---|
| 129 | </tr> |
---|
| 130 | <tr> |
---|
| 131 | <td class="md" nowrap align="right"></td> |
---|
| 132 | <td class="md"></td> |
---|
| 133 | <td class="md" nowrap>Entity * </td> |
---|
| 134 | <td class="mdname" nowrap> <em>parentEntity</em></td> |
---|
| 135 | </tr> |
---|
| 136 | <tr> |
---|
| 137 | <td class="md"></td> |
---|
| 138 | <td class="md">) </td> |
---|
| 139 | <td class="md" colspan="2"></td> |
---|
| 140 | </tr> |
---|
| 141 | </table> |
---|
| 142 | </td> |
---|
| 143 | </tr> |
---|
| 144 | </table> |
---|
| 145 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 146 | <tr> |
---|
| 147 | <td> |
---|
| 148 | |
---|
| 149 | </td> |
---|
| 150 | <td> |
---|
| 151 | |
---|
| 152 | <p> |
---|
| 153 | Constructor. |
---|
| 154 | <p> |
---|
| 155 | Creates an <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> from a SubEntity of an Entity.<p> |
---|
| 156 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 157 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 158 | <tr><td valign="top"></td><td valign="top"><em>sube</em> </td><td>the subentity to wrap </td></tr> |
---|
| 159 | <tr><td valign="top"></td><td valign="top"><em>parentEntity</em> </td><td>the parent of the wrapped subentity </td></tr> |
---|
| 160 | </table> |
---|
| 161 | </dl> |
---|
| 162 | </td> |
---|
| 163 | </tr> |
---|
| 164 | </table> |
---|
| 165 | <a class="anchor" name="ed97204e7dfd85bc4b02d54998392756"></a><!-- doxytag: member="OgreRenderable::OgreRenderable" ref="ed97204e7dfd85bc4b02d54998392756" args="(Entity *parentEntity, int subEntityNum)" --><p> |
---|
| 166 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 167 | <tr> |
---|
| 168 | <td class="mdRow"> |
---|
| 169 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 170 | <tr> |
---|
| 171 | <td class="md" nowrap valign="top">OgreRenderable::OgreRenderable </td> |
---|
| 172 | <td class="md" valign="top">( </td> |
---|
| 173 | <td class="md" nowrap valign="top">Entity * </td> |
---|
| 174 | <td class="mdname" nowrap> <em>parentEntity</em>, </td> |
---|
| 175 | </tr> |
---|
| 176 | <tr> |
---|
| 177 | <td class="md" nowrap align="right"></td> |
---|
| 178 | <td class="md"></td> |
---|
| 179 | <td class="md" nowrap>int </td> |
---|
| 180 | <td class="mdname" nowrap> <em>subEntityNum</em></td> |
---|
| 181 | </tr> |
---|
| 182 | <tr> |
---|
| 183 | <td class="md"></td> |
---|
| 184 | <td class="md">) </td> |
---|
| 185 | <td class="md" colspan="2"></td> |
---|
| 186 | </tr> |
---|
| 187 | </table> |
---|
| 188 | </td> |
---|
| 189 | </tr> |
---|
| 190 | </table> |
---|
| 191 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 192 | <tr> |
---|
| 193 | <td> |
---|
| 194 | |
---|
| 195 | </td> |
---|
| 196 | <td> |
---|
| 197 | |
---|
| 198 | <p> |
---|
| 199 | Constructor. |
---|
| 200 | <p> |
---|
| 201 | Creates an <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> from a SubEntity of an Entity.<p> |
---|
| 202 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 203 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 204 | <tr><td valign="top"></td><td valign="top"><em>parentEntity</em> </td><td>the parent of the wrapped subentity </td></tr> |
---|
| 205 | <tr><td valign="top"></td><td valign="top"><em>subEntityNum</em> </td><td>the number of the subentity to wrap </td></tr> |
---|
| 206 | </table> |
---|
| 207 | </dl> |
---|
| 208 | </td> |
---|
| 209 | </tr> |
---|
| 210 | </table> |
---|
| 211 | <a class="anchor" name="a44d68886f0a3df83d73da54465664d8"></a><!-- doxytag: member="OgreRenderable::OgreRenderable" ref="a44d68886f0a3df83d73da54465664d8" args="(BillboardSet *billboardset)" --><p> |
---|
| 212 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 213 | <tr> |
---|
| 214 | <td class="mdRow"> |
---|
| 215 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 216 | <tr> |
---|
| 217 | <td class="md" nowrap valign="top">OgreRenderable::OgreRenderable </td> |
---|
| 218 | <td class="md" valign="top">( </td> |
---|
| 219 | <td class="md" nowrap valign="top">BillboardSet * </td> |
---|
| 220 | <td class="mdname1" valign="top" nowrap> <em>billboardset</em> </td> |
---|
| 221 | <td class="md" valign="top"> ) </td> |
---|
| 222 | <td class="md" nowrap></td> |
---|
| 223 | </tr> |
---|
| 224 | </table> |
---|
| 225 | </td> |
---|
| 226 | </tr> |
---|
| 227 | </table> |
---|
| 228 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 229 | <tr> |
---|
| 230 | <td> |
---|
| 231 | |
---|
| 232 | </td> |
---|
| 233 | <td> |
---|
| 234 | |
---|
| 235 | <p> |
---|
| 236 | Constructor. |
---|
| 237 | <p> |
---|
| 238 | Creates an <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> from a SubEntity of a BillboardSet.<p> |
---|
| 239 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 240 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 241 | <tr><td valign="top"></td><td valign="top"><em>billboardset</em> </td><td>the BillboardSet to wrap </td></tr> |
---|
| 242 | </table> |
---|
| 243 | </dl> |
---|
| 244 | </td> |
---|
| 245 | </tr> |
---|
| 246 | </table> |
---|
| 247 | <hr><h2>Member Function Documentation</h2> |
---|
| 248 | <a class="anchor" name="be8fd6cb4d5fee7fd657b4ba6fb24f1e"></a><!-- doxytag: member="OgreRenderable::getBoundingBox" ref="be8fd6cb4d5fee7fd657b4ba6fb24f1e" args="()" --><p> |
---|
| 249 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 250 | <tr> |
---|
| 251 | <td class="mdRow"> |
---|
| 252 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 253 | <tr> |
---|
| 254 | <td class="md" nowrap valign="top">AxisAlignedBox& OgreRenderable::getBoundingBox </td> |
---|
| 255 | <td class="md" valign="top">( </td> |
---|
| 256 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 257 | <td class="md" valign="top"> ) </td> |
---|
| 258 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 259 | </tr> |
---|
| 260 | </table> |
---|
| 261 | </td> |
---|
| 262 | </tr> |
---|
| 263 | </table> |
---|
| 264 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 265 | <tr> |
---|
| 266 | <td> |
---|
| 267 | |
---|
| 268 | </td> |
---|
| 269 | <td> |
---|
| 270 | |
---|
| 271 | <p> |
---|
| 272 | Retrieves the axis-aligned bouding box of the renderable. |
---|
| 273 | <p> |
---|
| 274 | <dl compact><dt><b>Returns:</b></dt><dd>reference to the bouding box </dd></dl> |
---|
| 275 | </td> |
---|
| 276 | </tr> |
---|
| 277 | </table> |
---|
| 278 | <a class="anchor" name="70352e10e1662408fc55aa7b6d0cac73"></a><!-- doxytag: member="OgreRenderable::getBoundingSphere" ref="70352e10e1662408fc55aa7b6d0cac73" args="()" --><p> |
---|
| 279 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 280 | <tr> |
---|
| 281 | <td class="mdRow"> |
---|
| 282 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 283 | <tr> |
---|
| 284 | <td class="md" nowrap valign="top">Sphere& OgreRenderable::getBoundingSphere </td> |
---|
| 285 | <td class="md" valign="top">( </td> |
---|
| 286 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 287 | <td class="md" valign="top"> ) </td> |
---|
| 288 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 289 | </tr> |
---|
| 290 | </table> |
---|
| 291 | </td> |
---|
| 292 | </tr> |
---|
| 293 | </table> |
---|
| 294 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 295 | <tr> |
---|
| 296 | <td> |
---|
| 297 | |
---|
| 298 | </td> |
---|
| 299 | <td> |
---|
| 300 | |
---|
| 301 | <p> |
---|
| 302 | Retrieves the bouding sphere of the renderable. |
---|
| 303 | <p> |
---|
| 304 | <dl compact><dt><b>Returns:</b></dt><dd>reference to the bouding sphere </dd></dl> |
---|
| 305 | </td> |
---|
| 306 | </tr> |
---|
| 307 | </table> |
---|
| 308 | <a class="anchor" name="21a55537d5387b1c77ea74560e4986ac"></a><!-- doxytag: member="OgreRenderable::getMaterial" ref="21a55537d5387b1c77ea74560e4986ac" args="()" --><p> |
---|
| 309 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 310 | <tr> |
---|
| 311 | <td class="mdRow"> |
---|
| 312 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 313 | <tr> |
---|
| 314 | <td class="md" nowrap valign="top">Material* OgreRenderable::getMaterial </td> |
---|
| 315 | <td class="md" valign="top">( </td> |
---|
| 316 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 317 | <td class="md" valign="top"> ) </td> |
---|
| 318 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 319 | </tr> |
---|
| 320 | </table> |
---|
| 321 | </td> |
---|
| 322 | </tr> |
---|
| 323 | </table> |
---|
| 324 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 325 | <tr> |
---|
| 326 | <td> |
---|
| 327 | |
---|
| 328 | </td> |
---|
| 329 | <td> |
---|
| 330 | |
---|
| 331 | <p> |
---|
| 332 | Retrieves a pointer to the material used by the renderable. |
---|
| 333 | <p> |
---|
| 334 | <dl compact><dt><b>Returns:</b></dt><dd>reference to the Material pointer </dd></dl> |
---|
| 335 | </td> |
---|
| 336 | </tr> |
---|
| 337 | </table> |
---|
| 338 | <a class="anchor" name="9a6dbd0c76464dc1b7eda671be34f5e7"></a><!-- doxytag: member="OgreRenderable::getMaterialName" ref="9a6dbd0c76464dc1b7eda671be34f5e7" args="()" --><p> |
---|
| 339 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 340 | <tr> |
---|
| 341 | <td class="mdRow"> |
---|
| 342 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 343 | <tr> |
---|
| 344 | <td class="md" nowrap valign="top">const String& OgreRenderable::getMaterialName </td> |
---|
| 345 | <td class="md" valign="top">( </td> |
---|
| 346 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 347 | <td class="md" valign="top"> ) </td> |
---|
| 348 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 349 | </tr> |
---|
| 350 | </table> |
---|
| 351 | </td> |
---|
| 352 | </tr> |
---|
| 353 | </table> |
---|
| 354 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 355 | <tr> |
---|
| 356 | <td> |
---|
| 357 | |
---|
| 358 | </td> |
---|
| 359 | <td> |
---|
| 360 | |
---|
| 361 | <p> |
---|
| 362 | Retrieves the name of the material used by the renderable. |
---|
| 363 | <p> |
---|
| 364 | <dl compact><dt><b>Returns:</b></dt><dd>reference to the name of the material </dd></dl> |
---|
| 365 | </td> |
---|
| 366 | </tr> |
---|
| 367 | </table> |
---|
| 368 | <a class="anchor" name="f0e26ef78b32e498eac14aae2e9f2c10"></a><!-- doxytag: member="OgreRenderable::getMaterialPtr" ref="f0e26ef78b32e498eac14aae2e9f2c10" args="()" --><p> |
---|
| 369 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 370 | <tr> |
---|
| 371 | <td class="mdRow"> |
---|
| 372 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 373 | <tr> |
---|
| 374 | <td class="md" nowrap valign="top">const MaterialPtr & OgreRenderable::getMaterialPtr </td> |
---|
| 375 | <td class="md" valign="top">( </td> |
---|
| 376 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 377 | <td class="md" valign="top"> ) </td> |
---|
| 378 | <td class="md" nowrap></td> |
---|
| 379 | </tr> |
---|
| 380 | </table> |
---|
| 381 | </td> |
---|
| 382 | </tr> |
---|
| 383 | </table> |
---|
| 384 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 385 | <tr> |
---|
| 386 | <td> |
---|
| 387 | |
---|
| 388 | </td> |
---|
| 389 | <td> |
---|
| 390 | |
---|
| 391 | <p> |
---|
| 392 | Retrieves a resource pointer to the material used by the renderable. |
---|
| 393 | <p> |
---|
| 394 | <dl compact><dt><b>Returns:</b></dt><dd>reference to the resource pointer </dd></dl> |
---|
| 395 | </td> |
---|
| 396 | </tr> |
---|
| 397 | </table> |
---|
| 398 | <a class="anchor" name="4912fda0214eca227407f3a19b6060dc"></a><!-- doxytag: member="OgreRenderable::getName" ref="4912fda0214eca227407f3a19b6060dc" args="()" --><p> |
---|
| 399 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 400 | <tr> |
---|
| 401 | <td class="mdRow"> |
---|
| 402 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 403 | <tr> |
---|
| 404 | <td class="md" nowrap valign="top">String& OgreRenderable::getName </td> |
---|
| 405 | <td class="md" valign="top">( </td> |
---|
| 406 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 407 | <td class="md" valign="top"> ) </td> |
---|
| 408 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 409 | </tr> |
---|
| 410 | </table> |
---|
| 411 | </td> |
---|
| 412 | </tr> |
---|
| 413 | </table> |
---|
| 414 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 415 | <tr> |
---|
| 416 | <td> |
---|
| 417 | |
---|
| 418 | </td> |
---|
| 419 | <td> |
---|
| 420 | |
---|
| 421 | <p> |
---|
| 422 | Retrieves the unique name assigned to the renderable. |
---|
| 423 | <p> |
---|
| 424 | <dl compact><dt><b>Returns:</b></dt><dd>reference to name of the renderable </dd></dl> |
---|
| 425 | </td> |
---|
| 426 | </tr> |
---|
| 427 | </table> |
---|
| 428 | <a class="anchor" name="1aaac43ea55c0af68cb3851071ad8388"></a><!-- doxytag: member="OgreRenderable::getRenderable" ref="1aaac43ea55c0af68cb3851071ad8388" args="()" --><p> |
---|
| 429 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 430 | <tr> |
---|
| 431 | <td class="mdRow"> |
---|
| 432 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 433 | <tr> |
---|
| 434 | <td class="md" nowrap valign="top">Renderable * OgreRenderable::getRenderable </td> |
---|
| 435 | <td class="md" valign="top">( </td> |
---|
| 436 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 437 | <td class="md" valign="top"> ) </td> |
---|
| 438 | <td class="md" nowrap></td> |
---|
| 439 | </tr> |
---|
| 440 | </table> |
---|
| 441 | </td> |
---|
| 442 | </tr> |
---|
| 443 | </table> |
---|
| 444 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 445 | <tr> |
---|
| 446 | <td> |
---|
| 447 | |
---|
| 448 | </td> |
---|
| 449 | <td> |
---|
| 450 | |
---|
| 451 | <p> |
---|
| 452 | Returns the wrapped Renderable. |
---|
| 453 | <p> |
---|
| 454 | <dl compact><dt><b>Returns:</b></dt><dd>pointer to the wrapped Renderable </dd></dl> |
---|
| 455 | </td> |
---|
| 456 | </tr> |
---|
| 457 | </table> |
---|
| 458 | <a class="anchor" name="85979edec035c6d5302984f0b0aa4586"></a><!-- doxytag: member="OgreRenderable::notifyCamera" ref="85979edec035c6d5302984f0b0aa4586" args="(Camera *cam)" --><p> |
---|
| 459 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 460 | <tr> |
---|
| 461 | <td class="mdRow"> |
---|
| 462 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 463 | <tr> |
---|
| 464 | <td class="md" nowrap valign="top">void OgreRenderable::notifyCamera </td> |
---|
| 465 | <td class="md" valign="top">( </td> |
---|
| 466 | <td class="md" nowrap valign="top">Camera * </td> |
---|
| 467 | <td class="mdname1" valign="top" nowrap> <em>cam</em> </td> |
---|
| 468 | <td class="md" valign="top"> ) </td> |
---|
| 469 | <td class="md" nowrap></td> |
---|
| 470 | </tr> |
---|
| 471 | </table> |
---|
| 472 | </td> |
---|
| 473 | </tr> |
---|
| 474 | </table> |
---|
| 475 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 476 | <tr> |
---|
| 477 | <td> |
---|
| 478 | |
---|
| 479 | </td> |
---|
| 480 | <td> |
---|
| 481 | |
---|
| 482 | <p> |
---|
| 483 | Calls notifyCamera for the wrapped Renderable. |
---|
| 484 | <p> |
---|
| 485 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 486 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 487 | <tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>to the Camera to pass to <a class="el" href="class_ogre_renderable.html#85979edec035c6d5302984f0b0aa4586">notifyCamera()</a> </td></tr> |
---|
| 488 | </table> |
---|
| 489 | </dl> |
---|
| 490 | </td> |
---|
| 491 | </tr> |
---|
| 492 | </table> |
---|
| 493 | <a class="anchor" name="94a937f4240058e8ada8399777f71a96"></a><!-- doxytag: member="OgreRenderable::setMaterialName" ref="94a937f4240058e8ada8399777f71a96" args="(String &name)" --><p> |
---|
| 494 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 495 | <tr> |
---|
| 496 | <td class="mdRow"> |
---|
| 497 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 498 | <tr> |
---|
| 499 | <td class="md" nowrap valign="top">void OgreRenderable::setMaterialName </td> |
---|
| 500 | <td class="md" valign="top">( </td> |
---|
| 501 | <td class="md" nowrap valign="top">String & </td> |
---|
| 502 | <td class="mdname1" valign="top" nowrap> <em>name</em> </td> |
---|
| 503 | <td class="md" valign="top"> ) </td> |
---|
| 504 | <td class="md" nowrap></td> |
---|
| 505 | </tr> |
---|
| 506 | </table> |
---|
| 507 | </td> |
---|
| 508 | </tr> |
---|
| 509 | </table> |
---|
| 510 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 511 | <tr> |
---|
| 512 | <td> |
---|
| 513 | |
---|
| 514 | </td> |
---|
| 515 | <td> |
---|
| 516 | |
---|
| 517 | <p> |
---|
| 518 | Sets the material to be used by the renderable. |
---|
| 519 | <p> |
---|
| 520 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 521 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 522 | <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the material to use </td></tr> |
---|
| 523 | </table> |
---|
| 524 | </dl> |
---|
| 525 | </td> |
---|
| 526 | </tr> |
---|
| 527 | </table> |
---|
| 528 | <a class="anchor" name="e8b72fa34ff6142da63e93fcff922d59"></a><!-- doxytag: member="OgreRenderable::setRenderGroup" ref="e8b72fa34ff6142da63e93fcff922d59" args="(unsigned char groupID)" --><p> |
---|
| 529 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 530 | <tr> |
---|
| 531 | <td class="mdRow"> |
---|
| 532 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 533 | <tr> |
---|
| 534 | <td class="md" nowrap valign="top">void OgreRenderable::setRenderGroup </td> |
---|
| 535 | <td class="md" valign="top">( </td> |
---|
| 536 | <td class="md" nowrap valign="top">unsigned char </td> |
---|
| 537 | <td class="mdname1" valign="top" nowrap> <em>groupID</em> </td> |
---|
| 538 | <td class="md" valign="top"> ) </td> |
---|
| 539 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 540 | </tr> |
---|
| 541 | </table> |
---|
| 542 | </td> |
---|
| 543 | </tr> |
---|
| 544 | </table> |
---|
| 545 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 546 | <tr> |
---|
| 547 | <td> |
---|
| 548 | |
---|
| 549 | </td> |
---|
| 550 | <td> |
---|
| 551 | |
---|
| 552 | <p> |
---|
| 553 | Sets the rendergroup of the wrapped renderable. |
---|
| 554 | <p> |
---|
| 555 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 556 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 557 | <tr><td valign="top"></td><td valign="top"><em>groupID</em> </td><td>the ID of the group to use </td></tr> |
---|
| 558 | </table> |
---|
| 559 | </dl> |
---|
| 560 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_elementary_renderable.html#4368eba8bcf6560d5e6b284acddc4799">ElementaryRenderable::setRenderGroup()</a> </dd></dl> |
---|
| 561 | |
---|
| 562 | <p> |
---|
| 563 | Implements <a class="el" href="class_elementary_renderable.html#4368eba8bcf6560d5e6b284acddc4799">ElementaryRenderable</a>. </td> |
---|
| 564 | </tr> |
---|
| 565 | </table> |
---|
| 566 | <a class="anchor" name="95459c482dad92853c019386cd8acffa"></a><!-- doxytag: member="OgreRenderable::setVisible" ref="95459c482dad92853c019386cd8acffa" args="(bool visible)" --><p> |
---|
| 567 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 568 | <tr> |
---|
| 569 | <td class="mdRow"> |
---|
| 570 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 571 | <tr> |
---|
| 572 | <td class="md" nowrap valign="top">void OgreRenderable::setVisible </td> |
---|
| 573 | <td class="md" valign="top">( </td> |
---|
| 574 | <td class="md" nowrap valign="top">bool </td> |
---|
| 575 | <td class="mdname1" valign="top" nowrap> <em>visible</em> </td> |
---|
| 576 | <td class="md" valign="top"> ) </td> |
---|
| 577 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 578 | </tr> |
---|
| 579 | </table> |
---|
| 580 | </td> |
---|
| 581 | </tr> |
---|
| 582 | </table> |
---|
| 583 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 584 | <tr> |
---|
| 585 | <td> |
---|
| 586 | |
---|
| 587 | </td> |
---|
| 588 | <td> |
---|
| 589 | |
---|
| 590 | <p> |
---|
| 591 | Sets the visibility of the wrapped renderable. |
---|
| 592 | <p> |
---|
| 593 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 594 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 595 | <tr><td valign="top"></td><td valign="top"><em>visible</em> </td><td>visibility </td></tr> |
---|
| 596 | </table> |
---|
| 597 | </dl> |
---|
| 598 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_elementary_renderable.html#1a7a52a1be56af4e88e5dc7b00578161">ElementaryRenderable::setVisible()</a> </dd></dl> |
---|
| 599 | |
---|
| 600 | <p> |
---|
| 601 | Implements <a class="el" href="class_elementary_renderable.html#1a7a52a1be56af4e88e5dc7b00578161">ElementaryRenderable</a>. </td> |
---|
| 602 | </tr> |
---|
| 603 | </table> |
---|
| 604 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
| 605 | <li>OgreRenderable.h<li>OgreRenderable.cpp</ul> |
---|
| 606 | <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:41 2006 for GameTools Illumination Module by |
---|
| 607 | <a href="http://www.doxygen.org/index.html"> |
---|
| 608 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 609 | </body> |
---|
| 610 | </html> |
---|