OgreSubEntity.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 __SubEntity_H__
#define __SubEntity_H__

#include "OgrePrerequisites.h"

#include "OgreString.h"
#include "OgreRenderable.h"
#include "OgreHardwareBufferManager.h"
#include "OgreResourceGroupManager.h"

namespace Ogre {

    class _OgreExport SubEntity: public Renderable, public SubEntityAlloc
    {
        // Note no virtual functions for efficiency
        friend class Entity;
        friend class SceneManager;
    protected:
        SubEntity(Entity* parent, SubMesh* subMeshBasis);

        virtual ~SubEntity();

        Entity* mParentEntity;

        String mMaterialName;

        MaterialPtr mMaterial;

        // Pointer to the SubMesh defining geometry.
        SubMesh* mSubMesh;

        bool mVisible;

        uint8 mRenderQueueID;
        bool mRenderQueueIDSet;
        ushort mRenderQueuePriority;
        bool mRenderQueuePrioritySet;

        unsigned short mMaterialLodIndex;

        VertexData* mSkelAnimVertexData;
        TempBlendedBufferInfo mTempSkelAnimInfo;
        TempBlendedBufferInfo mTempVertexAnimInfo;
        VertexData* mSoftwareVertexAnimVertexData;
        VertexData* mHardwareVertexAnimVertexData;
        bool mVertexAnimationAppliedThisFrame;
        ushort mHardwarePoseCount;
        mutable Real mCachedCameraDist;
        mutable const Camera *mCachedCamera;

        void prepareTempBlendBuffers(void);

    public:
        const String& getMaterialName() const;

        void setMaterialName( const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );

        void setMaterial( const MaterialPtr& material );

        virtual void setVisible(bool visible);

        virtual bool isVisible(void) const;

        virtual void setRenderQueueGroup(uint8 queueID);

        virtual void setRenderQueueGroupAndPriority(uint8 queueID, ushort priority);

        virtual uint8 getRenderQueueGroup(void) const;

        virtual ushort getRenderQueuePriority(void) const;

        virtual bool isRenderQueueGroupSet(void) const;

        virtual bool isRenderQueuePrioritySet(void) const;

        SubMesh* getSubMesh(void);

        Entity* getParent(void) const { return mParentEntity; }

        const MaterialPtr& getMaterial(void) const;

        Technique* getTechnique(void) const;

        void getRenderOperation(RenderOperation& op);

        void getWorldTransforms(Matrix4* xform) const;
        unsigned short getNumWorldTransforms(void) const;
        Real getSquaredViewDepth(const Camera* cam) const;
        const LightList& getLights(void) const;
        bool getCastsShadows(void) const;
        VertexData* _getSkelAnimVertexData(void);
        VertexData* _getSoftwareVertexAnimVertexData(void);
        VertexData* _getHardwareVertexAnimVertexData(void);
        TempBlendedBufferInfo* _getSkelAnimTempBufferInfo(void);
        TempBlendedBufferInfo* _getVertexAnimTempBufferInfo(void);
        VertexData* getVertexDataForBinding(void);

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

        void _updateCustomGpuParameter(
            const GpuProgramParameters::AutoConstantEntry& constantEntry,
            GpuProgramParameters* params) const;

        void _invalidateCameraCache ()
        { mCachedCamera = 0; }
    };
}


#endif