aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/class_NL3D__UInstanceGroup.html
blob: 6981576f42ea88099d2b1081727567773fec1c92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
	<TITLE>nevrax.org : docs</TITLE>
	<LINK REL=stylesheet TYPE="text/css" HREF="/inc/css/nevrax.css">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
</HEAD>
<BODY MARGINHEIGHT="0" MARGINWIDTH="0">

<!-- uplinks -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0>
 <TR>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=140 BGCOLOR=#dddddd><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
        <TD><IMG  width=6 height=14  SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
 </TR>
</TABLE> 

<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 WIDTH=100%>
 <TR><TD  BGCOLOR="#000000" BACKGROUND="/inc/img/black_banner.jpg"><A HREF=""><IMG  SRC="/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
</TABLE>

<!-- main table -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 height=100%>
 <TR>
	<TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
	<TD WIDTH=140   BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

		<!------ Begin Box ------>
		<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0  cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
		<FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td  colspan=2 bgcolor=#FFFFFF>
		<TABLE cellspacing=0 cellpadding=1 border=0>
			<tr><td ALIGN=middle><a  class='linkbox' href="/news/" TITLE="Rubrique news"><img width=13 height=15  hspace=5 border=0 src=/inc/img/picto-news.gif ALT=#></A></td><td><a  class='linkbox' href="/news/" TITLE="News">News</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/mail/" TITLE="Rubrique mail"><img width=15 height=11  hspace=5 border=0 src=/inc/img/picto-mail.gif ALT=#></A></td><td><a  class='linkbox' href="/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/docs/" TITLE="Rubrique docs"><img width=14 height=16  hspace=5 border=0 src=/inc/img/picto-docs.gif ALT=#></A></td><td><a  class='linkbox' href="/docs/" TITLE="Documentation">Documentation</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/cvs/" TITLE="Rubrique cvs"><img width=13 height=17  hspace=5 border=0 src=/inc/img/picto-cvs.gif ALT=#></A></td><td><a  class='linkbox' href="/cvs/" TITLE="CVS Web">CVS</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/bugs/" TITLE="Rubrique bugs"><img width=20 height=16  hspace=5 border=0 src=/inc/img/picto-bugs.gif ALT=#></A></td><td><a  class='linkbox' href="/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/GPL.php3" TITLE="Rubrique license"><img  width=18 height=12   hspace=5 border=0 src=/inc/img/picto-gpl.gif ALT=#></A></td><td><a  class='linkbox' href="/GPL.php3" TITLE="License">License</a></td></tr>
		</TABLE>
		</TD></TR></TABLE></TD></TR></TABLE>
		<!------ End Box  ------>

	</TD>
	<TD WIDTH=15><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
	<TD ALIGN=left valign=top><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

<!-- title -->
<TABLE  background="/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td>
<A HREF="/docs/"><img src="/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG  SRC="/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
&nbsp;

<!-- block -->
<TABLE  bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="/inc/img/reddots.gif"></TD>
	<TD><B>Documentation</B></TD>
	<TD ALIGN=RIGHT>&nbsp;</td>
</tr></table>
<!-- Generated by Doxygen 1.2.2 on Mon May 14 22:34:13 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
<hr><h1>NL3D::UInstanceGroup  Class Reference</h1>Game interface for managing group instance. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="u_instance_group_h-source.html">u_instance_group.h</a>&gt;</code>
<p>
Inheritance diagram for NL3D::UInstanceGroup<p><center><img src="class_NL3D__UInstanceGroup_inherit_graph.gif" border="0" usemap="#NL3D::UInstanceGroup_inherit_map" alt="Inheritance graph"></center>
<map name="NL3D::UInstanceGroup_inherit_map">
<area href="class_NL3D__CInstanceGroupUser.html" shape="rect" coords="0,67,165,86">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_NL3D__UInstanceGroup-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="types_nl_h.html#a13">uint</a>&nbsp;</td><td valign=bottom><a class="el" href="class_NL3D__UInstanceGroup.html#a0">getNumInstance</a> () const = 0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the count of shape instance in this group.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const std::string&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_NL3D__UInstanceGroup.html#a1">getInstanceName</a> (<a class="el" href="types_nl_h.html#a13">uint</a> instanceNb) const = 0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the name of an instance of the group.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="class_NLMISC__CVector.html">NLMISC::CVector</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_NL3D__UInstanceGroup.html#a2">getInstancePos</a> (<a class="el" href="types_nl_h.html#a13">uint</a> instanceNb) const = 0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the position of an instance of the group.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="class_NLMISC__CQuat.html">NLMISC::CQuat</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_NL3D__UInstanceGroup.html#a3">getInstanceRot</a> (<a class="el" href="types_nl_h.html#a13">uint</a> instanceNb) const = 0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the rotation of an instance of the group.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="class_NLMISC__CVector.html">NLMISC::CVector</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="class_NL3D__UInstanceGroup.html#a4">getInstanceScale</a> (<a class="el" href="types_nl_h.html#a13">uint</a> instanceNb) const = 0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the scale of an instance of the group.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>UInstanceGroup*&nbsp;</td><td valign=bottom><a class="el" href="class_NL3D__UInstanceGroup.html#d0">createInstanceGroup</a> (const std::string &amp;instanceGroup)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This is the static function create a stand alone instance group.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Game interface for managing group instance.
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
 Cyril 'Hulud' Corvazier ,  Nevrax France </dl><dl compact><dt>
