[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: ElementaryRenderable 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>ElementaryRenderable Class Reference</h1><!-- doxytag: class="ElementaryRenderable" -->Base abstract class for an elementary renderable. |
---|
| 21 | <a href="#_details">More...</a> |
---|
| 22 | <p> |
---|
| 23 | <p>Inheritance diagram for ElementaryRenderable: |
---|
| 24 | <p><center><img src="class_elementary_renderable.png" usemap="#ElementaryRenderable_map" border="0" alt=""></center> |
---|
| 25 | <map name="ElementaryRenderable_map"> |
---|
| 26 | <area href="class_ogre_renderable.html" alt="OgreRenderable" shape="rect" coords="0,56,140,80"> |
---|
| 27 | </map> |
---|
| 28 | <a href="class_elementary_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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_elementary_renderable.html#1a7a52a1be56af4e88e5dc7b00578161">setVisible</a> (bool visible)=0</td></tr> |
---|
| 32 | |
---|
| 33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Shows or hides the renderable. <a href="#1a7a52a1be56af4e88e5dc7b00578161"></a><br></td></tr> |
---|
| 34 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_elementary_renderable.html#4368eba8bcf6560d5e6b284acddc4799">setRenderGroup</a> (unsigned char groupID)=0</td></tr> |
---|
| 35 | |
---|
| 36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the rendering group this renderable belongs to. <a href="#4368eba8bcf6560d5e6b284acddc4799"></a><br></td></tr> |
---|
| 37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b3b0ca23861da962e650542179c5456"></a><!-- doxytag: member="ElementaryRenderable::isVisible" ref="7b3b0ca23861da962e650542179c5456" args="()=0" --> |
---|
| 38 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_elementary_renderable.html#7b3b0ca23861da962e650542179c5456">isVisible</a> ()=0</td></tr> |
---|
| 39 | |
---|
| 40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves if the renderable is hided or shown. <br></td></tr> |
---|
| 41 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0078e01d888c8769f074351031fd492a"></a><!-- doxytag: member="ElementaryRenderable::updateBounds" ref="0078e01d888c8769f074351031fd492a" args="()=0" --> |
---|
| 42 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_elementary_renderable.html#0078e01d888c8769f074351031fd492a">updateBounds</a> ()=0</td></tr> |
---|
| 43 | |
---|
| 44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates bounding volumes. <br></td></tr> |
---|
| 45 | </table> |
---|
| 46 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 47 | Base abstract class for an elementary renderable. |
---|
| 48 | <p> |
---|
| 49 | <hr><h2>Member Function Documentation</h2> |
---|
| 50 | <a class="anchor" name="4368eba8bcf6560d5e6b284acddc4799"></a><!-- doxytag: member="ElementaryRenderable::setRenderGroup" ref="4368eba8bcf6560d5e6b284acddc4799" args="(unsigned char groupID)=0" --><p> |
---|
| 51 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 52 | <tr> |
---|
| 53 | <td class="mdRow"> |
---|
| 54 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 55 | <tr> |
---|
| 56 | <td class="md" nowrap valign="top">virtual void ElementaryRenderable::setRenderGroup </td> |
---|
| 57 | <td class="md" valign="top">( </td> |
---|
| 58 | <td class="md" nowrap valign="top">unsigned char </td> |
---|
| 59 | <td class="mdname1" valign="top" nowrap> <em>groupID</em> </td> |
---|
| 60 | <td class="md" valign="top"> ) </td> |
---|
| 61 | <td class="md" nowrap><code> [pure virtual]</code></td> |
---|
| 62 | </tr> |
---|
| 63 | </table> |
---|
| 64 | </td> |
---|
| 65 | </tr> |
---|
| 66 | </table> |
---|
| 67 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 68 | <tr> |
---|
| 69 | <td> |
---|
| 70 | |
---|
| 71 | </td> |
---|
| 72 | <td> |
---|
| 73 | |
---|
| 74 | <p> |
---|
| 75 | Sets the rendering group this renderable belongs to. |
---|
| 76 | <p> |
---|
| 77 | Rendering groups are to distinguish groups of rendering types (eg.: caustic casters, caustic recievers, shadow casters) if needed. Each group has a unique ID.<p> |
---|
| 78 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 79 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 80 | <tr><td valign="top"></td><td valign="top"><em>groupID</em> </td><td>the ID of the group to use </td></tr> |
---|
| 81 | </table> |
---|
| 82 | </dl> |
---|
| 83 | |
---|
| 84 | <p> |
---|
| 85 | Implemented in <a class="el" href="class_ogre_renderable.html#e8b72fa34ff6142da63e93fcff922d59">OgreRenderable</a>. </td> |
---|
| 86 | </tr> |
---|
| 87 | </table> |
---|
| 88 | <a class="anchor" name="1a7a52a1be56af4e88e5dc7b00578161"></a><!-- doxytag: member="ElementaryRenderable::setVisible" ref="1a7a52a1be56af4e88e5dc7b00578161" args="(bool visible)=0" --><p> |
---|
| 89 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 90 | <tr> |
---|
| 91 | <td class="mdRow"> |
---|
| 92 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 93 | <tr> |
---|
| 94 | <td class="md" nowrap valign="top">virtual void ElementaryRenderable::setVisible </td> |
---|
| 95 | <td class="md" valign="top">( </td> |
---|
| 96 | <td class="md" nowrap valign="top">bool </td> |
---|
| 97 | <td class="mdname1" valign="top" nowrap> <em>visible</em> </td> |
---|
| 98 | <td class="md" valign="top"> ) </td> |
---|
| 99 | <td class="md" nowrap><code> [pure virtual]</code></td> |
---|
| 100 | </tr> |
---|
| 101 | </table> |
---|
| 102 | </td> |
---|
| 103 | </tr> |
---|
| 104 | </table> |
---|
| 105 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 106 | <tr> |
---|
| 107 | <td> |
---|
| 108 | |
---|
| 109 | </td> |
---|
| 110 | <td> |
---|
| 111 | |
---|
| 112 | <p> |
---|
| 113 | Shows or hides the renderable. |
---|
| 114 | <p> |
---|
| 115 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 116 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 117 | <tr><td valign="top"></td><td valign="top"><em>visible</em> </td><td>visibility </td></tr> |
---|
| 118 | </table> |
---|
| 119 | </dl> |
---|
| 120 | |
---|
| 121 | <p> |
---|
| 122 | Implemented in <a class="el" href="class_ogre_renderable.html#95459c482dad92853c019386cd8acffa">OgreRenderable</a>. </td> |
---|
| 123 | </tr> |
---|
| 124 | </table> |
---|
| 125 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 126 | <li>ElementaryRenderable.h</ul> |
---|
| 127 | <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:37 2006 for GameTools Illumination Module by |
---|
| 128 | <a href="http://www.doxygen.org/index.html"> |
---|
| 129 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 130 | </body> |
---|
| 131 | </html> |
---|