apps/openmw/mwbase/world.hpp

Go to the documentation of this file.

#ifndef GAME_MWBASE_WORLD_H
#define GAME_MWBASE_WORLD_H

#include <vector>

#include <components/settings/settings.hpp>

#include "../mwworld/globals.hpp"
#include "../mwworld/ptr.hpp"

namespace Ogre
{
    class Vector2;
    class Vector3;
}

namespace OEngine
{
    namespace Render
    {
        class Fader;
    }

    namespace Physic
    {
        class PhysicEngine;
    }
}

namespace ESM
{
    class ESMReader;
    struct Position;
    struct Cell;
    struct Class;
    struct Potion;
    struct Spell;
    struct NPC;
}

namespace MWRender
{
    class ExternalRendering;
    class Animation;
}

namespace MWMechanics
{
    class Movement;
}

namespace MWWorld
{
    class Fallback;
    class CellStore;
    class Player;
    class LocalScripts;
    class TimeStamp;
    class ESMStore;
    class RefData;

    typedef std::vector<std::pair<MWWorld::Ptr,MWMechanics::Movement> > PtrMovementList;
}

namespace MWBase
{
    class World
    {
            World (const World&);

            World& operator= (const World&);

        public:

            enum RenderMode
            {
                Render_CollisionDebug,
                Render_Wireframe,
                Render_Pathgrid,
                Render_BoundingBoxes
            };

            struct DoorMarker
            {
                std::string name;
                float x, y; // world position
            };

            World() {}

            virtual ~World() {}

            virtual void startNewGame() = 0;

            virtual OEngine::Render::Fader* getFader() = 0;

            virtual MWWorld::CellStore *getExterior (int x, int y) = 0;

            virtual MWWorld::CellStore *getInterior (const std::string& name) = 0;

            virtual void setWaterHeight(const float height) = 0;

            virtual void toggleWater() = 0;

            virtual void adjustSky() = 0;

            virtual void getTriangleBatchCount(unsigned int &triangles, unsigned int &batches) = 0;

            virtual const MWWorld::Fallback *getFallback () const = 0;

            virtual MWWorld::Player& getPlayer() = 0;

            virtual const MWWorld::ESMStore& getStore() const = 0;

            virtual std::vector<ESM::ESMReader>& getEsmReader() = 0;

            virtual MWWorld::LocalScripts& getLocalScripts() = 0;

            virtual bool hasCellChanged() const = 0;

            virtual bool isCellExterior() const = 0;

            virtual bool isCellQuasiExterior() const = 0;

            virtual Ogre::Vector2 getNorthVector (MWWorld::CellStore* cell) = 0;

            virtual void getDoorMarkers (MWWorld::CellStore* cell, std::vector<DoorMarker>& out) = 0;

            virtual void getInteriorMapPosition (Ogre::Vector2 position, float& nX, float& nY, int &x, int& y) = 0;

            virtual bool isPositionExplored (float nX, float nY, int x, int y, bool interior) = 0;

            virtual MWWorld::Globals::Data& getGlobalVariable (const std::string& name) = 0;

            virtual MWWorld::Globals::Data getGlobalVariable (const std::string& name) const = 0;

            virtual char getGlobalVariableType (const std::string& name) const = 0;

            virtual std::vector<std::string> getGlobals () const = 0;

            virtual std::string getCurrentCellName() const = 0;

            virtual void removeRefScript (MWWorld::RefData *ref) = 0;
            //< Remove the script attached to ref from mLocalScripts

            virtual MWWorld::Ptr getPtr (const std::string& name, bool activeOnly) = 0;

            virtual MWWorld::Ptr getPtrViaHandle (const std::string& handle) = 0;

            virtual MWWorld::Ptr searchPtrViaHandle (const std::string& handle) = 0;

            virtual void enable (const MWWorld::Ptr& ptr) = 0;

            virtual void disable (const MWWorld::Ptr& ptr) = 0;

            virtual void advanceTime (double hours) = 0;

            virtual void setHour (double hour) = 0;