<b>Date: </b><dd>
 2001 </dl>
<p>

<p>
Definition at line <a class="el" href="u_instance_group_h-source.html#l00047">47</a> of file <a class="el" href="u_instance_group_h-source.html">u_instance_group.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="d0" doxytag="NL3D::UInstanceGroup::createInstanceGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
UInstanceGroup * NL3D::UInstanceGroup::createInstanceGroup (
          </b></td>
          <td valign="bottom"><b>
const std::string &amp; <em>instanceGroup</em>&nbsp;)<code> [static]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This is the static function create a stand alone instance group.
<p>

<p>
Definition at line <a class="el" href="instance_group_user_cpp-source.html#l00036">36</a> of file <a class="el" href="instance_group_user_cpp-source.html">instance_group_user.cpp</a>.    </td>
  </tr>
</table>
<a name="a1" doxytag="NL3D::UInstanceGroup::getInstanceName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
const std::string &amp; NL3D::UInstanceGroup::getInstanceName (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="types_nl_h.html#a13">uint</a> <em>instanceNb</em>&nbsp;) const<code> [pure virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the name of an instance of the group.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>instanceNb</em>
&nbsp;</td><td>
 is the number of the instance. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
 the name of the instance. </dl>
<p>
Reimplemented in <a class="el" href="class_NL3D__CInstanceGroupUser.html#c1">NL3D::CInstanceGroupUser</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="NL3D::UInstanceGroup::getInstancePos"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
const <a class="el" href="class_NLMISC__CVector.html">NLMISC::CVector</a> &amp; NL3D::UInstanceGroup::getInstancePos (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="types_nl_h.html#a13">uint</a> <em>instanceNb</em>&nbsp;) const<code> [pure virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the position of an instance of the group.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>instanceNb</em>
&nbsp;</td><td>
 is the number of the instance. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
 the position of the instance. </dl>
<p>
Reimplemented in <a class="el" href="class_NL3D__CInstanceGroupUser.html#c2">NL3D::CInstanceGroupUser</a>.    </td>
  </tr>
</table>
<a name="a3" doxytag="NL3D::UInstanceGroup::getInstanceRot"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
const <a class="el" href="class_NLMISC__CQuat.html">NLMISC::CQuat</a> &amp; NL3D::UInstanceGroup::getInstanceRot (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="types_nl_h.html#a13">uint</a> <em>instanceNb</em>&nbsp;) const<code> [pure virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the rotation of an instance of the group.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>instanceNb</em>
&nbsp;</td><td>
 is the number of the instance. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
 the rotation of the instance. </dl>
<p>
Reimplemented in <a class="el" href="class_NL3D__CInstanceGroupUser.html#c3">NL3D::CInstanceGroupUser</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="NL3D::UInstanceGroup::getInstanceScale"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
const <a class="el" href="class_NLMISC__CVector.html">NLMISC::CVector</a> &amp; NL3D::UInstanceGroup::getInstanceScale (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="types_nl_h.html#a13">uint</a> <em>instanceNb</em>&nbsp;) const<code> [pure virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the scale of an instance of the group.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>instanceNb</em>
&nbsp;</td><td>
 is the number of the instance. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
 the scale of the instance. </dl>
<p>
Reimplemented in <a class="el" href="class_NL3D__CInstanceGroupUser.html#c4">NL3D::CInstanceGroupUser</a>.    </td>
  </tr>
</table>
<a name="a0" doxytag="NL3D::UInstanceGroup::getNumInstance"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
<a class="el" href="types_nl_h.html#a13">uint</a> NL3D::UInstanceGroup::getNumInstance (
          </b></td>
          <td valign="bottom"><b>
) const<code> [pure virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the count of shape instance in this group.
<p>

<p>
Reimplemented in <a class="el" href="class_NL3D__CInstanceGroupUser.html#c0">NL3D::CInstanceGroupUser</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="u_instance_group_h-source.html">u_instance_group.h</a><li><a class="el" href="instance_group_user_cpp-source.html">instance_group_user.cpp</a></ul>


<!-- footer -->
<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
</TD>
<TD WIDTH=15><IMG  SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>