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-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __RibbonTrail_H__
#define __RibbonTrail_H__

#include "OgrePrerequisites.h"

#include "OgreBillboardChain.h"
#include "OgreNode.h"
#include "OgreIteratorWrappers.h"
#include "OgreFrameListener.h"
#include "OgreControllerManager.h"
#include "OgreHeaderPrefix.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 useVertexColours = true);
        virtual ~RibbonTrail();

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

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

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

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

        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);

        const String& getMovableType(void) const;

    protected:
        NodeList mNodeList;
        typedef vector<size_t>::type IndexVector;
        IndexVector mNodeToChainSegment;
        // chains not in use
        IndexVector mFreeChains;

        // fast lookup node->chain index
        // we use positional map too because that can be useful
        typedef map<const Node*, size_t>::type NodeToChainSegmentMap;
        NodeToChainSegmentMap mNodeToSegMap;

        Real mTrailLength;
        Real mElemLength;
        Real mSquaredElemLength;
        typedef vector<ColourValue>::type ColourValueList;
        typedef vector<Real>::type 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);
        virtual void resetTrail(size_t index, const Node* node);
        virtual void resetAllTrails(void);

    };


    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);  

    };
}

#include "OgreHeaderSuffix.h"

#endif