Fixed doxygen comments.
This commit is contained in:
parent
57d333fd0f
commit
b8b6ed8e34
@ -71,7 +71,7 @@ class OSGGA_EXPORT UFOManipulator : public osgGA::MatrixManipulator
|
|||||||
virtual void setByMatrix( const osg::Matrixd &matrix ) ;
|
virtual void setByMatrix( const osg::Matrixd &matrix ) ;
|
||||||
|
|
||||||
/** Set the current position with the invers matrix
|
/** Set the current position with the invers matrix
|
||||||
\param invmatrix The inverse of a viewpoint matrix
|
\param invmat The inverse of a viewpoint matrix
|
||||||
*/
|
*/
|
||||||
virtual void setByInverseMatrix( const osg::Matrixd &invmat);
|
virtual void setByInverseMatrix( const osg::Matrixd &invmat);
|
||||||
|
|
||||||
@ -84,7 +84,7 @@ class OSGGA_EXPORT UFOManipulator : public osgGA::MatrixManipulator
|
|||||||
/** Set the subgraph this manipulator is driving the eye through.
|
/** Set the subgraph this manipulator is driving the eye through.
|
||||||
\param node root of subgraph
|
\param node root of subgraph
|
||||||
*/
|
*/
|
||||||
virtual void setNode(osg::Node*);
|
virtual void setNode(osg::Node* node);
|
||||||
|
|
||||||
/** Get the root node of the subgraph this manipulator is driving the eye through (const)*/
|
/** Get the root node of the subgraph this manipulator is driving the eye through (const)*/
|
||||||
virtual const osg::Node* getNode() const;
|
virtual const osg::Node* getNode() const;
|
||||||
|
@ -27,8 +27,8 @@ namespace osgParticle
|
|||||||
{
|
{
|
||||||
|
|
||||||
/** An operator that applies a constant force to the particles.
|
/** An operator that applies a constant force to the particles.
|
||||||
Remember that if the mass of particles is expressed in <U>kg</U> and the lengths are
|
* Remember that if the mass of particles is expressed in kg and the lengths are
|
||||||
expressed in <U>meters</U>, then the force should be expressed in <U>Newtons</U>.
|
* expressed in meters, then the force should be expressed in Newtons.
|
||||||
*/
|
*/
|
||||||
class ForceOperator: public Operator {
|
class ForceOperator: public Operator {
|
||||||
public:
|
public:
|
||||||
|
@ -30,10 +30,10 @@ namespace osgParticle
|
|||||||
{
|
{
|
||||||
|
|
||||||
/** A common base interface for those classes which need to do something on particles. Such classes
|
/** A common base interface for those classes which need to do something on particles. Such classes
|
||||||
are, for example, <CODE>Emitter</CODE> (particle generation) and <CODE>Program</CODE> (particle animation).
|
* are, for example, Emitter (particle generation) and Program (particle animation).
|
||||||
This class holds some properties, like a <I>reference frame</I> and a reference to a <CODE>ParticleSystem<CODE>;
|
* This class holds some properties, like a <I>reference frame</I> and a reference to a ParticleSystem;
|
||||||
descendant classes should process the particles taking into account the reference frame, computing the right
|
* descendant classes should process the particles taking into account the reference frame, computing the right
|
||||||
transformations when needed.
|
* transformations when needed.
|
||||||
*/
|
*/
|
||||||
class OSGPARTICLE_EXPORT ParticleProcessor: public osg::Node {
|
class OSGPARTICLE_EXPORT ParticleProcessor: public osg::Node {
|
||||||
public:
|
public:
|
||||||
|
@ -34,10 +34,10 @@ namespace osgParticle
|
|||||||
{
|
{
|
||||||
|
|
||||||
/** The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction.
|
/** The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction.
|
||||||
You can add this drawable to any <CODE>Geode</CODE> as you usually do with other
|
* You can add this drawable to any Geode as you usually do with other
|
||||||
<CODE>Drawable</CODE> classes. Each instance of <CODE>ParticleSystem</CODE> is a separate set of
|
* Drawable classes. Each instance of ParticleSystem is a separate set of
|
||||||
particles; it provides the interface for creating particles and iterating
|
* particles; it provides the interface for creating particles and iterating
|
||||||
through them (see the <CODE>Emitter</CODE> and <CODE>Program</CODE> classes).
|
* through them (see the Emitter and Program classes).
|
||||||
*/
|
*/
|
||||||
class OSGPARTICLE_EXPORT ParticleSystem: public osg::Drawable {
|
class OSGPARTICLE_EXPORT ParticleSystem: public osg::Drawable {
|
||||||
public:
|
public:
|
||||||
@ -87,9 +87,9 @@ namespace osgParticle
|
|||||||
|
|
||||||
/** Set the double pass rendering flag.
|
/** Set the double pass rendering flag.
|
||||||
Double pass rendering avoids overdraw problems between particle systems
|
Double pass rendering avoids overdraw problems between particle systems
|
||||||
and other opaque objects. If you can render all the particle systems <U>after</U>
|
and other opaque objects. If you can render all the particle systems after
|
||||||
the opaque objects, then double pass is not necessary and can be turned off (best choice).
|
the opaque objects, then double pass is not necessary and can be turned off (best choice).
|
||||||
If you set the default attributes with <CODE>setDefaultAttributes</CODE>, then the particle
|
If you set the default attributes with setDefaultAttributes, then the particle
|
||||||
system will fall into a transparent bin.
|
system will fall into a transparent bin.
|
||||||
*/
|
*/
|
||||||
inline void setDoublePassRendering(bool v);
|
inline void setDoublePassRendering(bool v);
|
||||||
|
@ -32,9 +32,9 @@ namespace osgParticle
|
|||||||
{
|
{
|
||||||
|
|
||||||
/** A useful node class for updating particle systems automatically.
|
/** A useful node class for updating particle systems automatically.
|
||||||
When a <CODE>ParticleSystemUpdater</CODE> is traversed by a cull visitor, it calls the
|
When a ParticleSystemUpdater is traversed by a cull visitor, it calls the
|
||||||
<CODE>update()</CODE> method on the specified particle systems. You should place this updater
|
update() method on the specified particle systems. You should place this updater
|
||||||
<U>AFTER</U> other nodes like emitters and programs.
|
AFTER other nodes like emitters and programs.
|
||||||
*/
|
*/
|
||||||
class OSGPARTICLE_EXPORT ParticleSystemUpdater: public osg::Node {
|
class OSGPARTICLE_EXPORT ParticleSystemUpdater: public osg::Node {
|
||||||
public:
|
public:
|
||||||
|
@ -55,7 +55,7 @@ class OSGPRODUCER_EXPORT OsgCameraGroup : public Producer::CameraGroup
|
|||||||
const osg::ApplicationUsage* getApplicationUsage() const { return _applicationUsage; }
|
const osg::ApplicationUsage* getApplicationUsage() const { return _applicationUsage; }
|
||||||
|
|
||||||
|
|
||||||
typedef std::vector < Producer::ref_ptr<osgProducer::OsgSceneHandler> > SceneHandlerList;
|
typedef std::vector < osg::ref_ptr<osgProducer::OsgSceneHandler> > SceneHandlerList;
|
||||||
|
|
||||||
SceneHandlerList& getSceneHandlerList() { return _shvec;}
|
SceneHandlerList& getSceneHandlerList() { return _shvec;}
|
||||||
|
|
||||||
|
@ -102,12 +102,13 @@ public:
|
|||||||
Construct a ScalarBar with the supplied parameters.
|
Construct a ScalarBar with the supplied parameters.
|
||||||
@param numColors Specify the number of colors in the scalar bar. Color
|
@param numColors Specify the number of colors in the scalar bar. Color
|
||||||
interpolation occurs where necessary.
|
interpolation occurs where necessary.
|
||||||
|
@param numLabels Specify the number of labels in the scalar bar.
|
||||||
@param stc The ScalarsToColors defining the range of scalars
|
@param stc The ScalarsToColors defining the range of scalars
|
||||||
and the colors they map to.
|
and the colors they map to.
|
||||||
@param title The title to be used when displaying the ScalarBar.
|
@param title The title to be used when displaying the ScalarBar.
|
||||||
Specify "" for no title.
|
Specify "" for no title.
|
||||||
@param orientation The orientation of the ScalarBar. @see Orientation.
|
@param orientation The orientation of the ScalarBar. @see Orientation.
|
||||||
@param apectRatio The aspect ration (y/x) for the displayed bar. Bear in mind you
|
@param aspectRatio The aspect ration (y/x) for the displayed bar. Bear in mind you
|
||||||
may want to change this if you change the orientation.
|
may want to change this if you change the orientation.
|
||||||
@param sp A ScalarPrinter object for the ScalarBar. For every displayed
|
@param sp A ScalarPrinter object for the ScalarBar. For every displayed
|
||||||
ScalarBar label, the scalar value will be passed to the
|
ScalarBar label, the scalar value will be passed to the
|
||||||
|
@ -94,7 +94,7 @@ public:
|
|||||||
@param centre sphere centre
|
@param centre sphere centre
|
||||||
@param radius radius of sphere
|
@param radius radius of sphere
|
||||||
@param azMin azimuth minimum
|
@param azMin azimuth minimum
|
||||||
@param azMin azimuth maximum
|
@param azMax azimuth maximum
|
||||||
@param elevMin elevation minimum
|
@param elevMin elevation minimum
|
||||||
@param elevMax elevation maximum
|
@param elevMax elevation maximum
|
||||||
@param density number of units to divide the azimuth and elevation ranges into
|
@param density number of units to divide the azimuth and elevation ranges into
|
||||||
@ -155,7 +155,7 @@ public:
|
|||||||
@param azRange azimuth range in radians (with centre along vec)
|
@param azRange azimuth range in radians (with centre along vec)
|
||||||
@param elevRange elevation range in radians (with centre along vec)
|
@param elevRange elevation range in radians (with centre along vec)
|
||||||
*/
|
*/
|
||||||
void setArea(const osg::Vec3& v, float azRange, float elevRange);
|
void setArea(const osg::Vec3& vec, float azRange, float elevRange);
|
||||||
|
|
||||||
/** Get the area of the sphere segment
|
/** Get the area of the sphere segment
|
||||||
|
|
||||||
@ -164,11 +164,11 @@ public:
|
|||||||
@param azRange azimuth range in radians (with centre along vec)
|
@param azRange azimuth range in radians (with centre along vec)
|
||||||
@param elevRange elevation range in radians (with centre along vec)
|
@param elevRange elevation range in radians (with centre along vec)
|
||||||
*/
|
*/
|
||||||
void getArea(osg::Vec3& v, float& azRange, float& elevRange) const;
|
void getArea(osg::Vec3& vec, float& azRange, float& elevRange) const;
|
||||||
|
|
||||||
/** Set the area of the sphere segment
|
/** Set the area of the sphere segment
|
||||||
@param azMin azimuth minimum
|
@param azMin azimuth minimum
|
||||||
@param azMin azimuth maximum
|
@param azMax azimuth maximum
|
||||||
@param elevMin elevation minimum
|
@param elevMin elevation minimum
|
||||||
@param elevMax elevation maximum
|
@param elevMax elevation maximum
|
||||||
*/
|
*/
|
||||||
@ -176,7 +176,7 @@ public:
|
|||||||
|
|
||||||
/** Get the area of the sphere segment
|
/** Get the area of the sphere segment
|
||||||
@param azMin azimuth minimum
|
@param azMin azimuth minimum
|
||||||
@param azMin azimuth maximum
|
@param azMax azimuth maximum
|
||||||
@param elevMin elevation minimum
|
@param elevMin elevation minimum
|
||||||
@param elevMax elevation maximum
|
@param elevMax elevation maximum
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user