OgreBillboardChain.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-2012 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.
-----------------------------------------------------------------------------
*/

// Thanks to Vincent Cantin (karmaGfa) for the original implementation of this
// class, although it has now been mostly rewritten

#ifndef _BillboardChain_H__
#define _BillboardChain_H__

#include "OgrePrerequisites.h"

#include "OgreMovableObject.h"
#include "OgreRenderable.h"
#include "OgreResourceGroupManager.h"

namespace Ogre {

    class _OgreExport BillboardChain : public MovableObject, public Renderable
    {

    public:

        class _OgreExport Element
        {

        public:

            Element();

            Element(const Vector3 &position,
                Real width,
                Real texCoord,
                const ColourValue &colour,
                const Quaternion &orientation);

            Vector3 position;
            Real width;
            Real texCoord;
            ColourValue colour;

            //Only used when mFaceCamera == false
            Quaternion orientation;
        };
        typedef vector<Element>::type ElementList;

        BillboardChain(const String& name, size_t maxElements = 20, size_t numberOfChains = 1, 
            bool useTextureCoords = true, bool useColours = true, bool dynamic = true);
        virtual ~BillboardChain();

        virtual void setMaxChainElements(size_t maxElements);
        virtual size_t getMaxChainElements(void) const { return mMaxElementsPerChain; }
        virtual void setNumberOfChains(size_t numChains);
        virtual size_t getNumberOfChains(void) const { return mChainCount; }

        virtual void setUseTextureCoords(bool use);
        virtual bool getUseTextureCoords(void) const { return mUseTexCoords; }

        enum TexCoordDirection
        {
            TCD_U,
            TCD_V
        };
        virtual void setTextureCoordDirection(TexCoordDirection dir);
        virtual TexCoordDirection getTextureCoordDirection(void) { return mTexCoordDir; }

        virtual void setOtherTextureCoordRange(Real start, Real end);
        virtual const Real* getOtherTextureCoordRange(void) const { return mOtherTexCoordRange; }

        virtual void setUseVertexColours(bool use);
        virtual bool getUseVertexColours(void) const { return mUseVertexColour; }

        virtual void setDynamic(bool dyn);

        virtual bool getDynamic(void) const { return mDynamic; }
        
        virtual void addChainElement(size_t chainIndex, 
            const Element& billboardChainElement);
        virtual void removeChainElement(size_t chainIndex);
        virtual void updateChainElement(size_t chainIndex, size_t elementIndex, 
            const Element& billboardChainElement);
        virtual const Element& getChainElement(size_t chainIndex, size_t elementIndex) const;

        virtual size_t getNumChainElements(size_t chainIndex) const;

        virtual void clearChain(size_t chainIndex);
        virtual void clearAllChains(void);

        void setFaceCamera( bool faceCamera, const Vector3 &normalVector=Vector3::UNIT_X );

        virtual const String& getMaterialName(void) const { return mMaterialName; }
        virtual void setMaterialName( const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );


        // Overridden members follow
        void _notifyCurrentCamera(Camera* cam);
        Real getSquaredViewDepth(const Camera* cam) const;
        Real getBoundingRadius(void) const;
        const AxisAlignedBox& getBoundingBox(void) const;
        const MaterialPtr& getMaterial(void) const;
        const String& getMovableType(void) const;
        void _updateRenderQueue(RenderQueue *);
        void getRenderOperation(RenderOperation &);
        void getWorldTransforms(Matrix4 *) const;
        const LightList& getLights(void) const;
        void visitRenderables(Renderable::Visitor* visitor, 
            bool debugRenderables = false);



    protected:

        size_t mMaxElementsPerChain;
        size_t mChainCount;
        bool mUseTexCoords;
        bool mUseVertexColour;
        bool mDynamic;
        VertexData* mVertexData;
        IndexData* mIndexData;
        bool mVertexDeclDirty;
        bool mBuffersNeedRecreating;
        mutable bool mBoundsDirty;
        bool mIndexContentDirty;
        mutable AxisAlignedBox mAABB;
        mutable Real mRadius;
        String mMaterialName;
        MaterialPtr mMaterial;
        TexCoordDirection mTexCoordDir;
        Real mOtherTexCoordRange[2];
        bool mFaceCamera;
        Vector3 mNormalBase;


        ElementList mChainElementList;

        struct ChainSegment
        {
            size_t start;
            size_t head;
            size_t tail;
        };
        typedef vector<ChainSegment>::type ChainSegmentList;
        ChainSegmentList mChainSegmentList;

        virtual void setupChainContainers(void);
        virtual void setupVertexDeclaration(void);
        // Setup buffers
        virtual void setupBuffers(void);
        virtual void updateVertexBuffer(Camera* cam);
        virtual void updateIndexBuffer(void);
        virtual void updateBoundingBox(void) const;

        static const size_t SEGMENT_EMPTY;
    };


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

        static String FACTORY_TYPE_NAME;

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

    };

} // namespace

#endif