OgreInstancedEntity.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 __InstancedEntity_H__
#define __InstancedEntity_H__

#include "OgreMovableObject.h"
#include "OgreNode.h"
#include "OgreHeaderPrefix.h"

namespace Ogre
{
    class _OgreExport InstancedEntity : public Ogre::MovableObject
    {
        friend class InstanceBatch;
        friend class InstanceBatchShader;
        friend class InstanceBatchHW;
        friend class InstanceBatchHW_VTF;
        friend class BaseInstanceBatchVTF;
    protected:
        uint16 mInstanceId; //Note it may change after defragmenting!
        bool mInUse;
        InstanceBatch *mBatchOwner;

        AnimationStateSet *mAnimationState;
        SkeletonInstance *mSkeletonInstance;
        Matrix4 *mBoneMatrices;  //Local space
        Matrix4 *mBoneWorldMatrices; //World space
        unsigned long mFrameAnimationLastUpdated;

        InstancedEntity* mSharedTransformEntity;    //When not null, another InstancedEntity controls the skeleton
                                                
        uint16 mTransformLookupNumber;

        typedef vector<InstancedEntity*>::type InstancedEntityVec;
        InstancedEntityVec mSharingPartners;

        // Parameters used for local transformation offset information
        // The 

        Vector3 mPosition;
        Vector3 mDerivedLocalPosition;
        Quaternion mOrientation;
        Vector3 mScale;
        Real mMaxScaleLocal;
        Matrix4 mFullLocalTransform;
        bool mNeedTransformUpdate;
        bool mNeedAnimTransformUpdate;
        bool mUseLocalTransform;


        size_t getTransforms( Matrix4 *xform ) const;
        size_t getTransforms3x4( float *xform ) const;

        bool findVisible( Camera *camera ) const;

        void createSkeletonInstance();
        void destroySkeletonInstance();

        void stopSharingTransformAsSlave( bool notifyMaster );

        void unlinkTransform( bool notifyMaster=true );

        void notifyUnlink( const InstancedEntity *slave );

        inline void markTransformDirty();

        static NameGenerator msNameGenerator;

    public:
        InstancedEntity( InstanceBatch *batchOwner, uint32 instanceID, InstancedEntity* sharedTransformEntity = NULL);
        virtual ~InstancedEntity();

        bool shareTransformWith( InstancedEntity *slave );

        void stopSharingTransform();

        InstanceBatch* _getOwner() const { return mBatchOwner; }

        const String& getMovableType(void) const;

        const AxisAlignedBox& getBoundingBox(void) const;
        Real getBoundingRadius(void) const;

        Real getSquaredViewDepth( const Camera* cam ) const;

        void _notifyMoved(void);
        void _notifyAttached( Node* parent, bool isTagPoint = false );

        void _updateRenderQueue( RenderQueue* queue )   {}
        void visitRenderables( Renderable::Visitor* visitor, bool debugRenderables = false ) {}

        bool hasSkeleton(void) const { return mSkeletonInstance != 0; }
        SkeletonInstance* getSkeleton(void) const { return mSkeletonInstance; }

        AnimationState* getAnimationState(const String& name) const;
        AnimationStateSet* getAllAnimationStates(void) const;

        virtual bool _updateAnimation(void);

        void setTransformLookupNumber(uint16 num) { mTransformLookupNumber = num;}

        const Vector3& getPosition() const { return mPosition; }
        void setPosition(const Vector3& position, bool doUpdate = true);

        const Quaternion& getOrientation() const { return mOrientation; }
        void setOrientation(const Quaternion& orientation, bool doUpdate = true);

        const Vector3& getScale() const { return mScale; }
        void setScale(const Vector3& scale, bool doUpdate = true);

        Real getMaxScaleCoef() const;

        void updateTransforms();

        bool isInUse() const { return mInUse; }
        void setInUse(bool used);

        virtual const Matrix4& _getParentNodeFullTransform(void) const { 
            assert((!mNeedTransformUpdate || !mUseLocalTransform) && "Transform data should be updated at this point");
            return mUseLocalTransform ? mFullLocalTransform :
                mParentNode ? mParentNode->_getFullTransform() : Matrix4::IDENTITY;
        }

        const Vector3& _getDerivedPosition() const {
            assert((!mNeedTransformUpdate || !mUseLocalTransform) && "Transform data should be updated at this point");
            return mUseLocalTransform ? mDerivedLocalPosition :
                mParentNode ? mParentNode->_getDerivedPosition() : Vector3::ZERO;
        }

        virtual bool isInScene(void) const
        {
            //We assume that the instanced entity is in the scene if it is in use
            //It is in the scene whether it has a parent node or not
            return mInUse;
        }

        void setCustomParam( unsigned char idx, const Vector4 &newParam );
        const Vector4& getCustomParam( unsigned char idx );
    };
}

#include "OgreHeaderSuffix.h"

#endif