OgreInstanceBatchVTF.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.
-----------------------------------------------------------------------------
*/
#ifndef __BaseInstanceBatchVTF_H__
#define __BaseInstanceBatchVTF_H__

#include "OgreInstanceBatch.h"
#include "OgreTexture.h"

namespace Ogre
{
    class _OgreExport BaseInstanceBatchVTF : public InstanceBatch
    {
    protected:
        typedef vector<uint8>::type HWBoneIdxVec;
        typedef vector<float>::type HWBoneWgtVec;
        typedef vector<Matrix4>::type Matrix4Vec;

        size_t                  mMatricesPerInstance; //number of bone matrices per instance
        size_t                  mNumWorldMatrices;  //Num bones * num instances
        TexturePtr              mMatrixTexture; //The VTF

        //Used when all matrices from each instance must be in the same row (i.e. HW Instancing).
        //A few pixels are wasted, but resizing the texture puts the danger of not sampling the
        //right pixel... (in theory it should work, but in practice doesn't)
        size_t                  mWidthFloatsPadding;
        size_t                  mMaxFloatsPerLine;

        size_t                  mRowLength;
        size_t                  mWeightCount;
        //Temporary array used to store 3x4 matrices before they are converted to dual quaternions
        float*                  mTempTransformsArray3x4;

        // The state of the usage of bone matrix lookup
        bool mUseBoneMatrixLookup;
        size_t mMaxLookupTableInstances;

        bool mUseBoneDualQuaternions;
        bool mForceOneWeight;
        bool mUseOneWeight;

        void cloneMaterial( const MaterialPtr &material );

        void retrieveBoneIdx( VertexData *baseVertexData, HWBoneIdxVec &outBoneIdx );

        void retrieveBoneIdxWithWeights(VertexData *baseVertexData, HWBoneIdxVec &outBoneIdx, HWBoneWgtVec &outBoneWgt);

        void setupMaterialToUseVTF( TextureType textureType, MaterialPtr &material );

        void createVertexTexture( const SubMesh* baseSubMesh );

        virtual void createVertexSemantics( VertexData *thisVertexData, VertexData *baseVertexData,
                                    const HWBoneIdxVec &hwBoneIdx, const HWBoneWgtVec &hwBoneWgt) = 0;

        size_t convert3x4MatricesToDualQuaternions(float* matrices, size_t numOfMatrices, float* outDualQuaternions);
                                    
        void updateVertexTexture(void);

        virtual bool matricesToghetherPerRow() const = 0;

        virtual void updateSharedLookupIndexes();

        virtual InstancedEntity* generateInstancedEntity(size_t num);

    public:
        BaseInstanceBatchVTF( InstanceManager *creator, MeshPtr &meshReference, const MaterialPtr &material,
                            size_t instancesPerBatch, const Mesh::IndexMap *indexToBoneMap,
                            const String &batchName);
        virtual ~BaseInstanceBatchVTF();

        void buildFrom( const SubMesh *baseSubMesh, const RenderOperation &renderOperation );

        //Renderable overloads
        void getWorldTransforms( Matrix4* xform ) const;
        unsigned short getNumWorldTransforms(void) const;

        void _updateRenderQueue(RenderQueue* queue);

        void setBoneMatrixLookup(bool enable, size_t maxLookupTableInstances) { assert(mInstancedEntities.empty()); 
            mUseBoneMatrixLookup = enable; mMaxLookupTableInstances = maxLookupTableInstances; }

        bool useBoneMatrixLookup() const { return mUseBoneMatrixLookup; }

        void setBoneDualQuaternions(bool enable) { assert(mInstancedEntities.empty());
            mUseBoneDualQuaternions = enable; mRowLength = (mUseBoneDualQuaternions ? 2 : 3); }

        bool useBoneDualQuaternions() const { return mUseBoneDualQuaternions; }

        void setForceOneWeight(bool enable) {  assert(mInstancedEntities.empty());
            mForceOneWeight = enable; }

        bool forceOneWeight() const { return mForceOneWeight; }

        void setUseOneWeight(bool enable) {  assert(mInstancedEntities.empty());
            mUseOneWeight = enable; }

        bool useOneWeight() const { return mUseOneWeight; }

        virtual bool useBoneWorldMatrices() const { return !mUseBoneMatrixLookup; }

        virtual size_t getMaxLookupTableInstances() const { return mMaxLookupTableInstances; }
        
    };

    class _OgreExport InstanceBatchVTF : public BaseInstanceBatchVTF
    {
        
        void setupVertices( const SubMesh* baseSubMesh );
        void setupIndices( const SubMesh* baseSubMesh );

        void createVertexSemantics( VertexData *thisVertexData, VertexData *baseVertexData,
            const HWBoneIdxVec &hwBoneIdx, const HWBoneWgtVec &hwBoneWgt );

        virtual bool matricesToghetherPerRow() const { return false; }
    public:
        InstanceBatchVTF( InstanceManager *creator, MeshPtr &meshReference, const MaterialPtr &material,
                            size_t instancesPerBatch, const Mesh::IndexMap *indexToBoneMap,
                            const String &batchName);
        virtual ~InstanceBatchVTF();

        size_t calculateMaxNumInstances( const SubMesh *baseSubMesh, uint16 flags ) const;
    };
}

#endif