OpenSceneGraph/doc/doc++/osgParticle/SectorPlacer.html
Robert Osfield ed10594139 Updated docs
2004-08-06 06:53:36 +00:00

157 lines
7.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class osgParticle::SectorPlacer</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">osgParticle::SectorPlacer</A></H2></H2><BLOCKQUOTE>A sector-shaped particle placer.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125>
<param name=classes value="Mosg::Object,M,CPlacer,MPlacer.html,CCenteredPlacer,MCenteredPlacer.html,CSectorPlacer,MSectorPlacer.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.31.1">META_Object</A></B>(<!1><A HREF="osgParticle.html">osgParticle</A>, <!1><A HREF="SectorPlacer.html">SectorPlacer</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.31.6">SectorPlacer</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <B><A HREF="#DOC.2.31.7">SectorPlacer</A></B>(const <!1><A HREF="SectorPlacer.html#DOC.2.31.7">SectorPlacer</A> &amp;copy, const osg::CopyOp &amp;copyop)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="rangef.html">rangef</A>&amp; <B><A HREF="#DOC.2.31.8">getRadiusRange</A></B>() const
<DD><I>Get the range of possible values for radius</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="rangef.html">rangef</A>&amp; <B><A HREF="#DOC.2.31.9">getPhiRange</A></B>() const
<DD><I>Get the range of possible values for the central angle</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.31.10">setRadiusRange</A></B>(const <!1><A HREF="rangef.html">rangef</A> &amp;r)
<DD><I>Set the range of possible values for radius</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.31.11">setRadiusRange</A></B>(float r1, float r2)
<DD><I>Set the range of possible values for radius</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.31.12">setPhiRange</A></B>(const <!1><A HREF="rangef.html">rangef</A> &amp;r)
<DD><I>Set the range of possible values for the central angle</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.31.13">setPhiRange</A></B>(float r1, float r2)
<DD><I>Set the range of possible values for the central angle</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.31.14">place</A></B>(<!1><A HREF="Particle.html">Particle</A>* P) const
<DD><I>Place a particle.</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.31.2">~SectorPlacer</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="SectorPlacer.html">SectorPlacer</A>&amp; <B><A HREF="#DOC.2.31.3">operator=</A></B>(const <!1><A HREF="SectorPlacer.html">SectorPlacer</A> &amp;)
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="CenteredPlacer.html">CenteredPlacer</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>inline const osg::Vec3&amp; <B>getCenter</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setCenter</B>(const osg::Vec3 &amp;v)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setCenter</B>(float x, float y, float z)
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Placer.html">Placer</A>:</H3>
<DL>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>A sector-shaped particle placer.
This placer sets the initial position of incoming particle by choosing a random position
within a circular sector; this sector is defined by three parameters: a <I>center point</I>,
which is inherited directly from <CODE>osgParticle::CenteredPlacer</CODE>, a range of values
for <I>radius</I>, and a range of values for the <I>central angle</I> (sometimes called <B>phi</B>). </BLOCKQUOTE>
<DL>
<A NAME="META_Object"></A>
<A NAME="DOC.2.31.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="SectorPlacer.html">SectorPlacer</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~SectorPlacer"></A>
<A NAME="DOC.2.31.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~SectorPlacer()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator="></A>
<A NAME="DOC.2.31.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="SectorPlacer.html">SectorPlacer</A>&amp; operator=(const <!1><A HREF="SectorPlacer.html">SectorPlacer</A> &amp;)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SectorPlacer"></A>
<A NAME="DOC.2.31.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline SectorPlacer()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="SectorPlacer"></A>
<A NAME="DOC.2.31.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline SectorPlacer(const <!1><A HREF="SectorPlacer.html#DOC.2.31.7">SectorPlacer</A> &amp;copy, const osg::CopyOp &amp;copyop)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getRadiusRange"></A>
<A NAME="DOC.2.31.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="rangef.html">rangef</A>&amp; getRadiusRange() const </B></TT>
<DD>Get the range of possible values for radius
<DL><DT><DD></DL><P>
<A NAME="getPhiRange"></A>
<A NAME="DOC.2.31.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="rangef.html">rangef</A>&amp; getPhiRange() const </B></TT>
<DD>Get the range of possible values for the central angle
<DL><DT><DD></DL><P>
<A NAME="setRadiusRange"></A>
<A NAME="DOC.2.31.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setRadiusRange(const <!1><A HREF="rangef.html">rangef</A> &amp;r)</B></TT>
<DD>Set the range of possible values for radius
<DL><DT><DD></DL><P>
<A NAME="setRadiusRange"></A>
<A NAME="DOC.2.31.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setRadiusRange(float r1, float r2)</B></TT>
<DD>Set the range of possible values for radius
<DL><DT><DD></DL><P>
<A NAME="setPhiRange"></A>
<A NAME="DOC.2.31.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setPhiRange(const <!1><A HREF="rangef.html">rangef</A> &amp;r)</B></TT>
<DD>Set the range of possible values for the central angle
<DL><DT><DD></DL><P>
<A NAME="setPhiRange"></A>
<A NAME="DOC.2.31.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setPhiRange(float r1, float r2)</B></TT>
<DD>Set the range of possible values for the central angle
<DL><DT><DD></DL><P>
<A NAME="place"></A>
<A NAME="DOC.2.31.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void place(<!1><A HREF="Particle.html">Particle</A>* P) const </B></TT>
<DD>Place a particle. Do not call it 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://www.linuxsupportline.com/~doc++">DOC++</A>.
</BODY>
</HTML>