apps/openmw/mwworld/class.hpp

Go to the documentation of this file.

#ifndef GAME_MWWORLD_CLASS_H
#define GAME_MWWORLD_CLASS_H

#include <map>
#include <string>
#include <vector>

#include <boost/shared_ptr.hpp>

#include "ptr.hpp"

namespace Ogre
{
    class Vector3;
}

namespace MWRender
{
    class RenderingInterface;
}

namespace MWMechanics
{
    class CreatureStats;
    class NpcStats;
    struct Movement;
}

namespace MWGui
{
    struct ToolTipInfo;
}

namespace ESM
{
    struct Position;
}

namespace MWWorld
{
    class Ptr;
    class ContainerStore;
    class InventoryStore;
    class PhysicsSystem;
    class CellStore;
    class Action;

    class Class
    {
            static std::map<std::string, boost::shared_ptr<Class> > sClasses;

            std::string mTypeName;

            // not implemented
            Class (const Class&);
            Class& operator= (const Class&);

        protected:

            Class();

            boost::shared_ptr<Action> defaultItemActivate(const Ptr &ptr, const Ptr &actor) const;

            virtual Ptr copyToCellImpl(const Ptr &ptr, CellStore &cell) const;

        public:

            enum Stance
            {
                Run, Sneak, Combat
            };

            virtual ~Class();

            const std::string& getTypeName() const {
                return mTypeName;
            }

            virtual std::string getId (const Ptr& ptr) const;

            virtual void insertObjectRendering (const Ptr& ptr, MWRender::RenderingInterface& renderingInterface) const;
            virtual void insertObject(const Ptr& ptr, MWWorld::PhysicsSystem& physics) const;

            virtual std::string getName (const Ptr& ptr) const = 0;

            virtual void adjustPosition(const MWWorld::Ptr& ptr) const;

            virtual MWMechanics::CreatureStats& getCreatureStats (const Ptr& ptr) const;

            virtual bool hasToolTip (const Ptr& ptr) const;

            virtual MWGui::ToolTipInfo getToolTipInfo (const Ptr& ptr) const;

            virtual MWMechanics::NpcStats& getNpcStats (const Ptr& ptr) const;

            virtual bool hasItemHealth (const Ptr& ptr) const;

            virtual int getItemMaxHealth (const Ptr& ptr) const;

            virtual void hit(const Ptr& ptr, int type=-1) const;

            virtual void onHit(const MWWorld::Ptr &ptr, float damage, bool ishealth, const MWWorld::Ptr &object, const MWWorld::Ptr &attacker, bool successful) const;

            virtual void setActorHealth(const Ptr& ptr, float health, const Ptr& attacker=Ptr()) const;

            virtual boost::shared_ptr<Action> activate (const Ptr& ptr, const Ptr& actor) const;

            virtual boost::shared_ptr<Action> use (const Ptr& ptr)
                const;

            virtual ContainerStore& getContainerStore (const Ptr& ptr) const;

            virtual InventoryStore& getInventoryStore (const Ptr& ptr) const;

            virtual void lock (const Ptr& ptr, int lockLevel) const;

            virtual void unlock (const Ptr& ptr) const;

            virtual void setRemainingUsageTime (const Ptr& ptr, float duration) const;

            virtual float getRemainingUsageTime (const Ptr& ptr) const;

            virtual std::string getScript (const Ptr& ptr) const;

            virtual void setForceStance (const Ptr& ptr, Stance stance, bool force) const;

            virtual void setStance (const Ptr& ptr, Stance stance, bool set) const;

            virtual bool getStance (const Ptr& ptr, Stance stance, bool ignoreForce = false) const;

            virtual float getSpeed (const Ptr& ptr) const;

            virtual float getJump(const MWWorld::Ptr &ptr) const;

            virtual float getFallDamage(const MWWorld::Ptr &ptr, float fallHeight) const;

            virtual MWMechanics::Movement& getMovementSettings (const Ptr& ptr) const;

            virtual Ogre::Vector3 getMovementVector (const Ptr& ptr) const;

            virtual Ogre::Vector3 getRotationVector (const Ptr& ptr) const;

            virtual std::pair<std::vector<int>, bool> getEquipmentSlots (const Ptr& ptr) const;

            virtual int getEquipmentSkill (const Ptr& ptr)
                const;

            virtual int getValue (const Ptr& ptr) const;

            virtual float getCapacity (const MWWorld::Ptr& ptr) const;

            virtual float getEncumbrance (const MWWorld::Ptr& ptr) const;

            virtual bool apply (const MWWorld::Ptr& ptr, const std::string& id,
                const MWWorld::Ptr& actor) const;

            virtual void skillUsageSucceeded (const MWWorld::Ptr& ptr, int skill, int usageType) const;

            virtual bool isEssential (const MWWorld::Ptr& ptr) const;

            virtual bool hasDetected (const MWWorld::Ptr& ptr, const MWWorld::Ptr& ptr2) const;

            virtual std::string getUpSoundId (const Ptr& ptr) const;

            virtual std::string getDownSoundId (const Ptr& ptr) const;

            virtual std::string getSoundIdFromSndGen(const Ptr &ptr, const std::string &type) const;

            virtual float getArmorRating (const MWWorld::Ptr& ptr) const;

            virtual std::string getInventoryIcon (const MWWorld::Ptr& ptr) const;

            virtual std::string getEnchantment (const MWWorld::Ptr& ptr) const;

            virtual float getEnchantmentPoints (const MWWorld::Ptr& ptr) const;

            virtual void adjustScale(const MWWorld::Ptr& ptr,float& scale) const;

            virtual void adjustRotation(const MWWorld::Ptr& ptr,float& x,float& y,float& z) const;

            virtual bool canSell (const MWWorld::Ptr& item, int npcServices) const;

            virtual int getServices (const MWWorld::Ptr& actor) const;

            virtual std::string getModel(const MWWorld::Ptr &ptr) const;

            virtual void applyEnchantment(const MWWorld::Ptr &ptr, const std::string& enchId, int enchCharge, const std::string& newName) const;

            virtual std::pair<int, std::string> canBeEquipped(const MWWorld::Ptr &ptr, const MWWorld::Ptr &npc) const;

            virtual float getWeight (const MWWorld::Ptr& ptr) const;

            virtual bool isPersistent (const MWWorld::Ptr& ptr) const;

            virtual bool isKey (const MWWorld::Ptr& ptr) const { return false; }

            virtual Ptr
            copyToCell(const Ptr &ptr, CellStore &cell) const;

            virtual Ptr
            copyToCell(const Ptr &ptr, CellStore &cell, const ESM::Position &pos) const;

            virtual bool isActor() const {
                return false;
            }

            virtual bool isNpc() const {
                return false;
            }

            static const Class& get (const std::string& key);

            static const Class& get (const Ptr& ptr)
            {
                return ptr.getClass();
            }

            static void registerClass (const std::string& key,  boost::shared_ptr<Class> instance);
    };
}

#endif