OgreRibbonTrail.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/

#ifndef __RibbonTrail_H__
#define __RibbonTrail_H__

#include "OgrePrerequisites.h"

#include "OgreBillboardChain.h"
#include "OgreNode.h"
#include "OgreIteratorWrappers.h"
#include "OgreFrameListener.h"
#include "OgreControllerManager.h"

namespace Ogre {

    class _OgreExport RibbonTrail : public BillboardChain, public Node::Listener
    {
    public:
        RibbonTrail(const String& name, size_t maxElements = 20, size_t numberOfChains = 1, 
            bool useTextureCoords = true, bool useColours = true);
        virtual ~RibbonTrail();

        typedef std::vector<Node*> NodeList;
        typedef ConstVectorIterator<NodeList> NodeIterator;

        virtual void addNode(Node* n);
        virtual void removeNode(Node* n);
        virtual NodeIterator getNodeIterator(void) const;

        virtual void setTrailLength(Real len);
        virtual Real getTrailLength(void) const { return mTrailLength; }

        void setMaxChainElements(size_t maxElements);
        void setNumberOfChains(size_t numChains);

        virtual void setInitialColour(size_t chainIndex, const ColourValue& col);
        virtual void setInitialColour(size_t chainIndex, Real r, Real g, Real b, Real a = 1.0);
        virtual const ColourValue& getInitialColour(size_t chainIndex) const;

        virtual void setColourChange(size_t chainIndex, const ColourValue& valuePerSecond);

        virtual void setInitialWidth(size_t chainIndex, Real width);
        virtual Real getInitialWidth(size_t chainIndex) const;
        
        virtual void setWidthChange(size_t chainIndex, Real widthDeltaPerSecond);
        virtual Real getWidthChange(size_t chainIndex) const;

        virtual void setColourChange(size_t chainIndex, Real r, Real g, Real b, Real a);

        virtual const ColourValue& getColourChange(size_t chainIndex) const;

        void nodeUpdated(const Node* node);
        void nodeDestroyed(const Node* node);

        virtual void _timeUpdate(Real time);

    protected:
        NodeList mNodeList;
        Real mTrailLength;
        Real mElemLength;
        Real mSquaredElemLength;
        typedef std::vector<ColourValue> ColourValueList;
        typedef std::vector<Real> RealList;
        ColourValueList mInitialColour;
        ColourValueList mDeltaColour;
        RealList mInitialWidth;
        RealList mDeltaWidth;
        Controller<Real>* mFadeController;
        ControllerValueRealPtr mTimeControllerValue;

        virtual void manageController(void);
        virtual void updateTrail(size_t index, const Node* node);


    };


    class _OgreExport RibbonTrailFactory : public MovableObjectFactory
    {
    protected:
        MovableObject* createInstanceImpl( const String& name, const NameValuePairList* params);
    public:
        RibbonTrailFactory() {}
        ~RibbonTrailFactory() {}

        static String FACTORY_TYPE_NAME;

        const String& getType(void) const;
        void destroyInstance( MovableObject* obj);  

    };

}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:48 2006