FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

From Alberto Luaces, "it seems that include/osgParticle/BoxPlacer was created from the SectorPlacer

Browse Source 
file. The code works well but the SectorPlacer comments stayed in the new
file. I have altered those comments so they now contain valid information for
the BoxPlacer class and the doxygen generated documentation is correct.

"
This commit is contained in:
Robert Osfield
2007-12-11 11:37:03 +00:00
parent 4e5ce63c85
commit b467fdeb6c
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
include/osgParticle/BoxPlacer
View File

@@ -27,42 +27,42 @@
namespace osgParticle
{
/** A sector-shaped particle placer.
/** A box-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>).
within the volume of a box; this placer is defined by four parameters: a <I>center point</I>,
which is inherited directly from <CODE>osgParticle::CenteredPlacer</CODE>, and three ranges of values
for the valid <I>X</I>, <I>Y</I>, and <I>Z</I> coordinates.
*/
class BoxPlacer: public CenteredPlacer {
public:
inline BoxPlacer();
inline BoxPlacer(const BoxPlacer& copy, const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY);
/// Get the range of possible values for radius.
/// Get the range of possible values along the X axis.
inline const rangef& getXRange() const;
/// Set the range of possible values for radius.
/// Set the range of possible values along the X axis.
inline void setXRange(const rangef& r);
/// Set the range of possible values for radius.
/// Set the range of possible values along the X axis.
inline void setXRange(float r1, float r2);
/// Get the range of possible values for the central angle.
/// Get the range of possible values along the Y axis.
inline const rangef& getYRange() const;
/// Set the range of possible values for the central angle.
/// Set the range of possible values along the Y axis.
inline void setYRange(const rangef& r);
/// Set the range of possible values for the central angle.
/// Set the range of possible values along the Y axis.
inline void setYRange(float r1, float r2);
/// Get the range of possible values for the height.
/// Get the range of possible values along the Z axis.
inline const rangef& getZRange() const;
/// Set the range of possible values for the height.
/// Set the range of possible values along the Z axis.
inline void setZRange(const rangef& r);
/// Set the range of possible values for the height.
/// Set the range of possible values along the Z axis.
inline void setZRange(float r1, float r2);
META_Object(osgParticle, BoxPlacer);