            virtual void setMonth (int month) = 0;

            virtual void setDay (int day) = 0;

            virtual int getDay() = 0;
            virtual int getMonth() = 0;

            virtual MWWorld::TimeStamp getTimeStamp() const = 0;

            virtual bool toggleSky() = 0;

            virtual void changeWeather(const std::string& region, unsigned int id) = 0;

            virtual int getCurrentWeather() const = 0;

            virtual int getMasserPhase() const = 0;

            virtual int getSecundaPhase() const = 0;

            virtual void setMoonColour (bool red) = 0;

            virtual void modRegion(const std::string &regionid, const std::vector<char> &chances) = 0;

            virtual float getTimeScaleFactor() const = 0;

            virtual void changeToInteriorCell (const std::string& cellName,
                const ESM::Position& position) = 0;

            virtual void changeToExteriorCell (const ESM::Position& position) = 0;

            virtual const ESM::Cell *getExterior (const std::string& cellName) const = 0;

            virtual void markCellAsUnchanged() = 0;

            virtual MWWorld::Ptr  getFacedObject() = 0;

            virtual std::pair<MWWorld::Ptr,Ogre::Vector3> getHitContact(const MWWorld::Ptr &ptr, float distance) = 0;

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

            virtual void deleteObject (const MWWorld::Ptr& ptr) = 0;

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

            virtual void
            moveObject(const MWWorld::Ptr &ptr, MWWorld::CellStore &newCell, float x, float y, float z) = 0;

            virtual void scaleObject (const MWWorld::Ptr& ptr, float scale) = 0;

            virtual void rotateObject(const MWWorld::Ptr& ptr,float x,float y,float z, bool adjust = false) = 0;

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

            virtual MWWorld::Ptr safePlaceObject(const MWWorld::Ptr& ptr,MWWorld::CellStore &Cell,ESM::Position pos) = 0;

            virtual void indexToPosition (int cellX, int cellY, float &x, float &y, bool centre = false)
                const = 0;

            virtual void positionToIndex (float x, float y, int &cellX, int &cellY) const = 0;

            virtual void queueMovement(const MWWorld::Ptr &ptr, const Ogre::Vector3 &velocity) = 0;

            virtual bool castRay (float x1, float y1, float z1, float x2, float y2, float z2) = 0;

            virtual bool toggleCollisionMode() = 0;

            virtual bool toggleRenderMode (RenderMode mode) = 0;

            virtual const ESM::Potion *createRecord (const ESM::Potion& record) = 0;

            virtual const ESM::Spell *createRecord (const ESM::Spell& record) = 0;

            virtual const ESM::Class *createRecord (const ESM::Class& record) = 0;

            virtual const ESM::Cell *createRecord (const ESM::Cell& record) = 0;

            virtual const ESM::NPC *createRecord(const ESM::NPC &record) = 0;

            virtual const ESM::Armor *createRecord (const ESM::Armor& record) = 0;

            virtual const ESM::Weapon *createRecord (const ESM::Weapon& record) = 0;

            virtual const ESM::Clothing *createRecord (const ESM::Clothing& record) = 0;

            virtual const ESM::Enchantment *createRecord (const ESM::Enchantment& record) = 0;

            virtual const ESM::Book *createRecord (const ESM::Book& record) = 0;

            virtual void update (float duration, bool paused) = 0;

            virtual bool placeObject (const MWWorld::Ptr& object, float cursorX, float cursorY, int amount) = 0;

            virtual void dropObjectOnGround (const MWWorld::Ptr& actor, const MWWorld::Ptr& object, int amount) = 0;

            virtual bool canPlaceObject (float cursorX, float cursorY) = 0;

            virtual void processChangedSettings (const Settings::CategorySettingVector& settings) = 0;

