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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::RenderQueue::RenderableListener 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::RenderQueue::RenderableListener Class Reference</h1>Class to listen in on items being added to the render queue. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreRenderQueue_8h-source.html">OgreRenderQueue.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1RenderQueue_1_1RenderableListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueue_1_1RenderableListener.html#Ogre_1_1RenderQueue_1_1RenderableListenera0">RenderableListener</a> ()</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueue_1_1RenderableListener.html#Ogre_1_1RenderQueue_1_1RenderableListenera1">~RenderableListener</a> ()</td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueue_1_1RenderableListener.html#Ogre_1_1RenderQueue_1_1RenderableListenera2">renderableQueued</a> (<a class="el" href="classOgre_1_1Renderable.html">Renderable</a> *rend, <a class="el" href="namespaceOgre.html#a457">uint8</a> groupID, <a class="el" href="namespaceOgre.html#a467">ushort</a> priority, <a class="el" href="classOgre_1_1Technique.html">Technique</a> **ppTech)=0</td></tr>
23
24<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method called when a <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> is added to the queue.  <a href="#Ogre_1_1RenderQueue_1_1RenderableListenera2"></a><br><br></td></tr>
25</table>
26<hr><a name="_details"></a><h2>Detailed Description</h2>
27Class to listen in on items being added to the render queue.
28<p>
29<dl compact><dt><b>Remarks:</b></dt><dd>Use <a class="el" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuea15">RenderQueue::setRenderableListener</a> to get callbacks when an item is added to the render queue.</dd></dl>
30
31<p>
32
33<p>
34Definition at line <a class="el" href="OgreRenderQueue_8h-source.html#l00087">87</a> of file <a class="el" href="OgreRenderQueue_8h-source.html">OgreRenderQueue.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
35<a class="anchor" name="Ogre_1_1RenderQueue_1_1RenderableListenera0" doxytag="Ogre::RenderQueue::RenderableListener::RenderableListener" ></a><p>
36<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
37  <tr>
38    <td class="mdRow">
39      <table cellpadding="0" cellspacing="0" border="0">
40        <tr>
41          <td class="md" nowrap valign="top"> Ogre::RenderQueue::RenderableListener::RenderableListener </td>
42          <td class="md" valign="top">(&nbsp;</td>
43          <td class="mdname1" valign="top" nowrap>          </td>
44          <td class="md" valign="top">&nbsp;)&nbsp;</td>
45          <td class="md" nowrap></td>
46        </tr>
47
48      </table>
49    </td>
50  </tr>
51</table>
52<table cellspacing=5 cellpadding=0 border=0>
53  <tr>
54    <td>
55      &nbsp;
56    </td>
57    <td>
58
59<p>
60
61<p>
62Definition at line <a class="el" href="OgreRenderQueue_8h-source.html#l00090">90</a> of file <a class="el" href="OgreRenderQueue_8h-source.html">OgreRenderQueue.h</a>.    </td>
63  </tr>
64</table>
65<a class="anchor" name="Ogre_1_1RenderQueue_1_1RenderableListenera1" doxytag="Ogre::RenderQueue::RenderableListener::~RenderableListener" ></a><p>
66<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
67  <tr>
68    <td class="mdRow">
69      <table cellpadding="0" cellspacing="0" border="0">
70        <tr>
71          <td class="md" nowrap valign="top"> virtual Ogre::RenderQueue::RenderableListener::~<a class="el" href="classOgre_1_1RenderQueue_1_1RenderableListener.html">RenderableListener</a> </td>
72          <td class="md" valign="top">(&nbsp;</td>
73          <td class="mdname1" valign="top" nowrap>          </td>
74          <td class="md" valign="top">&nbsp;)&nbsp;</td>
75          <td class="md" nowrap><code> [virtual]</code></td>
76        </tr>
77
78      </table>
79    </td>
80  </tr>
81</table>
82<table cellspacing=5 cellpadding=0 border=0>
83  <tr>
84    <td>
85      &nbsp;
86    </td>
87    <td>
88
89<p>
90
91<p>
92Definition at line <a class="el" href="OgreRenderQueue_8h-source.html#l00091">91</a> of file <a class="el" href="OgreRenderQueue_8h-source.html">OgreRenderQueue.h</a>.    </td>
93  </tr>
94</table>
95<hr><h2>Member Function Documentation</h2>
96<a class="anchor" name="Ogre_1_1RenderQueue_1_1RenderableListenera2" doxytag="Ogre::RenderQueue::RenderableListener::renderableQueued" ></a><p>
97<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
98  <tr>
99    <td class="mdRow">
100      <table cellpadding="0" cellspacing="0" border="0">
101        <tr>
102          <td class="md" nowrap valign="top"> virtual bool Ogre::RenderQueue::RenderableListener::renderableQueued </td>
103          <td class="md" valign="top">(&nbsp;</td>
104          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Renderable.html">Renderable</a> *&nbsp;</td>
105          <td class="mdname" nowrap> <em>rend</em>, </td>
106        </tr>
107        <tr>
108          <td class="md" nowrap align="right"></td>
109          <td></td>
110          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td>
111          <td class="mdname" nowrap> <em>groupID</em>, </td>
112        </tr>
113        <tr>
114          <td class="md" nowrap align="right"></td>
115          <td></td>
116          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td>
117          <td class="mdname" nowrap> <em>priority</em>, </td>
118        </tr>
119        <tr>
120          <td class="md" nowrap align="right"></td>
121          <td></td>
122          <td class="md" nowrap><a class="el" href="classOgre_1_1Technique.html">Technique</a> **&nbsp;</td>
123          <td class="mdname" nowrap> <em>ppTech</em></td>
124        </tr>
125        <tr>
126          <td></td>
127          <td class="md">)&nbsp;</td>
128          <td class="md" colspan="2"><code> [pure virtual]</code></td>
129        </tr>
130
131      </table>
132    </td>
133  </tr>
134</table>
135<table cellspacing=5 cellpadding=0 border=0>
136  <tr>
137    <td>
138      &nbsp;
139    </td>
140    <td>
141
142<p>
143Method called when a <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> is added to the queue.
144<p>
145<dl compact><dt><b>Remarks:</b></dt><dd>You can use this event hook to alter the <a class="el" href="classOgre_1_1Technique.html">Technique</a> used to render a <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> as the item is added to the queue. This is a low-level way to override the material settings for a given <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> on the fly. </dd></dl>
146<dl compact><dt><b>Parameters:</b></dt><dd>
147  <table border="0" cellspacing="2" cellpadding="0">
148    <tr><td valign=top><em>rend</em>&nbsp;</td><td>The <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> being added to the queue </td></tr>
149    <tr><td valign=top><em>groupID</em>&nbsp;</td><td>The render queue group this <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> is being added to </td></tr>
150    <tr><td valign=top><em>priority</em>&nbsp;</td><td>The priority the <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> has been given </td></tr>
151    <tr><td valign=top><em>ppTech</em>&nbsp;</td><td>A pointer to the pointer to the <a class="el" href="classOgre_1_1Technique.html">Technique</a> that is intended to be used; you can alter this to an alternate <a class="el" href="classOgre_1_1Technique.html">Technique</a> if you so wish (the <a class="el" href="classOgre_1_1Technique.html">Technique</a> doesn't have to be from the same <a class="el" href="classOgre_1_1Material.html">Material</a> either). </td></tr>
152  </table>
153</dl>
154<dl compact><dt><b>Returns:</b></dt><dd>true to allow the <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> to be added to the queue, false if you want to prevent it being added</dd></dl>
155    </td>
156  </tr>
157</table>
158<hr>The documentation for this class was generated from the following file:<ul>
159<li><a class="el" href="OgreRenderQueue_8h-source.html">OgreRenderQueue.h</a></ul>
160<hr>
161<p>
162Copyright &copy; 2000-2005 by The OGRE Team<br />
163<!--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/>
164This 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/>
165                <!--/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#">
166                <Work rdf:about="">
167                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
168        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
169                </Work>
170                <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> -->
171
172Last modified Sun Mar 12 14:42:04 2006
173</p>
174</body>
175</html>
Note: See TracBrowser for help on using the repository browser.