source: OGRE/trunk/ogrenew/Docs/manual/manual_29.html @ 692

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

adding ogre 1.2 and dependencies
Line 
1<HTML>
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3<!-- Created on , 12 2006 by texi2html 1.64 -->
4<!--
5Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
6            Karl Berry  <karl@freefriends.org>
7            Olaf Bachmann <obachman@mathematik.uni-kl.de>
8            and many others.
9Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
10Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
11 
12-->
13<HEAD>
14<TITLE>OGRE Manual v1.2.0 ('Dagon'): Particle Emitter Attributes</TITLE>
15
16<META NAME="description" CONTENT="OGRE Manual v1.2.0 ('Dagon'): Particle Emitter Attributes">
17<META NAME="keywords" CONTENT="OGRE Manual v1.2.0 ('Dagon'): Particle Emitter Attributes">
18<META NAME="resource-type" CONTENT="document">
19<META NAME="distribution" CONTENT="global">
20<META NAME="Generator" CONTENT="texi2html 1.64">
21<LINK TYPE="text/css" rel="stylesheet" href="../style.css"> 
22</HEAD>
23
24<BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
25
26<A NAME="SEC169"></A>
27<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
28<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_28.html#SEC167"> &lt; </A>]</TD>
29<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_26.html#SEC145"> Up </A>]</TD>
30<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_30.html#SEC184"> &gt; </A>]</TD>
31<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
32<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
33<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
34<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
35</TR></TABLE>
36<HR SIZE=1>
37<H3> 3.3.3 Particle Emitter Attributes </H3>
38<!--docid::SEC169::-->
39This section describes the common attributes of all particle emitters. Specific emitter types may also support their own extra attributes.<BR><BR>
40<P>
41
42<A NAME="angle"></A>
43<A NAME="SEC170"></A>
44<H3> angle </H3>
45<!--docid::SEC170::-->
46<P>
47
48Sets the maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see direction). Setting this to 10 allows particles to deviate up to 10 degrees in any direction away from the emitter's direction. A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.<BR><BR>
49</P><P>
50
51format: angle &#60;degrees&#62;<BR>
52example: angle 30<BR>
53default: 0<BR>
54</P><P>
55
56<A NAME="colour"></A>
57<A NAME="SEC171"></A>
58<H3> colour </H3>
59<!--docid::SEC171::-->
60<P>
61
62Sets a static colour for all particle emitted. Also see the colour_range_start and colour_range_end attributes for setting a range of colours. The format of the colour parameter is "r g b a", where each component is a value from 0 to 1, and the alpha value is optional (assumes 1 if not specified).<BR><BR>
63</P><P>
64
65format: colour &#60;r&#62; &#60;g&#62; &#60;b&#62; [&#60;a&#62;]<BR>
66example: colour 1 0 0 1<BR>
67default: 1 1 1 1<BR>
68</P><P>
69
70<A NAME="colour_range_start"></A>
71<A NAME="colour_range_end"></A>
72<A NAME="SEC172"></A>
73<H3> colour_range_start &#38; colour_range_end </H3>
74<!--docid::SEC172::-->
75<P>
76
77As the 'colour' attribute, except these 2 attributes must be specified together, and indicate the range of colours available to emitted particles. The actual colour will be randomly chosen between these 2 values.<BR><BR>
78</P><P>
79
80format: as colour<BR>
81example (generates random colours between red and blue):<BR>
82    colour_range_start 1 0 0<BR>
83    colour_range_end 0 0 1<BR>
84default: both 1 1 1 1<BR>
85</P><P>
86
87<A NAME="direction"></A>
88<A NAME="SEC173"></A>
89<H3> direction </H3>
90<!--docid::SEC173::-->
91<P>
92
93Sets the direction of the emitter. This is relative to the SceneNode which the particle system is attached to, meaning that as with other movable objects changing the orientation of the node will also move the emitter.<BR><BR>
94</P><P>
95
96format: direction &#60;x&#62; &#60;y&#62; &#60;z&#62;<BR>
97example: direction 0 1 0<BR>
98default: 1 0 0<BR>
99</P><P>
100
101<A NAME="emission_rate"></A>
102<A NAME="SEC174"></A>
103<H3> emission_rate </H3>
104<!--docid::SEC174::-->
105<P>
106
107Sets how many particles per second should be emitted. The specific emitter does not have to emit these in a continuous burst - this is a relative parameter
108and the emitter may choose to emit all of the second's worth of particles every half-second for example, the behaviour depends on the emitter. The emission rate will also be limited by the particle system's 'quota' setting.<BR><BR>
109</P><P>
110
111format: emission_rate &#60;particles_per_second&#62;<BR>
112example: emission_rate 50<BR>
113default: 10<BR>
114</P><P>
115
116<A NAME="position"></A>
117<A NAME="SEC175"></A>
118<H3> position </H3>
119<!--docid::SEC175::-->
120<P>
121
122Sets the position of the emitter relative to the SceneNode the particle system is attached to.<BR><BR>
123</P><P>
124
125format: position &#60;x&#62; &#60;y&#62; &#60;z&#62;<BR>
126example: position 10 0 40<BR>
127default: 0 0 0<BR>
128</P><P>
129
130<A NAME="velocity"></A>
131<A NAME="SEC176"></A>
132<H3> velocity </H3>
133<!--docid::SEC176::-->
134<P>
135
136Sets a constant velocity for all particles at emission time. See also the velocity_min and velocity_max attributes which allow you to set a range of velocities instead of a fixed one.<BR><BR>
137</P><P>
138
139format: velocity &#60;world_units_per_second&#62;<BR>
140example: velocity 100<BR>
141default: 1<BR>
142</P><P>
143
144<A NAME="velocity_min"></A>
145<A NAME="velocity_max"></A>
146<A NAME="SEC177"></A>
147<H3> velocity_min &#38; velocity_max </H3>
148<!--docid::SEC177::-->
149<P>
150
151As 'velocity' except these attributes set a velocity range and each particle is emitted with a random velocity within this range.<BR><BR>
152</P><P>
153
154format: as velocity<BR>
155example:<BR>
156    velocity_min 50<BR>
157    velocity_max 100<BR>
158default: both 1<BR>
159</P><P>
160
161<A NAME="time_to_live"></A>
162<A NAME="SEC178"></A>
163<H3> time_to_live </H3>
164<!--docid::SEC178::-->
165<P>
166
167Sets the number of seconds each particle will 'live' for before being destroyed. NB it is possible for particle affectors to alter this in flight, but this is the value given to particles on emission. See also the time_to_live_min and time_to_live_max attributes which let you set a lifetime range instead of a fixed one.<BR><BR>
168</P><P>
169
170format: time_to_live &#60;seconds&#62;<BR>
171example: time_to_live 10<BR>
172default: 5<BR>
173</P><P>
174
175<A NAME="time_to_live_min"></A>
176<A NAME="time_to_live_max"></A>
177<A NAME="SEC179"></A>
178<H3> time_to_live_min &#38; time_to_live_max </H3>
179<!--docid::SEC179::-->
180As time_to_live, except this sets a range of lifetimes and each particle gets a random value inbetween on emission.<BR><BR>
181<P>
182
183format: as time_to_live<BR>
184example:<BR>
185    time_to_live_min 2<BR>
186    time_to_live_max 5<BR>
187default: both 5<BR>
188<BR>
189</P><P>
190
191<A NAME="duration"></A>
192<A NAME="SEC180"></A>
193<H3> duration </H3>
194<!--docid::SEC180::-->
195<P>
196
197Sets the number of seconds the emitter is active. The emitter can be started again, see <A HREF="manual_29.html#SEC182">repeat_delay</A>. A value of 0 means infinite duration. See also the duration_min and duration_max attributes which let you set a duration range instead of a fixed one.<BR><BR>
198</P><P>
199
200format: duration &#60;seconds&#62;<BR>
201example:<BR>
202    duration 2.5<BR>
203default: 0<BR>
204<BR>
205</P><P>
206
207<A NAME="duration_min"></A>
208<A NAME="duration_max"></A>
209<A NAME="SEC181"></A>
210<H3> duration_min &#38; duration_max </H3>
211<!--docid::SEC181::-->
212<P>
213
214As duration, except these attributes set a variable time range between the min and max values each time the emitter is started.<BR><BR>
215</P><P>
216
217format: as duration<BR>
218example:<BR>
219    duration_min 2<BR>
220    duration_max 5<BR>
221default: both 0<BR>
222<BR>
223</P><P>
224
225<A NAME="repeat_delay"></A>
226<A NAME="SEC182"></A>
227<H3> repeat_delay </H3>
228<!--docid::SEC182::-->
229<P>
230
231Sets the number of seconds to wait before the emission is repeated when stopped by a limited <A HREF="manual_29.html#SEC180">duration</A>. See also the repeat_delay_min and repeat_delay_max attributes which allow you to set a range of repeat_delays instead of a fixed one.<BR><BR>
232</P><P>
233
234format: repeat_delay &#60;seconds&#62;<BR>
235example:<BR>
236    repeat_delay 2.5<BR>
237default: 0<BR>
238<BR>
239</P><P>
240
241<A NAME="repeat_delay_min"></A>
242<A NAME="repeat_delay_max"></A>
243<A NAME="SEC183"></A>
244<H3> repeat_delay_min &#38; repeat_delay_max </H3>
245<!--docid::SEC183::-->
246<P>
247
248As repeat_delay, except this sets a range of repeat delays and each time the emitter is started it gets a random value inbetween.<BR><BR>
249</P><P>
250
251format: as repeat_delay<BR>
252example:<BR>
253    repeat_delay 2<BR>
254    repeat_delay 5<BR>
255default: both 0<BR>
256<BR>
257</P><P>
258
259See also: <A HREF="manual_30.html#SEC184">3.3.4 Standard Particle Emitters</A>, <A HREF="manual_26.html#SEC145">3.3 Particle Scripts</A>, <A HREF="manual_31.html#SEC191">3.3.5 Particle Affectors</A>
260</P><P>
261
262<A NAME="Standard Particle Emitters"></A>
263<HR SIZE=1>
264<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
265<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_28.html#SEC167"> &lt; </A>]</TD>
266<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_26.html#SEC145"> Up </A>]</TD>
267<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_30.html#SEC184"> &gt; </A>]</TD>
268<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
269<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
270<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
271<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
272</TR></TABLE>
273<BR> 
274<FONT SIZE="-1">
275This document was generated
276by <I>Steve Streeting</I> on <I>, 12 2006</I>
277using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
278"><I>texi2html</I></A>
279
280</BODY>
281</HTML>
Note: See TracBrowser for help on using the repository browser.