OgreMovableObject.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 __MovableObject_H__
#define __MovableObject_H__

// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreRenderQueue.h"
#include "OgreAxisAlignedBox.h"
#include "OgreSphere.h"
#include "OgreShadowCaster.h"
#include "OgreFactoryObj.h"
#include "OgreAnimable.h"
#include "OgreAny.h"
#include "OgreUserDefinedObject.h"

namespace Ogre {

    // Forward declaration
    class MovableObjectFactory;

    class _OgreExport MovableObject : public ShadowCaster, public AnimableObject
    {
    protected:
        String mName;
        MovableObjectFactory* mCreator;
        SceneManager* mManager;
        Node* mParentNode;
        bool mParentIsTagPoint;
        bool mVisible;
        Real mUpperDistance;
        Real mSquaredUpperDistance;
        bool mBeyondFarDistance;
        Any mUserAny;
        uint8 mRenderQueueID;
        bool mRenderQueueIDSet;
        uint32 mQueryFlags;
        uint32 mVisibilityFlags;
        mutable AxisAlignedBox mWorldAABB;
        // Cached world bounding sphere
        mutable Sphere mWorldBoundingSphere;
        mutable AxisAlignedBox mWorldDarkCapBounds;
        bool mCastShadows;

        // Static members
        static uint32 msDefaultQueryFlags;
        static uint32 msDefaultVisibilityFlags;



    public:
        MovableObject();

        MovableObject(const String& name);
        virtual ~MovableObject();

        virtual void _notifyCreator(MovableObjectFactory* fact) { mCreator = fact; }
        virtual void _notifyManager(SceneManager* man) { mManager = man; }
        virtual SceneManager* _getManager(void) const { return mManager; }

        virtual const String& getName(void) const { return mName; }

        virtual const String& getMovableType(void) const = 0;

        virtual Node* getParentNode(void) const;

        virtual SceneNode* getParentSceneNode(void) const;

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

        virtual bool isAttached(void) const;

        virtual bool isInScene(void) const;

        virtual void _notifyCurrentCamera(Camera* cam);

        virtual const AxisAlignedBox& getBoundingBox(void) const = 0;

        virtual Real getBoundingRadius(void) const = 0;

        virtual const AxisAlignedBox& getWorldBoundingBox(bool derive = false) const;
        virtual const Sphere& getWorldBoundingSphere(bool derive = false) const;
        virtual void _updateRenderQueue(RenderQueue* queue) = 0;

        virtual void setVisible(bool visible);

        virtual bool isVisible(void) const;
        virtual void setRenderingDistance(Real dist) { 
            mUpperDistance = dist; 
            mSquaredUpperDistance = mUpperDistance * mUpperDistance;
        }

        virtual Real getRenderingDistance(void) const { return mUpperDistance; }

        virtual void setUserObject(UserDefinedObject* obj) { mUserAny = Any(obj); }
        virtual UserDefinedObject* getUserObject(void) 
        { 
            return mUserAny.isEmpty() ? 0 : any_cast<UserDefinedObject*>(mUserAny); 
        }

        virtual void setUserAny(const Any& anything) { mUserAny = anything; }

        virtual const Any& getUserAny(void) const { return mUserAny; }

        virtual void setRenderQueueGroup(uint8 queueID);

        virtual uint8 getRenderQueueGroup(void) const;

        virtual Matrix4 _getParentNodeFullTransform(void) const;

        virtual void setQueryFlags(uint32 flags) { mQueryFlags = flags; }

        virtual void addQueryFlags(uint32 flags) { mQueryFlags |= flags; }
            
        virtual void removeQueryFlags(unsigned long flags) { mQueryFlags &= ~flags; }
        
        virtual uint32 getQueryFlags(void) const { return mQueryFlags; }

        static void setDefaultQueryFlags(uint32 flags) { msDefaultQueryFlags = flags; }

        static uint32 getDefaultQueryFlags(uint32 flags) { return msDefaultQueryFlags; }

        
        virtual void setVisibilityFlags(uint32 flags) { mVisibilityFlags = flags; }

        virtual void addVisibilityFlags(uint32 flags) { mVisibilityFlags |= flags; }
            
        virtual void removeVisibilityFlags(uint32 flags) { mVisibilityFlags &= ~flags; }
        
        virtual uint32 getVisibilityFlags(void) const { return mVisibilityFlags; }

        static void setDefaultVisibilityFlags(uint32 flags) { msDefaultVisibilityFlags = flags; }
        
        static uint32 getDefaultVisibilityFlags(uint32 flags) { return msDefaultVisibilityFlags; }

        EdgeData* getEdgeList(void) { return NULL; }
        ShadowRenderableListIterator getShadowVolumeRenderableIterator(
            ShadowTechnique shadowTechnique, const Light* light, 
            HardwareIndexBufferSharedPtr* indexBuffer, 
            bool extrudeVertices, Real extrusionDist, unsigned long flags = 0);
        
        const AxisAlignedBox& getLightCapBounds(void) const;
        const AxisAlignedBox& getDarkCapBounds(const Light& light, Real dirLightExtrusionDist) const;
        void setCastShadows(bool enabled) { mCastShadows = enabled; }
        bool getCastShadows(void) const { return mCastShadows; }
        Real getPointExtrusionDistance(const Light* l) const;
        virtual uint32 getTypeFlags(void) const;





    };

    class _OgreExport MovableObjectFactory 
    {
    protected:
        unsigned long mTypeFlag;

        virtual MovableObject* createInstanceImpl(
            const String& name, const NameValuePairList* params = 0) = 0;
    public:
        MovableObjectFactory() : mTypeFlag(0xFFFFFFFF) {}
        virtual ~MovableObjectFactory() {}
        virtual const String& getType(void) const = 0;

        virtual MovableObject* createInstance(
            const String& name, SceneManager* manager, 
            const NameValuePairList* params = 0);
        virtual void destroyInstance(MovableObject* obj) = 0;

        virtual bool requestTypeFlags(void) const { return false; }
        void _notifyTypeFlags(unsigned long flag) { mTypeFlag = flag; }

        unsigned long getTypeFlags(void) const { return mTypeFlag; }

    };

}
#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:44 2006