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

Revision 657, 7.5 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: Standard Particle Emitters</TITLE>
15
16<META NAME="description" CONTENT="OGRE Manual v1.0.7: Standard Particle Emitters">
17<META NAME="keywords" CONTENT="OGRE Manual v1.0.7: Standard Particle Emitters">
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="SEC122"></A>
27<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
28<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_24.html#SEC107"> &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_26.html#SEC129"> &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.4 Standard Particle Emitters </H3>
38<!--docid::SEC122::-->
39Ogre comes preconfigured with a few particle emitters. New ones can be added by creating plugins: see the Plugin_ParticleFX project as an example of how you would do this (this is where these emitters are implemented).
40<P>
41
42<UL>
43<LI>
44<A HREF="manual_25.html#SEC123">Point Emitter</A>
45<LI>
46<A HREF="manual_25.html#SEC124">Box Emitter</A>
47<LI>
48<A HREF="manual_25.html#SEC125">Cylinder Emitter</A>
49<LI>
50<A HREF="manual_25.html#SEC126">Ellipsoid Emitter</A>
51<LI>
52<A HREF="manual_25.html#SEC127">Hollow Ellipsoid Emitter</A>
53<LI>
54<A HREF="manual_25.html#SEC128">Ring Emitter</A>
55</UL>
56<BR><BR>
57<A NAME="Point Emitter"></A>
58<A NAME="SEC123"></A>
59<H3> Point Emitter </H3>
60<!--docid::SEC123::-->
61<P>
62
63This emitter emits particles from a single point, which is it's position. This emitter has no additional attributes over an above the standard emitter attributes.<BR><BR>
64</P><P>
65
66To create a point emitter, include a section like this within your particle system script:
67<TABLE><tr><td>&nbsp;</td><td class=example><pre>
68emitter Point
69{
70    // Settings go here
71}
72</pre></td></tr></table><BR>
73Please note that the name of the emitter ('Point') is case-sensitive.
74</P><P>
75
76<A NAME="Box Emitter"></A>
77<A NAME="SEC124"></A>
78<H3> Box Emitter </H3>
79<!--docid::SEC124::-->
80<P>
81
82This emitter emits particles from a random location within a 3-dimensional box. It's extra attributes are:<BR><BR>
83<DL COMPACT>
84<DT>width
85<DD>Sets the width of the box (this is the size of the box along it's local X axis, which is dependent on the 'direction' attribute which forms the box's local Z).<BR>
86format: width &#60;units&#62;<BR>
87example: width 250<BR>
88default: 100<BR>
89<DT>height
90<DD>Sets the height of the box (this is the size of the box along it's local Y axis, which is dependent on the 'direction' attribute which forms the box's local Z).<BR>
91format: height &#60;units&#62;<BR>
92example: height 250<BR>
93default: 100<BR>
94<DT>depth
95<DD>Sets the depth of the box (this is the size of the box along it's local Z axis, which is the same as the 'direction' attribute).<BR>
96format: depth &#60;units&#62;<BR>
97example: depth 250<BR>
98default: 100<BR>
99</DL>
100<BR>
101To create a box emitter, include a section like this within your particle system script:
102<TABLE><tr><td>&nbsp;</td><td class=example><pre>emitter Box
103{
104    // Settings go here
105}
106</pre></td></tr></table><P>
107
108<A NAME="Cylinder Emitter"></A>
109<A NAME="SEC125"></A>
110<H3> Cylinder Emitter </H3>
111<!--docid::SEC125::-->
112<P>
113
114This emitter emits particles in a random direction from within a cylinder area, where the cylinder is oriented along the Z-axis. This emitter has exactly the same parameters as the <A HREF="manual_25.html#SEC124">Box Emitter</A> so there are no additional parameters to consider here - the width and height determine the shape of the cylinder along it's axis (if they are different it is an ellipsoid cylinder), the depth determines the length of the cylinder.
115</P><P>
116
117<A NAME="Ellipsoid Emitter"></A>
118<A NAME="SEC126"></A>
119<H3> Ellipsoid Emitter </H3>
120<!--docid::SEC126::-->
121This emitter emits particles from within an ellipsoid shaped area, ie a sphere or squashed-sphere area. The parameters are again identical to the <A HREF="manual_25.html#SEC124">Box Emitter</A>, except that the dimensions describe the widest points along each of the axes.
122<P>
123
124<A NAME="Hollow Ellipsoid Emitter"></A>
125<A NAME="SEC127"></A>
126<H3> Hollow Ellipsoid Emitter </H3>
127<!--docid::SEC127::-->
128This emitter is just like <A HREF="manual_25.html#SEC126">Ellipsoid Emitter</A> except that there is a hollow area in the centre of the ellipsoid from which no particles are emitted. Therefore it has 3 extra parameters in order to define this area:
129<P>
130
131<DL COMPACT>
132<DT>inner_width
133<DD>The width of the inner area which does not emit any particles.
134<DT>inner_height
135<DD>The height of the inner area which does not emit any particles.
136<DT>inner_depth
137<DD>The depth of the inner area which does not emit any particles.
138</DL>
139<P>
140
141<A NAME="Ring Emitter"></A>
142<A NAME="SEC128"></A>
143<H3> Ring Emitter </H3>
144<!--docid::SEC128::-->
145This emitter emits particles from a ring-shaped area, ie a little like <A HREF="manual_25.html#SEC127">Hollow Ellipsoid Emitter</A> except only in 2 dimensions.
146<P>
147
148<DL COMPACT>
149<DT>inner_width
150<DD>The width of the inner area which does not emit any particles.
151<DT>inner_height
152<DD>The height of the inner area which does not emit any particles.
153</DL>
154<BR><BR>
155<P>
156
157See also: <A HREF="manual_21.html#SEC93">3.2 Particle Scripts</A>, <A HREF="manual_23.html#SEC105">3.2.2 Particle Emitters</A>
158</P><P>
159
160<A NAME="Particle Affectors"></A>
161<HR SIZE=1>
162<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
163<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_24.html#SEC107"> &lt; </A>]</TD>
164<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC93"> Up </A>]</TD>
165<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_26.html#SEC129"> &gt; </A>]</TD>
166<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>
167<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
168<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
169<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
170</TR></TABLE>
171<BR> 
172<FONT SIZE="-1">
173This document was generated
174by <I>Steve Streeting</I> on <I>, 12 2006</I>
175using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
176"><I>texi2html</I></A>
177
178</BODY>
179</HTML>
Note: See TracBrowser for help on using the repository browser.