OpenSceneGraph/doc/doc++/osgParticle/ModularEmitter.html
2003-04-17 16:22:51 +00:00

226 lines
10 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGPARTICLE_EXPORT osgParticle::ModularEmitter</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGPARTICLE_EXPORT <A HREF="#DOC.DOCU">osgParticle::ModularEmitter</A></H2></H2><BLOCKQUOTE>An emitter class that holds three objects to control the creation of particles.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125>
<param name=classes value="Mosg::Node,M,CParticleProcessor,MParticleProcessor.html,CEmitter,MEmitter.html,CModularEmitter,MModularEmitter.html">
<param name=before value="M,M,M,M">
<param name=after value="Md_SPSP,Md_SP,Md_,M">
<param name=indent value="0,1,2,3">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.9.1">ModularEmitter</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.9.2">ModularEmitter</A></B>(const <!1><A HREF="ModularEmitter.html#DOC.2.9.2">ModularEmitter</A> &amp;copy, const osg::CopyOp &amp;copyop = osg::CopyOp::SHALLOW_COPY)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.9.3">META_Node</A></B>(<!1><A HREF="osgParticle.html">osgParticle</A>, <!1><A HREF="ModularEmitter.html">ModularEmitter</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Counter.html">Counter</A>* <B><A HREF="#DOC.2.9.10">getCounter</A></B>()
<DD><I>Get the counter object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Counter.html">Counter</A>* <B><A HREF="#DOC.2.9.11">getCounter</A></B>() const
<DD><I>Get the const Counter object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.9.12">setCounter</A></B>(<!1><A HREF="Counter.html">Counter</A>* c)
<DD><I>Set the Counter object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Placer.html">Placer</A>* <B><A HREF="#DOC.2.9.13">getPlacer</A></B>()
<DD><I>Get the Placer object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Placer.html">Placer</A>* <B><A HREF="#DOC.2.9.14">getPlacer</A></B>() const
<DD><I>Get the const Placer object.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.9.15">setPlacer</A></B>(<!1><A HREF="Placer.html">Placer</A>* p)
<DD><I>Set the Placer object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Shooter.html">Shooter</A>* <B><A HREF="#DOC.2.9.16">getShooter</A></B>()
<DD><I>Get the Shooter object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Shooter.html">Shooter</A>* <B><A HREF="#DOC.2.9.17">getShooter</A></B>() const
<DD><I>Get the const Shooter object</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.9.18">setShooter</A></B>(<!1><A HREF="Shooter.html">Shooter</A>* s)
<DD><I>Set the Shooter object</I>
</DL></P>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.9.4">~ModularEmitter</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ModularEmitter.html">ModularEmitter</A>&amp; <B><A HREF="#DOC.2.9.5">operator=</A></B>(const <!1><A HREF="ModularEmitter.html">ModularEmitter</A> &amp;)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.9.6">emit</A></B>(double dt)
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Emitter.html">Emitter</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>virtual const char* <B>libraryName</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual const char* <B>className</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual bool <B>isSameKindAs</B>(const osg::Object* obj) const
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual void <B>accept</B>(osg::NodeVisitor&amp; nv)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline const <!1><A HREF="Particle.html">Particle</A>&amp; <B>getParticleTemplate</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setParticleTemplate</B>(const <!1><A HREF="Particle.html">Particle</A> &amp;p)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline bool <B>getUseDefaultTemplate</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setUseDefaultTemplate</B>(bool v)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>process</B>(double dt)
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="ParticleProcessor.html">ParticleProcessor</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="ParticleProcessor.html#DOC.2.14.1">ReferenceFrame</A> <B>getReferenceFrame</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>traverse</B>(osg::NodeVisitor &amp;nv)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline ParticleProcessor::ReferenceFrame <B>getReferenceFrame</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setReferenceFrame</B>(<!1><A HREF="ParticleProcessor.html#DOC.2.14.1">ReferenceFrame</A> rf)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline bool <B>isEnabled</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setEnabled</B>(bool v)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="ParticleSystem.html">ParticleSystem</A>* <B>getParticleSystem</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>inline const <!1><A HREF="ParticleSystem.html">ParticleSystem</A>* <B>getParticleSystem</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setParticleSystem</B>(<!1><A HREF="ParticleSystem.html">ParticleSystem</A>* ps)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline bool <B>computeBound</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline const osg::Matrix&amp; <B>getLocalToWorldMatrix</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>inline const osg::Matrix&amp; <B>getWorldToLocalMatrix</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>inline osg::Vec3 <B>transformLocalToWorld</B>(const osg::Vec3 &amp;P)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline osg::Vec3 <B>transformWorldToLocal</B>(const osg::Vec3 &amp;P)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline osg::Vec3 <B>rotateLocalToWorld</B>(const osg::Vec3 &amp;P)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline osg::Vec3 <B>rotateWorldToLocal</B>(const osg::Vec3 &amp;P)
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>enum <B>ReferenceFrame</B>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>An emitter class that holds three objects to control the creation of particles.
These objects are a <I>counter</I>, a <I>placer</I> and a <I>shooter</I>.
The counter controls the number of particles to be emitted at each frame;
the placer must initialize the particle's position vector, while the shooter initializes
its velocity vector.
You can use the predefined counter/placer/shooter classes, or you can create your own.</BLOCKQUOTE>
<DL>
<A NAME="ModularEmitter"></A>
<A NAME="DOC.2.9.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ModularEmitter()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ModularEmitter"></A>
<A NAME="DOC.2.9.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ModularEmitter(const <!1><A HREF="ModularEmitter.html#DOC.2.9.2">ModularEmitter</A> &amp;copy, const osg::CopyOp &amp;copyop = osg::CopyOp::SHALLOW_COPY)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="META_Node"></A>
<A NAME="DOC.2.9.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> META_Node(<!1><A HREF="osgParticle.html">osgParticle</A>, <!1><A HREF="ModularEmitter.html">ModularEmitter</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~ModularEmitter"></A>
<A NAME="DOC.2.9.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~ModularEmitter()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator="></A>
<A NAME="DOC.2.9.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ModularEmitter.html">ModularEmitter</A>&amp; operator=(const <!1><A HREF="ModularEmitter.html">ModularEmitter</A> &amp;)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="emit"></A>
<A NAME="DOC.2.9.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void emit(double dt)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCounter"></A>
<A NAME="DOC.2.9.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Counter.html">Counter</A>* getCounter()</B></TT>
<DD>Get the counter object
<DL><DT><DD></DL><P>
<A NAME="getCounter"></A>
<A NAME="DOC.2.9.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Counter.html">Counter</A>* getCounter() const </B></TT>
<DD>Get the const Counter object
<DL><DT><DD></DL><P>
<A NAME="setCounter"></A>
<A NAME="DOC.2.9.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setCounter(<!1><A HREF="Counter.html">Counter</A>* c)</B></TT>
<DD>Set the Counter object
<DL><DT><DD></DL><P>
<A NAME="getPlacer"></A>
<A NAME="DOC.2.9.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Placer.html">Placer</A>* getPlacer()</B></TT>
<DD>Get the Placer object
<DL><DT><DD></DL><P>
<A NAME="getPlacer"></A>
<A NAME="DOC.2.9.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Placer.html">Placer</A>* getPlacer() const </B></TT>
<DD>Get the const Placer object.
<DL><DT><DD></DL><P>
<A NAME="setPlacer"></A>
<A NAME="DOC.2.9.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setPlacer(<!1><A HREF="Placer.html">Placer</A>* p)</B></TT>
<DD>Set the Placer object
<DL><DT><DD></DL><P>
<A NAME="getShooter"></A>
<A NAME="DOC.2.9.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Shooter.html">Shooter</A>* getShooter()</B></TT>
<DD>Get the Shooter object
<DL><DT><DD></DL><P>
<A NAME="getShooter"></A>
<A NAME="DOC.2.9.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Shooter.html">Shooter</A>* getShooter() const </B></TT>
<DD>Get the const Shooter object
<DL><DT><DD></DL><P>
<A NAME="setShooter"></A>
<A NAME="DOC.2.9.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setShooter(<!1><A HREF="Shooter.html">Shooter</A>* s)</B></TT>
<DD>Set the Shooter object
<DL><DT><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></DL>
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>