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

135 lines
6.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class osgParticle::AccelOperator</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">osgParticle::AccelOperator</A></H2></H2><BLOCKQUOTE>An operator class that applies a constant acceleration to the particles</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=95>
<param name=classes value="Mosg::Object,M,COperator,MOperator.html,CAccelOperator,MAccelOperator.html">
<param name=before value="M,M,M">
<param name=after value="Md_SP,Md_,M">
<param name=indent value="0,1,2">
<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.1.1">META_Object</A></B>(<!1><A HREF="osgParticle.html">osgParticle</A>, <!1><A HREF="AccelOperator.html">AccelOperator</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.1.6">AccelOperator</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.1.7">AccelOperator</A></B>(const <!1><A HREF="AccelOperator.html#DOC.2.1.7">AccelOperator</A> &amp;copy, const osg::CopyOp &amp;copyop)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const osg::Vec3&amp; <B><A HREF="#DOC.2.1.8">getAcceleration</A></B>() const
<DD><I>Get the acceleration vector</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.1.9">setAcceleration</A></B>(const osg::Vec3 &amp;v)
<DD><I>Set the acceleration vector</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.1.10">setToGravity</A></B>(float scale)
<DD><I>Quickly set the acceleration vector to the gravity on earth (0, 0, -981).</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.1.11">operate</A></B>(<!1><A HREF="Particle.html">Particle</A>* P, double dt)
<DD><I>Apply the acceleration to a particle.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.1.12">beginOperate</A></B>(<!1><A HREF="Program.html">Program</A>* prg)
<DD><I>Perform some initializations.</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.1.2">~AccelOperator</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="AccelOperator.html">AccelOperator</A>&amp; <B><A HREF="#DOC.2.1.3">operator=</A></B>(const <!1><A HREF="AccelOperator.html">AccelOperator</A> &amp;)
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Operator.html">Operator</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>endOperate</B>()
<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)
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>An operator class that applies a constant acceleration to the particles</BLOCKQUOTE>
<DL>
<A NAME="META_Object"></A>
<A NAME="DOC.2.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> META_Object(<!1><A HREF="osgParticle.html">osgParticle</A>, <!1><A HREF="AccelOperator.html">AccelOperator</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~AccelOperator"></A>
<A NAME="DOC.2.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~AccelOperator()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator="></A>
<A NAME="DOC.2.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="AccelOperator.html">AccelOperator</A>&amp; operator=(const <!1><A HREF="AccelOperator.html">AccelOperator</A> &amp;)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="AccelOperator"></A>
<A NAME="DOC.2.1.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline AccelOperator()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="AccelOperator"></A>
<A NAME="DOC.2.1.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline AccelOperator(const <!1><A HREF="AccelOperator.html#DOC.2.1.7">AccelOperator</A> &amp;copy, const osg::CopyOp &amp;copyop)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getAcceleration"></A>
<A NAME="DOC.2.1.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const osg::Vec3&amp; getAcceleration() const </B></TT>
<DD>Get the acceleration vector
<DL><DT><DD></DL><P>
<A NAME="setAcceleration"></A>
<A NAME="DOC.2.1.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setAcceleration(const osg::Vec3 &amp;v)</B></TT>
<DD>Set the acceleration vector
<DL><DT><DD></DL><P>
<A NAME="setToGravity"></A>
<A NAME="DOC.2.1.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setToGravity(float scale)</B></TT>
<DD>Quickly set the acceleration vector to the gravity on earth (0, 0, -981).
The acceleration will be multiplied by the <CODE>scale</CODE> parameter.
<DL><DT><DD></DL><P>
<A NAME="operate"></A>
<A NAME="DOC.2.1.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void operate(<!1><A HREF="Particle.html">Particle</A>* P, double dt)</B></TT>
<DD>Apply the acceleration to a particle. Do not call this method manually.
<DL><DT><DD></DL><P>
<A NAME="beginOperate"></A>
<A NAME="DOC.2.1.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void beginOperate(<!1><A HREF="Program.html">Program</A>* prg)</B></TT>
<DD>Perform some initializations. Do not call this method manually.
<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>