OgreEntity.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://ogre.sourceforge.net/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __Entity_H__
#define __Entity_H__

#include "OgrePrerequisites.h"
#include "OgreCommon.h"

#include "OgreString.h"
#include "OgreMovableObject.h"
#include "OgreAnimationState.h"
#include "OgreQuaternion.h"
#include "OgreVector3.h"
#include "OgreHardwareBufferManager.h"
#include "OgreMesh.h"

namespace Ogre {
    class _OgreExport Entity: public MovableObject
    {
        // Allow SceneManager full access
        friend class SceneManager;
        friend class SubEntity;
    public:
    typedef std::set<Entity*> EntitySet;
    
    protected:

        Entity();
        Entity( const String& name, MeshPtr& mesh, SceneManager* creator);

        String mName;

        MeshPtr mMesh;

        typedef std::vector<SubEntity*> SubEntityList;
        SubEntityList mSubEntityList;

        SceneManager* mCreatorSceneManager;


        AnimationStateSet* mAnimationState;

        static String msMovableType;


        TempBlendedBufferInfo mTempBlendedBuffer;
        VertexData* mSharedBlendedVertexData;

        const VertexData* findBlendedVertexData(const VertexData* orig);
        SubEntity* findSubEntityForVertexData(const VertexData* orig);

        void extractTempBufferInfo(VertexData* sourceData, TempBlendedBufferInfo* info);
        VertexData* cloneVertexDataRemoveBlendInfo(const VertexData* source);
        void prepareTempBlendBuffers(void);

        Matrix4 *mBoneMatrices;
        unsigned short mNumBoneMatrices;
        unsigned long mFrameAnimationLastUpdated;

        void updateAnimation(void);

        unsigned long *mFrameBonesLastUpdated;

        EntitySet* mSharedSkeletonEntities;
        
        void cacheBoneMatrices(void);

        bool mDisplaySkeleton;
        bool mHardwareSkinning;
        int mSoftwareSkinningRequests;
        int mSoftwareSkinningNormalsRequests;
        bool mVertexProgramInUse;


        ushort mMeshLodIndex;

        Real mMeshLodFactorInv;
        ushort mMinMeshLodIndex;
        ushort mMaxMeshLodIndex;

        Real mMaterialLodFactorInv;
        ushort mMinMaterialLodIndex;
        ushort mMaxMaterialLodIndex;

        bool mUsingManualLOD;
        typedef std::vector<Entity*> LODEntityList;
        LODEntityList mLodEntityList;

        SkeletonInstance* mSkeletonInstance;

        void buildSubEntityList(MeshPtr& mesh, SubEntityList* sublist);

        void attachObjectImpl(MovableObject *pMovable, TagPoint *pAttachingPoint);

        void detachObjectImpl(MovableObject* pObject);

        void detachAllObjectsImpl(void);

        void reevaluateVertexProcessing(void);

    public:
        typedef std::map<String, MovableObject*> ChildObjectList;
    protected:
        ChildObjectList mChildObjectList;


        AxisAlignedBox *mFullBoundingBox;

        bool mNormaliseNormals;

        ShadowRenderableList mShadowRenderables;

        class _OgreExport EntityShadowRenderable : public ShadowRenderable
        {
        protected:
            Entity* mParent;
            // Shared link to position buffer
            HardwareVertexBufferSharedPtr mPositionBuffer;
            // Shared link to w-coord buffer (optional)
            HardwareVertexBufferSharedPtr mWBuffer;
            // Link to original vertex data
            const VertexData* mOriginalVertexData;
            // Original position buffer source binding
            unsigned short mOriginalPosBufferBinding;
            SubEntity* mSubEntity;


        public:
            EntityShadowRenderable(Entity* parent, 
                HardwareIndexBufferSharedPtr* indexBuffer, const VertexData* vertexData, 
                bool createSeparateLightCap, SubEntity* subent, bool isLightCap = false);
            ~EntityShadowRenderable();
            void getWorldTransforms(Matrix4* xform) const;
            const Quaternion& getWorldOrientation(void) const;
            const Vector3& getWorldPosition(void) const;
            HardwareVertexBufferSharedPtr getPositionBuffer(void) { return mPositionBuffer; }
            HardwareVertexBufferSharedPtr getWBuffer(void) { return mWBuffer; }
            void rebindPositionBuffer(void);
            bool isVisible(void) const;

        };
    public:
        ~Entity();

