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 "OgreQuaternion.h"
#include "OgreVector3.h"
#include "OgreHardwareBufferManager.h"
#include "OgreMesh.h"

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

    protected:

        Entity();
        Entity( const String& name, MeshPtr& mesh);

        MeshPtr mMesh;

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


        AnimationStateSet* mAnimationState;


        TempBlendedBufferInfo mTempSkelAnimInfo;
        VertexData* mSkelAnimVertexData;
        TempBlendedBufferInfo mTempVertexAnimInfo;
        VertexData* mSoftwareVertexAnimVertexData;
        VertexData* mHardwareVertexAnimVertexData;
        bool mVertexAnimationAppliedThisFrame;
        bool mPreparedForShadowVolumes;

        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);
        void markBuffersUnusedForAnimation(void);
        void restoreBuffersForUnusedAnimation(bool hardwareAnimation);

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

        void updateAnimation(void);

        unsigned long *mFrameBonesLastUpdated;

        EntitySet* mSharedSkeletonEntities;

        void cacheBoneMatrices(void);

        bool mDisplaySkeleton;
        bool mHardwareAnimation;
        ushort mHardwarePoseCount;
        bool mVertexProgramInUse;
        int mSoftwareAnimationRequests;
        int mSoftwareAnimationNormalsRequests;


        ushort mMeshLodIndex;

        Real mMeshLodFactorInv;
        ushort mMinMeshLodIndex;
        ushort mMaxMeshLodIndex;

        Real mMaterialLodFactorInv;
        ushort mMinMaterialLodIndex;
        ushort mMaxMaterialLodIndex;

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

        SkeletonInstance* mSkeletonInstance;

        Matrix4 mLastParentXform;

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

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

        void detachObjectImpl(MovableObject* pObject);

        void detachAllObjectsImpl(void);

        void reevaluateVertexProcessing(void);

        void applyVertexAnimation(bool hardwareAnimation, bool stencilShadows);
        void initHardwareAnimationElements(VertexData* vdata, 
            ushort numberOfElements);
        bool tempVertexAnimBuffersBound(void) const;
        bool tempSkelAnimBuffersBound(bool requestNormals) const;

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


        mutable 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 current vertex data used to bind (maybe changes)
            const VertexData* mCurrentVertexData;
            // 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(const VertexData* vertexData, bool force);
            bool isVisible(void) const;

        };
    public:
        ~Entity();

        const MeshPtr& getMesh(void) const;

        SubEntity* getSubEntity(unsigned int index) const;

        SubEntity* getSubEntity( const String& name ) const;

        unsigned int getNumSubEntities(void) const;

        Entity* clone( const String& newName ) const;

        void setMaterialName(const String& name);

        void _notifyCurrentCamera(Camera* cam);

        void setRenderQueueGroup(uint8 queueID);

        const AxisAlignedBox& getBoundingBox(void) const;

        AxisAlignedBox getChildObjectsBoundingBox(void) const;

        void _updateRenderQueue(RenderQueue* queue);

        const String& getMovableType(void) const;

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

        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 setPolygonModeOverrideable(bool PolygonModeOverrideable);
        TagPoint* 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) const { return mBoneMatrices;}
        unsigned short _getNumBoneMatrices(void) const { return mNumBoneMatrices; }
        bool hasSkeleton(void) const { return mSkeletonInstance != 0; }
        SkeletonInstance* getSkeleton(void) const { return mSkeletonInstance; }
        bool isHardwareAnimationEnabled(void) const { return mHardwareAnimation; }

        void _notifyAttached(Node* parent, bool isTagPoint = false);
        int getSoftwareAnimationRequests(void) const { return mSoftwareAnimationRequests; }
        int getSoftwareAnimationNormalsRequests(void) const { return mSoftwareAnimationNormalsRequests; }
        void addSoftwareAnimationRequest(bool normalsAlso);
        void removeSoftwareAnimationRequest(bool normalsAlso);

        void shareSkeletonInstanceWith(Entity* entity);

        bool hasVertexAnimation(void) const;


        void stopSharingSkeletonInstance();


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

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

        void refreshAvailableAnimationState(void);

        void _updateAnimation(void);

        bool _isAnimated(void) const;

        bool _isSkeletonAnimated(void) const;

        VertexData* _getSkelAnimVertexData(void) const;
        VertexData* _getSoftwareVertexAnimVertexData(void) const;
        VertexData* _getHardwareVertexAnimVertexData(void) const;
        TempBlendedBufferInfo* _getSkelAnimTempBufferInfo(void);
        TempBlendedBufferInfo* _getVertexAnimTempBufferInfo(void);
        uint32 getTypeFlags(void) const;
        VertexData* getVertexDataForBinding(void);

        enum VertexDataBindChoice 
        {
            BIND_ORIGINAL,
            BIND_SOFTWARE_SKELETAL,
            BIND_SOFTWARE_MORPH,
            BIND_HARDWARE_MORPH
        };
        VertexDataBindChoice chooseVertexDataForBinding(bool hasVertexAnim) const;

        bool _getBuffersMarkedForAnimation(void) const { return mVertexAnimationAppliedThisFrame; }
        void _markBuffersUsedForAnimation(void);


    };

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

        static String FACTORY_TYPE_NAME;

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

    };

} // 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 Mar 12 14:37:40 2006