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

#include "OgrePrerequisites.h"

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

namespace Ogre {

    class _OgreExport SubEntity: public Renderable
    {
        // 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 mpMaterial;

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

        bool mVisible;

        unsigned short mMaterialLodIndex;

        VertexData* mSkelAnimVertexData;
        TempBlendedBufferInfo mTempSkelAnimInfo;
        TempBlendedBufferInfo mTempVertexAnimInfo;
        VertexData* mSoftwareVertexAnimVertexData;
        VertexData* mHardwareVertexAnimVertexData;
        bool mVertexAnimationAppliedThisFrame;
        ushort mHardwarePoseCount;

        void prepareTempBlendBuffers(void);

    public:
        const String& getMaterialName() const;

        void setMaterialName( const String& name );

        virtual void setVisible(bool visible);

        virtual bool isVisible(void) const;

        SubMesh* getSubMesh(void);

        const MaterialPtr& getMaterial(void) const;

        Technique* getTechnique(void) const;

        void getRenderOperation(RenderOperation& op);

        void getWorldTransforms(Matrix4* xform) const;
        const Quaternion& getWorldOrientation(void) const;
        const Vector3& getWorldPosition(void) const;
        bool getNormaliseNormals(void) 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;
    };

}


#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:50 2006