        MeshPtr& getMesh(void);

        SubEntity* getSubEntity(unsigned int index);
    
        SubEntity* getSubEntity( const String& name );

        unsigned int getNumSubEntities(void) const;

        Entity* clone( const String& newName );

        void setMaterialName(const String& name);

        void _notifyCurrentCamera(Camera* cam);

        void setRenderQueueGroup(RenderQueueGroupID queueID);
        
        const AxisAlignedBox& getBoundingBox(void) const;

        AxisAlignedBox getChildObjectsBoundingBox(void) const;

        void _updateRenderQueue(RenderQueue* queue);

        const String& getName(void) const;

        const String& getMovableType(void) const;

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

        void setDisplaySkeleton(bool display);

        bool getDisplaySkeleton(void) const;


        Entity* getManualLodLevel(size_t index) const;

        size_t getNumManualLodLevels(void) const;

        void setMeshLodBias(Real factor, ushort maxDetailIndex = 0, ushort minDetailIndex = 99);

        void setMaterialLodBias(Real factor, ushort maxDetailIndex = 0, ushort minDetailIndex = 99);
            
        void setRenderDetail(SceneDetailLevel renderDetail);

        void setRenderDetailOverrideable(bool renderDetailOverrideable);
        void attachObjectToBone(const String &boneName, MovableObject *pMovable, const Quaternion &offsetOrientation = Quaternion::IDENTITY, const Vector3 &offsetPosition = Vector3::ZERO);

        MovableObject* detachObjectFromBone(const String &movableName);

        void detachObjectFromBone(MovableObject* obj);

        void detachAllObjectsFromBone(void);

        typedef MapIterator<ChildObjectList> ChildObjectListIterator;
        ChildObjectListIterator getAttachedObjectIterator(void);
        Real getBoundingRadius(void) const;
        const AxisAlignedBox& getWorldBoundingBox(bool derive = false) const;
        const Sphere& getWorldBoundingSphere(bool derive = false) const;

        void setNormaliseNormals(bool normalise) { mNormaliseNormals = normalise; }

        bool getNormaliseNormals(void) const {return mNormaliseNormals; }


        EdgeData* getEdgeList(void);
        ShadowRenderableListIterator getShadowVolumeRenderableIterator(
            ShadowTechnique shadowTechnique, const Light* light, 
            HardwareIndexBufferSharedPtr* indexBuffer, 
            bool extrudeVertices, Real extrusionDistance, unsigned long flags = 0 );

        const Matrix4* _getBoneMatrices(void) { return mBoneMatrices;}
        unsigned short _getNumBoneMatrices(void) { return mNumBoneMatrices; }
        bool hasSkeleton(void) { return mSkeletonInstance != 0; }
        SkeletonInstance* getSkeleton(void) { return mSkeletonInstance; }
        bool isHardwareSkinningEnabled(void) const { return mHardwareSkinning; }
        int getSoftwareSkinningRequests(void) const { return mSoftwareSkinningRequests; }
        int getSoftwareSkinningNormalsRequests(void) const { return mSoftwareSkinningNormalsRequests; }
        void addSoftwareSkinningRequest(bool normalsAlso);
        void removeSoftwareSkinningRequest(bool normalsAlso);

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

        void shareSkeletonInstanceWith(Entity* entity);

    
        void Entity::stopSharingSkeletonInstance();


        inline bool sharesSkeletonInstance() const { return mSharedSkeletonEntities != NULL; }

        inline const EntitySet* getSkeletonInstanceSharingSet() const { return mSharedSkeletonEntities; }

        void refreshAvailableAnimationState(void);

        void _updateAnimation(void);

        const VertexData* _getSharedBlendedVertexData(void) const;



    };

} // namespace

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:44 2006