apps/openmw/mwworld/worldimp.hpp

Go to the documentation of this file.

#ifndef GAME_MWWORLD_WORLDIMP_H
#define GAME_MWWORLD_WORLDIMP_H

#include "../mwrender/debugging.hpp"

#include "ptr.hpp"
#include "scene.hpp"
#include "esmstore.hpp"
#include "physicssystem.hpp"
#include "cells.hpp"
#include "localscripts.hpp"
#include "timestamp.hpp"
#include "fallback.hpp"

#include "../mwbase/world.hpp"

#include "contentloader.hpp"

namespace Ogre
{
    class Vector3;
}

namespace ESM
{
    struct Position;
}

namespace Files
{
    class Collections;
}

namespace Render
{
    class OgreRenderer;
}

namespace MWRender
{
    class SkyManager;
    class CellRender;
    class Animation;
}

struct ContentLoader;

namespace MWWorld
{
    class WeatherManager;
    class Player;


    class World : public MWBase::World
    {
            MWWorld::Fallback mFallback;
            MWRender::RenderingManager* mRendering;

            MWWorld::WeatherManager* mWeatherManager;

            MWWorld::Scene *mWorldScene;
            MWWorld::Player *mPlayer;
            std::vector<ESM::ESMReader> mEsm;
            MWWorld::ESMStore mStore;
            LocalScripts mLocalScripts;
            MWWorld::Globals *mGlobalVariables;
            MWWorld::PhysicsSystem *mPhysics;
            bool mSky;

            Cells mCells;

            OEngine::Physic::PhysicEngine* mPhysEngine;

            bool mGodMode;

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

            Ptr getPtrViaHandle (const std::string& handle, Ptr::CellStore& cellStore);

            int mActivationDistanceOverride;
            std::string mFacedHandle;
            float mFacedDistance;

            std::map<MWWorld::Ptr, int> mDoorStates;

            struct ProjectileState
            {
                // Id of spell or enchantment to apply when it hits
                std::string mId;

                // Actor who casted this projectile
                std::string mActorHandle;

                // Name of item to display as effect source in magic menu (in case we casted an enchantment)
                std::string mSourceName;

                ESM::EffectList mEffects;

                float mSpeed;

                bool mStack;
            };

            std::map<MWWorld::Ptr, ProjectileState> mProjectiles;
            void updateWeather(float duration);
            int getDaysPerMonth (int month) const;

            void rotateObjectImp (const Ptr& ptr, Ogre::Vector3 rot, bool adjust);

            bool moveObjectImp (const Ptr& ptr, float x, float y, float z);

            Ptr copyObjectToCell(const Ptr &ptr, CellStore &cell, const ESM::Position &pos, bool adjustPos=true);

            void updateWindowManager ();
            void performUpdateSceneQueries ();
            void updateFacedHandle ();

            float getMaxActivationDistance ();
            float getNpcActivationDistance ();
            float getObjectActivationDistance ();

            void removeContainerScripts(const Ptr& reference);
            void addContainerScripts(const Ptr& reference, Ptr::CellStore* cell);
            void PCDropped (const Ptr& item);

            void processDoors(float duration);

            void moveProjectiles(float duration);

            void doPhysics(float duration);

            void ensureNeededRecords();

            void loadContentFiles(const Files::Collections& fileCollections,
                const std::vector<std::string>& content, ContentLoader& contentLoader);

            int mPlayIntro;

            bool mTeleportEnabled;
            bool mLevitationEnabled;

            void objectLeftActiveCell (MWWorld::Ptr object, MWWorld::Ptr movedPtr);

            float feetToGameUnits(float feet);

        public:

            World (OEngine::Render::OgreRenderer& renderer,
                const Files::Collections& fileCollections,
                const std::vector<std::string>& contentFiles,
                const boost::filesystem::path& resDir, const boost::filesystem::path& cacheDir,
                ToUTF8::Utf8Encoder* encoder, const std::map<std::string,std::string>& fallbackMap, int mActivationDistanceOverride);

            virtual ~World();

            virtual void startNewGame();

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

            virtual CellStore *getExterior (int x, int y);

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

            virtual void setWaterHeight(const float height);

            virtual void toggleWater();

            virtual void adjustSky();

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

            virtual const Fallback *getFallback() const;

            virtual Player& getPlayer();

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

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

            virtual LocalScripts& getLocalScripts();

            virtual bool hasCellChanged() const;

            virtual bool isCellExterior() const;

            virtual bool isCellQuasiExterior() const;

            virtual Ogre::Vector2 getNorthVector (CellStore* cell);

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

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

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

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

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

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

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

            virtual std::string getCurrentCellName () const;

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

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

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

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

            virtual void adjustPosition (const Ptr& ptr);

            virtual void enable (const Ptr& ptr);

            virtual void disable (const Ptr& ptr);

            virtual void advanceTime (double hours);

            virtual void setHour (double hour);

            virtual void setMonth (int month);

            virtual void setDay (int day);

            virtual int getDay();
            virtual int getMonth();

            virtual TimeStamp getTimeStamp() const;

            virtual bool toggleSky();

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

            virtual int getCurrentWeather() const;

            virtual int getMasserPhase() const;

            virtual int getSecundaPhase() const;

            virtual void setMoonColour (bool red);

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

            virtual float getTimeScaleFactor() const;

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

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

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

            virtual void markCellAsUnchanged();

            virtual MWWorld::Ptr getFacedObject();

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

            virtual void deleteObject (const Ptr& ptr);

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

            virtual void scaleObject (const Ptr& ptr, float scale);

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

            virtual void localRotateObject (const Ptr& ptr, float x, float y, float z);

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

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

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

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

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

            virtual bool toggleCollisionMode();

            virtual bool toggleRenderMode (RenderMode mode);

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

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

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

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

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

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

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

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

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

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

            virtual void update (float duration, bool paused);

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

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

            virtual bool canPlaceObject(float cursorX, float cursorY);

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

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

            virtual void togglePOV() {
                mRendering->togglePOV();
            }

            virtual void togglePreviewMode(bool enable) {
                mRendering->togglePreviewMode(enable);
            }

            virtual bool toggleVanityMode(bool enable) {
                return mRendering->toggleVanityMode(enable);
            }

            virtual void allowVanityMode(bool allow) {
                mRendering->allowVanityMode(allow);
            }

            virtual void togglePlayerLooking(bool enable) {
                mRendering->togglePlayerLooking(enable);
            }

            virtual void changeVanityModeScale(float factor) {
                mRendering->changeVanityModeScale(factor);
            }

            virtual bool vanityRotateCamera(float * rot);
            virtual void setCameraDistance(float dist, bool adjust = false, bool override = true);

            virtual void setupPlayer();
            virtual void renderPlayer();

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

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

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

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

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

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

            virtual int canRest();

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

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

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

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

            virtual void enableTeleporting(bool enable);

            virtual bool isTeleportingEnabled() const;

            virtual void enableLevitation(bool enable);

            virtual bool isLevitationEnabled() const;

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

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

            virtual bool getGodModeState();

            virtual bool toggleGodMode();

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

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

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

            virtual void breakInvisibility (const MWWorld::Ptr& actor);
            // Are we in an exterior or pseudo-exterior cell and it's night?
            virtual bool isDark() const;

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

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

            virtual void listDetectedReferences (const MWWorld::Ptr& ptr, std::vector<MWWorld::Ptr>& out,
                                                  DetectionType type);
    };
}

#endif