source: OGRE/trunk/ogrenew/Docs/manual/manual_22.html @ 657

Revision 657, 8.2 KB checked in by mattausch, 19 years ago (diff)

added ogre dependencies and patched ogre sources
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.0.7: Particle System Attributes</TITLE>
15
16<META NAME="description" CONTENT="OGRE Manual v1.0.7: Particle System Attributes">
17<META NAME="keywords" CONTENT="OGRE Manual v1.0.7: Particle System 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="SEC97"></A>
27<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
28<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC93"> &lt; </A>]</TD>
29<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC93"> Up </A>]</TD>
30<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_23.html#SEC105"> &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.2.1 Particle System Attributes </H3>
38<!--docid::SEC97::-->
39This section describes to attributes which you can set on every particle system using scripts. All atributes have default values so all settings are optional in your script.<BR><BR>
40<P>
41
42<A NAME="quota"></A>
43<A NAME="SEC98"></A>
44<H3> quota </H3>
45<!--docid::SEC98::-->
46<P>
47
48Sets the maximum number of particles this system is allowed to contain at one time. When this limit is exhausted, the emitters will not be allowed to emit any more particles until some destroyed (e.g. through their time_to_live running out). Note that you will almost always want to change this, since it defaults to a very low value (particle pools are only ever increased in size, never decreased).<BR><BR>
49</P><P>
50
51format: quota &#60;max_particles&#62;<BR>
52example: quota 10000<BR>
53default: 10<BR>
54</P><P>
55
56<A NAME="particle_material"></A>
57<A NAME="SEC99"></A>
58<H3> material </H3>
59<!--docid::SEC99::-->
60<P>
61
62Sets the name of the material which all particles in this system will use. All paticles in a system use the same material, although each particle can tint this material through the use of it's colour property.<BR><BR>
63</P><P>
64
65format: material &#60;material_name&#62;<BR>
66example: material Examples/Flare<BR>
67default: none (blank material)<BR>
68</P><P>
69
70<A NAME="particle_width"></A>
71<A NAME="SEC100"></A>
72<H3> particle_width </H3>
73<!--docid::SEC100::-->
74<P>
75
76Sets the width of particles in world coordinates. Note that this property is absolute when billboard_type (see below) is set to 'point', but is scaled by the length of the direction vector when billboard_type is 'oriented_common' or 'oriented_self'.<BR>
77</P><P>
78
79format: particle_width &#60;width&#62;<BR>
80example: particle_width 20<BR>
81default: 100<BR>
82</P><P>
83
84<A NAME="particle_height"></A>
85<A NAME="SEC101"></A>
86<H3> particle_height </H3>
87<!--docid::SEC101::-->
88<P>
89
90Sets the height of particles in world coordinates. Note that this property is absolute when billboard_type (see below) is set to 'point', but is scaled by the length of the direction vector when billboard_type is 'oriented_common' or 'oriented_self'.<BR>
91</P><P>
92
93format: particle_height &#60;height&#62;<BR>
94example: particle_height 20<BR>
95default: 100<BR>
96</P><P>
97
98<A NAME="cull_each"></A>
99<A NAME="SEC102"></A>
100<H3> cull_each </H3>
101<!--docid::SEC102::-->
102<P>
103
104All particle systems are culled by the bounding box which contains all the particles in the system. This is normally sufficient for fairly locally constrained particle systems where most particles are either visible or not visible together. However, for those that spread particles over a wider area (e.g. a rain system), you may want to actually cull each particle individually to save on time, since it is far more likely that only a subset of the particles will be visible. You do this by setting the cull_each parameter to true.<BR><BR>
105</P><P>
106
107format: cull_each &#60;true|false&#62;<BR>
108example: cull_each true<BR>
109default: false<BR>
110</P><P>
111
112<A NAME="billboard_type"></A>
113<A NAME="SEC103"></A>
114<H3> billboard_type </H3>
115<!--docid::SEC103::-->
116<P>
117
118Particles are rendered using billboards, which are rectangles formed by 2 triangles which rotate to face the camera. However, there is more than 1 way to orient a billboard. The classic approach is for the billboard to directly face the camera: this is the default behaviour. However this arrangement only looks good for particles which are representing something vaguely spherical like a light flare. For more linear effectd like laser fire, you actually want the particle to have an orientation of it's own.<BR><BR>
119</P><P>
120
121format: billboard_type &#60;point|oriented_common|oriented_self&#62;<BR>
122example: billboard_type oriented_self<BR>
123default: point<BR>
124</P><P>
125
126The options for this parameter are:
127<DL COMPACT>
128<DT>point
129<DD>    The default arrangement, this approximates spherical particles and the billboards always fully face the camera.
130<DT>oriented_common
131<DD>    Particles are oriented around a common, typically fixed direction vector (see <A HREF="manual_22.html#SEC104">common_direction</A>), which acts as their local Y axis. The billboard roatates only around this axis, giving the particle some sense of direction. Good for rainstorms, starfields etc where the particles will travelling in one direction - this is slightly faster than oriented_self (see below).
132<DT>oriented_self
133<DD>    Particles are oriented around their own direction vector, which acts as their local Y axis. As the particle changes direction, so the billboard reorients itself to face this way. Good for laser fire, fireworks and other 'streaky' particles that should look like they are travelling in their own direction.
134</DL>
135<P>
136
137<A NAME="common_direction"></A>
138<A NAME="SEC104"></A>
139<H3> common_direction </H3>
140<!--docid::SEC104::-->
141<P>
142
143Only required if <A HREF="manual_22.html#SEC103">billboard_type</A> is set to oriented_common, this vector is the common direction vector used to orient all particles in the system.<BR><BR>
144</P><P>
145
146format: common_direction &#60;x&#62; &#60;y&#62; &#60;z&#62;<BR>
147example: common_direction 0 -1 0<BR>
148default: none<BR>
149<BR><BR>
150See also: <A HREF="manual_23.html#SEC105">3.2.2 Particle Emitters</A>, <A HREF="manual_26.html#SEC129">3.2.5 Particle Affectors</A>
151</P><P>
152
153<A NAME="Particle Emitters"></A>
154<HR SIZE=1>
155<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
156<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC93"> &lt; </A>]</TD>
157<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC93"> Up </A>]</TD>
158<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_23.html#SEC105"> &gt; </A>]</TD>
159<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>
160<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
161<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
162<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
163</TR></TABLE>
164<BR> 
165<FONT SIZE="-1">
166This document was generated
167by <I>Steve Streeting</I> on <I>, 12 2006</I>
168using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
169"><I>texi2html</I></A>
170
171</BODY>
172</HTML>
Note: See TracBrowser for help on using the repository browser.