            virtual bool isFlying(const MWWorld::Ptr &ptr) const = 0;
            virtual bool isSlowFalling(const MWWorld::Ptr &ptr) const = 0;
            virtual bool isSwimming(const MWWorld::Ptr &object) const = 0;
            virtual bool isSubmerged(const MWWorld::Ptr &object) const = 0;
            virtual bool isUnderwater(const MWWorld::Ptr::CellStore* cell, const Ogre::Vector3 &pos) const = 0;
            virtual bool isOnGround(const MWWorld::Ptr &ptr) const = 0;

            virtual void togglePOV() = 0;
            virtual void togglePreviewMode(bool enable) = 0;
            virtual bool toggleVanityMode(bool enable) = 0;
            virtual void allowVanityMode(bool allow) = 0;
            virtual void togglePlayerLooking(bool enable) = 0;
            virtual void changeVanityModeScale(float factor) = 0;
            virtual bool vanityRotateCamera(float * rot) = 0;
            virtual void setCameraDistance(float dist, bool adjust = false, bool override = true)=0;

            virtual void setupPlayer() = 0;
            virtual void renderPlayer() = 0;

            virtual bool getOpenOrCloseDoor(const MWWorld::Ptr& door) = 0;
            virtual void activateDoor(const MWWorld::Ptr& door) = 0;

            virtual bool getPlayerStandingOn (const MWWorld::Ptr& object) = 0; 
            virtual bool getActorStandingOn (const MWWorld::Ptr& object) = 0; 
            virtual float getWindSpeed() = 0;

            virtual void getContainersOwnedBy (const MWWorld::Ptr& npc, std::vector<MWWorld::Ptr>& out) = 0;
            virtual void getItemsOwnedBy (const MWWorld::Ptr& npc, std::vector<MWWorld::Ptr>& out) = 0;

            virtual bool getLOS(const MWWorld::Ptr& npc,const MWWorld::Ptr& targetNpc) = 0;

            virtual void enableActorCollision(const MWWorld::Ptr& actor, bool enable) = 0;

            virtual void setupExternalRendering (MWRender::ExternalRendering& rendering) = 0;

            virtual int canRest() = 0;

            virtual MWRender::Animation* getAnimation(const MWWorld::Ptr &ptr) = 0;

            virtual void playVideo(const std::string& name, bool allowSkipping) = 0;
            virtual void stopVideo() = 0;
            virtual void frameStarted (float dt, bool paused) = 0;

            virtual bool findExteriorPosition(const std::string &name, ESM::Position &pos) = 0;

            virtual bool findInteriorPosition(const std::string &name, ESM::Position &pos) = 0;

            virtual void enableTeleporting(bool enable) = 0;

            virtual bool isTeleportingEnabled() const = 0;

            virtual void enableLevitation(bool enable) = 0;

            virtual bool isLevitationEnabled() const = 0;

            virtual void setWerewolf(const MWWorld::Ptr& actor, bool werewolf) = 0;

            virtual void applyWerewolfAcrobatics(const MWWorld::Ptr& actor) = 0;

            virtual bool getGodModeState() = 0;

            virtual bool toggleGodMode() = 0;

            virtual bool startSpellCast (const MWWorld::Ptr& actor) = 0;

            virtual void castSpell (const MWWorld::Ptr& actor) = 0;

            virtual void launchProjectile (const std::string& id, bool stack, const ESM::EffectList& effects,
                                           const MWWorld::Ptr& actor, const std::string& sourceName) = 0;

            virtual void breakInvisibility (const MWWorld::Ptr& actor) = 0;

            // Are we in an exterior or pseudo-exterior cell and it's night?
            virtual bool isDark() const = 0;

            virtual bool findInteriorPositionInWorldSpace(MWWorld::CellStore* cell, Ogre::Vector3& result) = 0;

            virtual void teleportToClosestMarker (const MWWorld::Ptr& ptr,
                                                  const std::string& id, Ogre::Vector3 worldPos) = 0;

            enum DetectionType
            {
                Detect_Enchantment,
                Detect_Key,
                Detect_Creature
            };
            virtual void listDetectedReferences (const MWWorld::Ptr& ptr, std::vector<MWWorld::Ptr>& out,
                                                  DetectionType type) = 0;
    };
}

#endif