OgreManualObject.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-2011 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 __OgreManualObject_H__
#define __OgreManualObject_H__

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


namespace Ogre
{
    class _OgreExport ManualObject : public MovableObject
    {
    public:
        ManualObject(const String& name);
        virtual ~ManualObject();

        //pre-declare ManualObjectSection
        class ManualObjectSection;

        virtual void clear(void);
        
        virtual void estimateVertexCount(size_t vcount);

        virtual void estimateIndexCount(size_t icount);

        virtual void begin(const String& materialName,
            RenderOperation::OperationType opType = RenderOperation::OT_TRIANGLE_LIST, const String & groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);

        virtual void setDynamic(bool dyn) { mDynamic = dyn; }
        virtual bool getDynamic() const { return mDynamic; }

        virtual void beginUpdate(size_t sectionIndex);
        virtual void position(const Vector3& pos);
        virtual void position(Real x, Real y, Real z);

        virtual void normal(const Vector3& norm);
        virtual void normal(Real x, Real y, Real z);

        virtual void tangent(const Vector3& tan);
        virtual void tangent(Real x, Real y, Real z);

        virtual void textureCoord(Real u);
        virtual void textureCoord(Real u, Real v);
        virtual void textureCoord(Real u, Real v, Real w);
        virtual void textureCoord(Real x, Real y, Real z, Real w);
        virtual void textureCoord(const Vector2& uv);
        virtual void textureCoord(const Vector3& uvw);
        virtual void textureCoord(const Vector4& xyzw);

        virtual void colour(const ColourValue& col);
        virtual void colour(Real r, Real g, Real b, Real a = 1.0f);

        virtual void index(uint32 idx);
        virtual void triangle(uint32 i1, uint32 i2, uint32 i3);
        virtual void quad(uint32 i1, uint32 i2, uint32 i3, uint32 i4);

        virtual ManualObjectSection* end(void);

        virtual void setMaterialName(size_t subindex, const String& name, const String & group = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);

        virtual MeshPtr convertToMesh(const String& meshName, 
            const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);

        void setUseIdentityProjection(bool useIdentityProjection);

        bool getUseIdentityProjection(void) const { return mUseIdentityProjection; }

        void setUseIdentityView(bool useIdentityView);

        bool getUseIdentityView(void) const { return mUseIdentityView; }

        void setBoundingBox(const AxisAlignedBox& box) { mAABB = box; }

        ManualObjectSection* getSection(unsigned int index) const;

        unsigned int getNumSections(void) const;
        void setKeepDeclarationOrder(bool keepOrder) { mKeepDeclarationOrder = keepOrder; }

        bool getKeepDeclarationOrder() const { return mKeepDeclarationOrder; }
        // MovableObject overrides

        const String& getMovableType(void) const;
        const AxisAlignedBox& getBoundingBox(void) const;
        Real getBoundingRadius(void) const;
        void _updateRenderQueue(RenderQueue* queue);
        EdgeData* getEdgeList(void);
        bool hasEdgeList(void);
        ShadowRenderableListIterator getShadowVolumeRenderableIterator(
            ShadowTechnique shadowTechnique, const Light* light, 
            HardwareIndexBufferSharedPtr* indexBuffer, 
            bool extrudeVertices, Real extrusionDist, unsigned long flags = 0);


        class _OgreExport ManualObjectSection : public Renderable, public MovableAlloc
        {
        protected:
            ManualObject* mParent;
            String mMaterialName;
            String mGroupName;
            mutable MaterialPtr mMaterial;
            RenderOperation mRenderOperation;
            bool m32BitIndices;

            
        public:
            ManualObjectSection(ManualObject* parent, const String& materialName,
                RenderOperation::OperationType opType, const String & groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);
            virtual ~ManualObjectSection();
            
            RenderOperation* getRenderOperation(void);
            const String& getMaterialName(void) const { return mMaterialName; }
            const String& getMaterialGroup(void) const { return mGroupName; }
            void setMaterialName(const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
            void set32BitIndices(bool n32) { m32BitIndices = n32; }
            bool get32BitIndices() const { return m32BitIndices; }
            
            // Renderable overrides
            const MaterialPtr& getMaterial(void) const;
            void getRenderOperation(RenderOperation& op);
            void getWorldTransforms(Matrix4* xform) const;
            Real getSquaredViewDepth(const Ogre::Camera *) const;
            const LightList &getLights(void) const;


                    
        };
        class _OgreExport ManualObjectSectionShadowRenderable : public ShadowRenderable
        {
        protected:
            ManualObject* mParent;
            // Shared link to position buffer
            HardwareVertexBufferSharedPtr mPositionBuffer;
            // Shared link to w-coord buffer (optional)
            HardwareVertexBufferSharedPtr mWBuffer;

        public:
            ManualObjectSectionShadowRenderable(ManualObject* parent, 
                HardwareIndexBufferSharedPtr* indexBuffer, const VertexData* vertexData, 
                bool createSeparateLightCap, bool isLightCap = false);
            ~ManualObjectSectionShadowRenderable();
            void getWorldTransforms(Matrix4* xform) const;
            HardwareVertexBufferSharedPtr getPositionBuffer(void) { return mPositionBuffer; }
            HardwareVertexBufferSharedPtr getWBuffer(void) { return mWBuffer; }

        };

        typedef vector<ManualObjectSection*>::type SectionList;

        void visitRenderables(Renderable::Visitor* visitor, 
            bool debugRenderables = false);
        
        
    protected:
        bool mDynamic;
        SectionList mSectionList;
        ManualObjectSection* mCurrentSection;
        bool mCurrentUpdating;
        struct TempVertex
        {
            Vector3 position;
            Vector3 normal;
            Vector3 tangent;
            Vector4 texCoord[OGRE_MAX_TEXTURE_COORD_SETS];
            ushort texCoordDims[OGRE_MAX_TEXTURE_COORD_SETS];
            ColourValue colour;
        };
        TempVertex mTempVertex;
        bool mFirstVertex;
        bool mTempVertexPending;
        char* mTempVertexBuffer;
        size_t mTempVertexSize;
        uint32* mTempIndexBuffer;
        size_t mTempIndexSize;
        size_t mDeclSize;
        size_t mEstVertexCount;
        size_t mEstIndexCount;
        ushort mTexCoordIndex;
        AxisAlignedBox mAABB;
        Real mRadius;
        bool mAnyIndexed;
        EdgeData* mEdgeList;
        ShadowRenderableList mShadowRenderables;
        bool mUseIdentityProjection;
        bool mUseIdentityView;
        bool mKeepDeclarationOrder;


        virtual void resetTempAreas(void);
        virtual void resizeTempVertexBufferIfNeeded(size_t numVerts);
        virtual void resizeTempIndexBufferIfNeeded(size_t numInds);

        virtual void copyTempVertexToBuffer(void);

    };


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

        static String FACTORY_TYPE_NAME;

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

    };
}

#endif