aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03175.html
blob: f10aeb3cfc17fdf707dd98814bd0f1e0284c011d (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>NeL: NL3D::CPSDirection class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex">  <form class="search" action="search.php" method="get">
<a class="qindex" href="main.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">Data&nbsp;Structures</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">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a>  | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NL3D::CPSDirection Class Reference</h1><code>#include &lt;<a class="el" href="a06225.html">ps_direction.h</a>&gt;</code>
<p>
<p>Inheritance diagram for NL3D::CPSDirection:
<p><center><img src="a03175.png" usemap="#NL3D::CPSDirection_map" border="0" alt=""></center>
<map name="NL3D::CPSDirection_map">
<area href="a03176.html" alt="NL3D::CPSDirectionnalForce" shape="rect" coords="0,56,181,80">
<area href="a03181.html" alt="NL3D::CPSEmitterDirectionnal" shape="rect" coords="286,56,467,80">
<area href="a03184.html" alt="NL3D::CPSEmitterRectangle" shape="rect" coords="477,56,658,80">
<area href="a03217.html" alt="NL3D::CPSMagneticForce" shape="rect" coords="0,112,181,136">
<area href="a03180.html" alt="NL3D::CPSEmitterConic" shape="rect" coords="191,112,372,136">
<area href="a03225.html" alt="NL3D::CPSRadialEmitter" shape="rect" coords="382,112,563,136">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is an interface for object for a particle system that need a direction (forces, emitter...) Some of these object support global value as a direction (see <a class="el" href="a03041.html#NL3D_1_1CParticleSystemz586_8">CParticleSystem::setGlobalVectorValue</a>), so calls to setDir then have no effect. 
<p>

<p>
Definition at line <a class="el" href="a06225.html#l00040">40</a> of file <a class="el" href="a06225.html">ps_direction.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03175.html#NL3D_1_1CPSRadialEmittera10">enableGlobalVectorValue</a> (const std::string &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03128.html">NLMISC::CVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03175.html#NL3D_1_1CPSDirectiona1">getDir</a> (void) const=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03175.html#NL3D_1_1CPSRadialEmittera31">getGlobalVectorValueName</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03175.html#NL3D_1_1CPSDirectiona3">setDir</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;<a class="el" href="a04223.html#a576">v</a>)=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03175.html#NL3D_1_1CPSRadialEmittera83">supportGlobalVectorValue</a> () const </td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NL3D_1_1CPSRadialEmittera10" doxytag="NL3D::CPSDirection::enableGlobalVectorValue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void NL3D::CPSDirection::enableGlobalVectorValue </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

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

<p>
The direction is taken from a global vector defined in the particle system NULL or an empty string as a name disable the use of a global value
<p>
Reimplemented in <a class="el" href="a03176.html#NL3D_1_1CPSMagneticForcez737_0">NL3D::CPSDirectionnalForce</a>.
<p>
Definition at line <a class="el" href="a06225.html#l00049">49</a> of file <a class="el" href="a06225.html">ps_direction.h</a>.
<p>
<div class="fragment"><pre>00049 {}      
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSDirectiona1" doxytag="NL3D::CPSDirection::getDir" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual <a class="el" href="a03128.html">NLMISC::CVector</a> NL3D::CPSDirection::getDir </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [pure virtual]</code></td>
        </tr>

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

<p>

<p>
Implemented in <a class="el" href="a03181.html#NL3D_1_1CPSRadialEmittera14">NL3D::CPSEmitterDirectionnal</a>, <a class="el" href="a03184.html#NL3D_1_1CPSEmitterRectanglea14">NL3D::CPSEmitterRectangle</a>, and <a class="el" href="a03176.html#NL3D_1_1CPSMagneticForcez737_1">NL3D::CPSDirectionnalForce</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSRadialEmittera31" doxytag="NL3D::CPSDirection::getGlobalVectorValueName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual std::string NL3D::CPSDirection::getGlobalVectorValueName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
        </tr>

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

<p>

<p>
Reimplemented in <a class="el" href="a03176.html#NL3D_1_1CPSMagneticForcez737_2">NL3D::CPSDirectionnalForce</a>.
<p>
Definition at line <a class="el" href="a06225.html#l00050">50</a> of file <a class="el" href="a06225.html">ps_direction.h</a>.
<p>
<div class="fragment"><pre>00050 { <span class="keywordflow">return</span> <span class="stringliteral">""</span>; }  
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSDirectiona3" doxytag="NL3D::CPSDirection::setDir" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void NL3D::CPSDirection::setDir </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>v</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

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

<p>

<p>
Implemented in <a class="el" href="a03181.html#NL3D_1_1CPSRadialEmittera63">NL3D::CPSEmitterDirectionnal</a>, <a class="el" href="a03184.html#NL3D_1_1CPSEmitterRectanglea66">NL3D::CPSEmitterRectangle</a>, <a class="el" href="a03180.html#NL3D_1_1CPSEmitterConica64">NL3D::CPSEmitterConic</a>, and <a class="el" href="a03176.html#NL3D_1_1CPSMagneticForcez737_3">NL3D::CPSDirectionnalForce</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSRadialEmittera83" doxytag="NL3D::CPSDirection::supportGlobalVectorValue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual bool NL3D::CPSDirection::supportGlobalVectorValue </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
        </tr>

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

<p>

<p>
Reimplemented in <a class="el" href="a03176.html#NL3D_1_1CPSMagneticForcez737_4">NL3D::CPSDirectionnalForce</a>.
<p>
Definition at line <a class="el" href="a06225.html#l00045">45</a> of file <a class="el" href="a06225.html">ps_direction.h</a>.
<p>
<div class="fragment"><pre>00045 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
</pre></div>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a06225.html">ps_direction.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:06:53 2004 for NeL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
</a>1.3.6 </small></address>
</body>
</html>