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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::EdgeData 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::EdgeData Class Reference</h1>This class contains the information required to describe the edge connectivity of a given set of vertices and indexes. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1EdgeData-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 Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="structOgre_1_1EdgeData_1_1Triangle.html">Triangle</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw0">TriangleList</a></td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="structOgre_1_1EdgeData_1_1Edge.html">Edge</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw1">EdgeList</a></td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="structOgre_1_1EdgeData_1_1EdgeGroup.html">EdgeGroup</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw2">EdgeGroupList</a></td></tr>
23
24<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataa0">updateTriangleLightFacing</a> (const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;lightPos)</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the light facing state of the triangles in this edge list.  <a href="#Ogre_1_1EdgeDataa0"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataa1">updateFaceNormals</a> (size_t vertexSet, <a class="el" href="classOgre_1_1HardwareVertexBufferSharedPtr.html">HardwareVertexBufferSharedPtr</a> positionBuffer)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the face normals for this edge list based on (changed) position information, useful for animated objects.  <a href="#Ogre_1_1EdgeDataa1"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataa2">log</a> (<a class="el" href="classOgre_1_1Log.html">Log</a> *log)</td></tr>
32
33<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw0">TriangleList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDatao0">triangles</a></td></tr>
35
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw2">EdgeGroupList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDatao1">edgeGroups</a></td></tr>
37
38</table>
39<hr><a name="_details"></a><h2>Detailed Description</h2>
40This class contains the information required to describe the edge connectivity of a given set of vertices and indexes.
41<p>
42<dl compact><dt><b>Remarks:</b></dt><dd>This information is built using the <a class="el" href="classOgre_1_1EdgeListBuilder.html">EdgeListBuilder</a> class. Note that for a given mesh, which can be made up of multiple submeshes, there are separate edge lists for when </dd></dl>
43
44<p>
45
46<p>
47Definition at line <a class="el" href="OgreEdgeListBuilder_8h-source.html#l00042">42</a> of file <a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>.<hr><h2>Member Typedef Documentation</h2>
48<a class="anchor" name="Ogre_1_1EdgeDataw2" doxytag="Ogre::EdgeData::EdgeGroupList" ></a><p>
49<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
50  <tr>
51    <td class="mdRow">
52      <table cellpadding="0" cellspacing="0" border="0">
53        <tr>
54          <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="structOgre_1_1EdgeData_1_1EdgeGroup.html">EdgeGroup</a>&gt; <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw2">Ogre::EdgeData::EdgeGroupList</a>
55      </table>
56    </td>
57  </tr>
58</table>
59<table cellspacing=5 cellpadding=0 border=0>
60  <tr>
61    <td>
62      &nbsp;
63    </td>
64    <td>
65
66<p>
67
68<p>
69Definition at line <a class="el" href="OgreEdgeListBuilder_8h-source.html#l00088">88</a> of file <a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>.    </td>
70  </tr>
71</table>
72<a class="anchor" name="Ogre_1_1EdgeDataw1" doxytag="Ogre::EdgeData::EdgeList" ></a><p>
73<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
74  <tr>
75    <td class="mdRow">
76      <table cellpadding="0" cellspacing="0" border="0">
77        <tr>
78          <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="structOgre_1_1EdgeData_1_1Edge.html">Edge</a>&gt; <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw1">Ogre::EdgeData::EdgeList</a>
79      </table>
80    </td>
81  </tr>
82</table>
83<table cellspacing=5 cellpadding=0 border=0>
84  <tr>
85    <td>
86      &nbsp;
87    </td>
88    <td>
89
90<p>
91
92<p>
93Definition at line <a class="el" href="OgreEdgeListBuilder_8h-source.html#l00074">74</a> of file <a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>.    </td>
94  </tr>
95</table>
96<a class="anchor" name="Ogre_1_1EdgeDataw0" doxytag="Ogre::EdgeData::TriangleList" ></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"> typedef std::vector&lt;<a class="el" href="structOgre_1_1EdgeData_1_1Triangle.html">Triangle</a>&gt; <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw0">Ogre::EdgeData::TriangleList</a>
103      </table>
104    </td>
105  </tr>
106</table>
107<table cellspacing=5 cellpadding=0 border=0>
108  <tr>
109    <td>
110      &nbsp;
111    </td>
112    <td>
113
114<p>
115
116<p>
117Definition at line <a class="el" href="OgreEdgeListBuilder_8h-source.html#l00073">73</a> of file <a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>.    </td>
118  </tr>
119</table>
120<hr><h2>Member Function Documentation</h2>
121<a class="anchor" name="Ogre_1_1EdgeDataa2" doxytag="Ogre::EdgeData::log" ></a><p>
122<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
123  <tr>
124    <td class="mdRow">
125      <table cellpadding="0" cellspacing="0" border="0">
126        <tr>
127          <td class="md" nowrap valign="top"> void Ogre::EdgeData::log </td>
128          <td class="md" valign="top">(&nbsp;</td>
129          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Log.html">Log</a> *&nbsp;</td>
130          <td class="mdname1" valign="top" nowrap> <em>log</em>          </td>
131          <td class="md" valign="top">&nbsp;)&nbsp;</td>
132          <td class="md" nowrap></td>
133        </tr>
134
135      </table>
136    </td>
137  </tr>
138</table>
139<table cellspacing=5 cellpadding=0 border=0>
140  <tr>
141    <td>
142      &nbsp;
143    </td>
144    <td>
145
146<p>
147    </td>
148  </tr>
149</table>
150<a class="anchor" name="Ogre_1_1EdgeDataa1" doxytag="Ogre::EdgeData::updateFaceNormals" ></a><p>
151<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
152  <tr>
153    <td class="mdRow">
154      <table cellpadding="0" cellspacing="0" border="0">
155        <tr>
156          <td class="md" nowrap valign="top"> void Ogre::EdgeData::updateFaceNormals </td>
157          <td class="md" valign="top">(&nbsp;</td>
158          <td class="md" nowrap valign="top">size_t&nbsp;</td>
159          <td class="mdname" nowrap> <em>vertexSet</em>, </td>
160        </tr>
161        <tr>
162          <td class="md" nowrap align="right"></td>
163          <td></td>
164          <td class="md" nowrap><a class="el" href="classOgre_1_1HardwareVertexBufferSharedPtr.html">HardwareVertexBufferSharedPtr</a>&nbsp;</td>
165          <td class="mdname" nowrap> <em>positionBuffer</em></td>
166        </tr>
167        <tr>
168          <td></td>
169          <td class="md">)&nbsp;</td>
170          <td class="md" colspan="2"></td>
171        </tr>
172
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing=5 cellpadding=0 border=0>
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185Updates the face normals for this edge list based on (changed) position information, useful for animated objects.
186<p>
187<dl compact><dt><b>Parameters:</b></dt><dd>
188  <table border="0" cellspacing="2" cellpadding="0">
189    <tr><td valign=top><em>vertexSet</em>&nbsp;</td><td>The vertex set we are updating </td></tr>
190    <tr><td valign=top><em>positionBuffer</em>&nbsp;</td><td>The updated position buffer, must contain ONLY xyz </td></tr>
191  </table>
192</dl>
193    </td>
194  </tr>
195</table>
196<a class="anchor" name="Ogre_1_1EdgeDataa0" doxytag="Ogre::EdgeData::updateTriangleLightFacing" ></a><p>
197<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
198  <tr>
199    <td class="mdRow">
200      <table cellpadding="0" cellspacing="0" border="0">
201        <tr>
202          <td class="md" nowrap valign="top"> void Ogre::EdgeData::updateTriangleLightFacing </td>
203          <td class="md" valign="top">(&nbsp;</td>
204          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector4.html">Vector4</a> &amp;&nbsp;</td>
205          <td class="mdname1" valign="top" nowrap> <em>lightPos</em>          </td>
206          <td class="md" valign="top">&nbsp;)&nbsp;</td>
207          <td class="md" nowrap></td>
208        </tr>
209
210      </table>
211    </td>
212  </tr>
213</table>
214<table cellspacing=5 cellpadding=0 border=0>
215  <tr>
216    <td>
217      &nbsp;
218    </td>
219    <td>
220
221<p>
222Calculate the light facing state of the triangles in this edge list.
223<p>
224<dl compact><dt><b>Remarks:</b></dt><dd>This is normally the first stage of calculating a silhouette, ie establishing which tris are facing the light and which are facing away. This state is stored in the 'lightFacing' flag in each <a class="el" href="structOgre_1_1EdgeData_1_1Triangle.html">Triangle</a>. </dd></dl>
225<dl compact><dt><b>Parameters:</b></dt><dd>
226  <table border="0" cellspacing="2" cellpadding="0">
227    <tr><td valign=top><em>lightPos</em>&nbsp;</td><td>4D position of the light in object space, note that for directional lights (which have no position), the w component is 0 and the x/y/z position are the direction. </td></tr>
228  </table>
229</dl>
230    </td>
231  </tr>
232</table>
233<hr><h2>Member Data Documentation</h2>
234<a class="anchor" name="Ogre_1_1EdgeDatao1" doxytag="Ogre::EdgeData::edgeGroups" ></a><p>
235<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
236  <tr>
237    <td class="mdRow">
238      <table cellpadding="0" cellspacing="0" border="0">
239        <tr>
240          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw2">EdgeGroupList</a> <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDatao1">Ogre::EdgeData::edgeGroups</a>
241      </table>
242    </td>
243  </tr>
244</table>
245<table cellspacing=5 cellpadding=0 border=0>
246  <tr>
247    <td>
248      &nbsp;
249    </td>
250    <td>
251
252<p>
253
254<p>
255Definition at line <a class="el" href="OgreEdgeListBuilder_8h-source.html#l00090">90</a> of file <a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>.    </td>
256  </tr>
257</table>
258<a class="anchor" name="Ogre_1_1EdgeDatao0" doxytag="Ogre::EdgeData::triangles" ></a><p>
259<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
260  <tr>
261    <td class="mdRow">
262      <table cellpadding="0" cellspacing="0" border="0">
263        <tr>
264          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDataw0">TriangleList</a> <a class="el" href="classOgre_1_1EdgeData.html#Ogre_1_1EdgeDatao0">Ogre::EdgeData::triangles</a>
265      </table>
266    </td>
267  </tr>
268</table>
269<table cellspacing=5 cellpadding=0 border=0>
270  <tr>
271    <td>
272      &nbsp;
273    </td>
274    <td>
275
276<p>
277
278<p>
279Definition at line <a class="el" href="OgreEdgeListBuilder_8h-source.html#l00089">89</a> of file <a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a>.    </td>
280  </tr>
281</table>
282<hr>The documentation for this class was generated from the following file:<ul>
283<li><a class="el" href="OgreEdgeListBuilder_8h-source.html">OgreEdgeListBuilder.h</a></ul>
284<hr>
285<p>
286Copyright &copy; 2000-2005 by The OGRE Team<br />
287<!--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/>
288This 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/>
289                <!--/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#">
290                <Work rdf:about="">
291                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
292        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
293                </Work>
294                <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> -->
295
296Last modified Sun Mar 12 14:38:42 2006
297</p>
298</body>
299</html>
Note: See TracBrowser for help on using the repository browser.