<HTML>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- Created on , 21 2004 by texi2html 1.64 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
-->
<HEAD>
<TITLE>OGRE Manual: Particle Emitter Attributes</TITLE>
<META NAME="description" CONTENT="OGRE Manual: Particle Emitter Attributes">
<META NAME="keywords" CONTENT="OGRE Manual: Particle Emitter Attributes">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="texi2html 1.64">
<LINK TYPE="text/css" rel="stylesheet" href="../style.css">
</HEAD>
<BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
<A NAME="SEC95"></A>
<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_24.html#SEC93"> < </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_22.html#SEC82"> Up </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_26.html#SEC107"> > </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
</TR></TABLE>
<HR SIZE=1>
<H3> 3.2.3 Particle Emitter Attributes </H3>
<!--docid::SEC95::-->
This section describes the common attributes of all particle emitters. Specific emitter types may also support their own extra attributes.<BR><BR>
<P>
<A NAME="angle"></A>
<A NAME="SEC96"></A>
<H3> angle </H3>
<!--docid::SEC96::-->
<P>
Sets 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>
</P><P>
format: angle <degrees><BR>
example: angle 30<BR>
default: 0<BR>
</P><P>
<A NAME="colour"></A>
<A NAME="SEC97"></A>
<H3> colour </H3>
<!--docid::SEC97::-->
<P>
Sets 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>
</P><P>
format: colour <r> <g> <b> [<a>]<BR>
example: colour 1 0 0 1<BR>
default: 1 1 1 1<BR>
</P><P>
<A NAME="colour_range_start"></A>
<A NAME="colour_range_end"></A>
<A NAME="SEC98"></A>
<H3> colour_range_start & colour_range_end </H3>
<!--docid::SEC98::-->
<P>
As 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>
</P><P>
format: as colour<BR>
example (generates random colours between red and blue):<BR>
colour_range_start 1 0 0<BR>
colour_range_end 0 0 1<BR>
default: both 1 1 1 1<BR>
</P><P>
<A NAME="direction"></A>
<A NAME="SEC99"></A>
<H3> direction </H3>
<!--docid::SEC99::-->
<P>
Sets 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>
</P><P>
format: direction <x> <y> <z><BR>
example: direction 0 1 0<BR>
default: 1 0 0<BR>
</P><P>
<A NAME="emission_rate"></A>
<A NAME="SEC100"></A>
<H3> emission_rate </H3>
<!--docid::SEC100::-->
<P>
Sets 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
and 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>
</P><P>
format: emission_rate <particles_per_second><BR>
example: emission_rate 50<BR>
default: 10<BR>
</P><P>
<A NAME="position"></A>
<A NAME="SEC101"></A>
<H3> position </H3>
<!--docid::SEC101::-->
<P>
Sets the position of the emitter relative to the SceneNode the particle system is attached to.<BR><BR>
</P><P>
format: position <x> <y> <z><BR>
example: position 10 0 40<BR>
default: 0 0 0<BR>
</P><P>
<A NAME="velocity"></A>
<A NAME="SEC102"></A>
<H3> velocity </H3>
<!--docid::SEC102::-->
<P>
Sets 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>
</P><P>
format: velocity <world_units_per_second><BR>
example: velocity 100<BR>
default: 1<BR>
</P><P>
<A NAME="velocity_min"></A>
<A NAME="velocity_max"></A>
<A NAME="SEC103"></A>
<H3> velocity_min & velocity_max </H3>
<!--docid::SEC103::-->
<P>
As 'velocity' except these attributes set a velocity range and each particle is emitted with a random velocity within this range.<BR><BR>
</P><P>
format: as velocity<BR>
example:<BR>
velocity_min 50<BR>
velocity_max 100<BR>
default: both 1<BR>
</P><P>
<A NAME="time_to_live"></A>
<A NAME="SEC104"></A>
<H3> time_to_live </H3>
<!--docid::SEC104::-->
<P>
Sets 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>
</P><P>
format: time_to_live <seconds><BR>
example: time_to_live 10<BR>
default: 5<BR>
</P><P>
<A NAME="time_to_live_min"></A>
<A NAME="time_to_live_max"></A>
<A NAME="SEC105"></A>
<H3> time_to_live_min & time_to_live_max </H3>
<!--docid::SEC105::-->
As time_to_live, except this sets a range of lifetimes and each particle gets a random value inbetween on emission.<BR><BR>
<P>
format: as time_to_live<BR>
example:<BR>
time_to_live_min 2<BR>
time_to_live_max 5<BR>
default: both 5<BR>
<BR>
</P><P>
<A NAME="common_direction"></A>
<A NAME="SEC106"></A>
<H3> common_direction </H3>
<!--docid::SEC106::-->
Only required if <A HREF="manual_23.html#SEC92">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>
format: common_direction <x> <y> <z><BR>
example: common_direction 0 -1 0<BR>
default: none<BR>
<P>
See also: <A HREF="manual_26.html#SEC107">3.2.4 Standard Particle Emitters</A>, <A HREF="manual_22.html#SEC82">3.2 Particle Scripts</A>, <A HREF="manual_27.html#SEC114">3.2.5 Particle Affectors</A>
</P><P>
<A NAME="Standard Particle Emitters"></A>
<HR SIZE=1>
<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_24.html#SEC93"> < </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_22.html#SEC82"> Up </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_26.html#SEC107"> > </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
</TR></TABLE>
<BR>
<FONT SIZE="-1">
This document was generated
by <I>Steve Streeting</I> on <I>, 21 2004</I>
using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
"><I>texi2html</I></A>
</BODY>
</HTML>
