openscenegraph
osgParticle/Program
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13//osgParticle - Copyright (C) 2002 Marco Jez
14
15#ifndef OSGPARTICLE_PROGRAM
16#define OSGPARTICLE_PROGRAM 1
17
18#include <osgParticle/Export>
19#include <osgParticle/ParticleProcessor>
20
21#include <osg/Object>
22#include <osg/Node>
23#include <osg/NodeVisitor>
24#include <osg/CopyOp>
25
26namespace osgParticle
27{
28
29 /** An abstract <CODE>ParticleProcessor</CODE> descendant for modifying particles "on the fly"
30 during the cull traversal.
31 Descendants of this class must implement the <CODE>execute()</CODE> method, which should iterate
32 through all particles in the linked particle system and modify them somehow
33 (usually updating their velocity vector).
34 */
35 class OSGPARTICLE_EXPORT Program: public ParticleProcessor
36 {
37 public:
38 Program();
39 Program(const Program& copy, const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY);
40
41 virtual const char* libraryName() const { return "osgParticle"; }
42 virtual const char* className() const { return "Program"; }
43 virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const Program*>(obj) != 0; }
44 virtual void accept(osg::NodeVisitor& nv) { if (nv.validNodeMask(*this)) { nv.pushOntoNodePath(this); nv.apply(*this); nv.popFromNodePath(); } }
45
46 protected:
47 virtual ~Program() {}
48 Program& operator=(const Program&) { return *this; }
49
50 /// Implementation of <CODE>ParticleProcessor::process()</CODE>. Do not call this method by yourself.
51 inline void process(double dt);
52
53 /// Execute the program on the particle system. Must be overridden in descendant classes.
54 virtual void execute(double dt) = 0;
55
56 private:
57 };
58
59 // INLINE FUNCTIONS
60
61 inline void Program::process(double dt)
62 {
63 execute(dt);
64 }
65
66}
67
68#endif