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

90 lines
3.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>template<class T_> struct osgParticle::range</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>template&lt;class T_&gt; struct <A HREF="#DOC.DOCU">osgParticle::range</A></H2></H2><BLOCKQUOTE> A simple struct template useful to store ranges of values as min/max pairs.</BLOCKQUOTE>
<HR>
<P><DL>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>T_ <B><A HREF="#DOC.2.26.1">minimum</A></B>
<DD><I>Lower bound</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>T_ <B><A HREF="#DOC.2.26.2">maximum</A></B>
<DD><I>Higher bound</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.26.3">range</A></B>()
<DD><I>Construct the object by calling default constructors for min and max</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.26.4">range</A></B>(const T_ &amp;mn, const T_ &amp;mx)
<DD><I>Construct and initialize min and max directly</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.26.5">set</A></B>(const T_ &amp;mn, const T_ &amp;mx)
<DD><I>Set min and max</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>T_ <B><A HREF="#DOC.2.26.6">get_random</A></B>() const
<DD><I>Get a random value between min and max</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>T_ <B><A HREF="#DOC.2.26.7">get_random_sqrtf</A></B>() const
<DD><I>Get a random square root value between min and max</I>
</DL></P>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>
A simple struct template useful to store ranges of values as min/max pairs.
This struct template helps storing min/max ranges for values of any kind; class <CODE>T_</CODE> is
the type of values to be stored, and it must support operations <CODE>T_ + T_</CODE>, <CODE>T_ - T_</CODE>,
and <CODE>T_ * float</CODE>, otherwise the <CODE>get_random()</CODE> method will not compile.
This struct could be extended to customize the random number generator (now it uses only
<CODE>std::rand()</CODE>).</BLOCKQUOTE>
<DL>
<A NAME="minimum"></A>
<A NAME="DOC.2.26.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>T_ minimum</B></TT>
<DD>Lower bound
<DL><DT><DD></DL><P>
<A NAME="maximum"></A>
<A NAME="DOC.2.26.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>T_ maximum</B></TT>
<DD>Higher bound
<DL><DT><DD></DL><P>
<A NAME="range"></A>
<A NAME="DOC.2.26.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> range()</B></TT>
<DD>Construct the object by calling default constructors for min and max
<DL><DT><DD></DL><P>
<A NAME="range"></A>
<A NAME="DOC.2.26.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> range(const T_ &amp;mn, const T_ &amp;mx)</B></TT>
<DD>Construct and initialize min and max directly
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.2.26.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void set(const T_ &amp;mn, const T_ &amp;mx)</B></TT>
<DD>Set min and max
<DL><DT><DD></DL><P>
<A NAME="get_random"></A>
<A NAME="DOC.2.26.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>T_ get_random() const </B></TT>
<DD>Get a random value between min and max
<DL><DT><DD></DL><P>
<A NAME="get_random_sqrtf"></A>
<A NAME="DOC.2.26.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>T_ get_random_sqrtf() const </B></TT>
<DD>Get a random square root value between min and max
<DL><DT><DD></DL><P></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>