worldimp.hpp

Go to the documentation of this file.

#ifndef GAME_MWWORLD_WORLDIMP_H
#define GAME_MWWORLD_WORLDIMP_H

#include <osg/ref_ptr>

#include <components/settings/settings.hpp>
#include <components/fallback/fallback.hpp>

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

#include "ptr.hpp"
#include "scene.hpp"
#include "esmstore.hpp"
#include "cells.hpp"
#include "localscripts.hpp"
#include "timestamp.hpp"
#include "globals.hpp"
#include "contentloader.hpp"

namespace osg
{
    class Group;
}

namespace osgViewer
{
    class Viewer;
}

namespace Resource
{
    class ResourceSystem;
}

namespace SceneUtil
{
    class WorkQueue;
}

namespace ESM
{
    struct Position;
}

namespace Files
{
    class Collections;
}

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

namespace ToUTF8
{
    class Utf8Encoder;
}

struct ContentLoader;

namespace MWWorld
{
    class WeatherManager;
    class Player;
    class ProjectileManager;


    class World final: public MWBase::World
    {
            Resource::ResourceSystem* mResourceSystem;

            Fallback::Map mFallback;

            std::vector<ESM::ESMReader> mEsm;
            MWWorld::ESMStore mStore;
            LocalScripts mLocalScripts;
            MWWorld::Globals mGlobalVariables;
            bool mSky;

            ESM::Variant* mGameHour;
            ESM::Variant* mDaysPassed;
            ESM::Variant* mDay;
            ESM::Variant* mMonth;
            ESM::Variant* mYear;
            ESM::Variant* mTimeScale;

            Cells mCells;

            std::string mCurrentWorldSpace;

            std::unique_ptr<MWWorld::Player> mPlayer;
            std::unique_ptr<MWPhysics::PhysicsSystem> mPhysics;
            std::unique_ptr<MWRender::RenderingManager> mRendering;
            std::unique_ptr<MWWorld::Scene> mWorldScene;
            std::unique_ptr<MWWorld::WeatherManager> mWeatherManager;
            std::shared_ptr<ProjectileManager> mProjectileManager;

            bool mGodMode;
            bool mScriptsEnabled;
            std::vector<std::string> mContentFiles;

            std::string mUserDataPath;

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

            int mActivationDistanceOverride;

            std::string mStartupScript;

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

            std::string mStartCell;

            void updateWeather(float duration, bool paused = false);
            int getDaysPerMonth (int month) const;

            void rotateObjectImp (const Ptr& ptr, const osg::Vec3f& rot, bool adjust);

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

            Ptr copyObjectToCell(const ConstPtr &ptr, CellStore* cell, ESM::Position pos, int count, bool adjustPos);

            void updateSoundListener();
            void updatePlayer();

            void preloadSpells();

            MWWorld::Ptr getFacedObject(float maxDistance, bool ignorePlayer=true);

    public: // FIXME
            void removeContainerScripts(const Ptr& reference) override;
    private:
            void addContainerScripts(const Ptr& reference, CellStore* cell);
            void PCDropped (const Ptr& item);

            void processDoors(float duration);

            void doPhysics(float duration);

            void ensureNeededRecords();

            void fillGlobalVariables();

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

            float mSwimHeightScale;

            float mDistanceToFacedObject;

            bool mTeleportEnabled;
            bool mLevitationEnabled;
            bool mGoToJail;
            int mDaysInPrison;
            bool mPlayerTraveling;
            bool mPlayerInJail;

            float mSpellPreloadTimer;

            float feetToGameUnits(float feet);
            float getActivationDistancePlusTelekinesis();

            MWWorld::ConstPtr getClosestMarker( const MWWorld::Ptr &ptr, const std::string &id );
            MWWorld::ConstPtr getClosestMarkerFromExteriorPosition( const osg::Vec3f& worldPos, const std::string &id );

        public:

            World (
                osgViewer::Viewer* viewer,
                osg::ref_ptr<osg::Group> rootNode,
                Resource::ResourceSystem* resourceSystem, SceneUtil::WorkQueue* workQueue,
                const Files::Collections& fileCollections,
                const std::vector<std::string>& contentFiles,
                ToUTF8::Utf8Encoder* encoder, const std::map<std::string,std::string>& fallbackMap,
                int activationDistanceOverride, const std::string& startCell, const std::string& startupScript, const std::string& resourcePath, const std::string& userDataPath);

            virtual ~World();

            void startNewGame (bool bypass) override;

            void clear() override;

            int countSavedGameRecords() const override;
            int countSavedGameCells() const override;

            void write (ESM::ESMWriter& writer, Loading::Listener& progress) const override;

            void readRecord (ESM::ESMReader& reader, uint32_t type,
                const std::map<int, int>& contentFileMap) override;

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

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

            CellStore *getCell (const ESM::CellId& id) override;

            //switch to POV before showing player's death animation
            void useDeathCamera() override;

            void setWaterHeight(const float height) override;

            void rotateWorldObject (const MWWorld::Ptr& ptr, osg::Quat rotate) override;

            bool toggleWater() override;
            bool toggleWorld() override;
            bool toggleBorders() override;

            void adjustSky() override;

            const Fallback::Map *getFallback() const override;

            Player& getPlayer() override;
            MWWorld::Ptr getPlayerPtr() override;

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

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

            LocalScripts& getLocalScripts() override;

            bool hasCellChanged() const override;

            bool isCellExterior() const override;

            bool isCellQuasiExterior() const override;

            osg::Vec2f getNorthVector (const CellStore* cell) override;

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

            void setGlobalInt (const std::string& name, int value) override;

            void setGlobalFloat (const std::string& name, float value) override;

            int getGlobalInt (const std::string& name) const override;

            float getGlobalFloat (const std::string& name) const override;

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

            std::string getCellName (const MWWorld::CellStore *cell = 0) const override;

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

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

            Ptr searchPtr (const std::string& name, bool activeOnly) override;

            Ptr searchPtrViaActorId (int actorId) override;

            MWWorld::Ptr findContainer (const MWWorld::ConstPtr& ptr) override;

            void adjustPosition (const Ptr& ptr, bool force) override;

            void fixPosition (const Ptr& actor) override;

            void enable (const Ptr& ptr) override;

            void disable (const Ptr& ptr) override;

            void advanceTime (double hours, bool incremental = false) override;

            void setHour (double hour) override;

            void setMonth (int month) override;

            void setDay (int day) override;

            int getDay() const override;
            int getMonth() const override;
            int getYear() const override;

            std::string getMonthName (int month = -1) const override;

            TimeStamp getTimeStamp() const override;

            bool toggleSky() override;

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

            int getCurrentWeather() const override;

            int getMasserPhase() const override;

            int getSecundaPhase() const override;

            void setMoonColour (bool red) override;

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

            float getTimeScaleFactor() const override;

            void changeToInteriorCell (const std::string& cellName, const ESM::Position& position, bool adjustPlayerPos, bool changeEvent = true) override;

            void changeToExteriorCell (const ESM::Position& position, bool adjustPlayerPos, bool changeEvent = true) override;

            void changeToCell (const ESM::CellId& cellId, const ESM::Position& position, bool adjustPlayerPos, bool changeEvent=true) override;

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

            void markCellAsUnchanged() override;

            MWWorld::Ptr getFacedObject() override;

            float getDistanceToFacedObject() override;

            std::pair<MWWorld::Ptr,osg::Vec3f> getHitContact(const MWWorld::ConstPtr &ptr, float distance, std::vector<MWWorld::Ptr> &targets) override;

            void deleteObject (const Ptr& ptr) override;

            void undeleteObject (const Ptr& ptr) override;

            MWWorld::Ptr moveObject (const Ptr& ptr, float x, float y, float z) override;

            MWWorld::Ptr moveObject (const Ptr& ptr, CellStore* newCell, float x, float y, float z, bool movePhysics=true) override;

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

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

            MWWorld::Ptr placeObject(const MWWorld::ConstPtr& ptr, MWWorld::CellStore* cell, ESM::Position pos) override;

            MWWorld::Ptr safePlaceObject (const MWWorld::ConstPtr& ptr, const MWWorld::ConstPtr& referenceObject, MWWorld::CellStore* referenceCell, int direction, float distance) override;

            float getMaxActivationDistance() override;

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

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

            void queueMovement(const Ptr &ptr, const osg::Vec3f &velocity) override;

            bool castRay (float x1, float y1, float z1, float x2, float y2, float z2, bool ignoreDoors=false) override;

            bool toggleCollisionMode() override;

            bool toggleRenderMode (MWRender::RenderMode mode) override;

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

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

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

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

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

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

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

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

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

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

            const ESM::CreatureLevList *createOverrideRecord (const ESM::CreatureLevList& record) override;

            const ESM::ItemLevList *createOverrideRecord (const ESM::ItemLevList& record) override;

            void update (float duration, bool paused) override;

            void updateWindowManager () override;

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

            MWWorld::Ptr dropObjectOnGround (const MWWorld::Ptr& actor, const MWWorld::ConstPtr& object, int amount) override;

            bool canPlaceObject(float cursorX, float cursorY) override;

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

            bool isFlying(const MWWorld::Ptr &ptr) const override;
            bool isSlowFalling(const MWWorld::Ptr &ptr) const override;
            bool isSubmerged(const MWWorld::ConstPtr &object) const override;
            bool isSwimming(const MWWorld::ConstPtr &object) const override;
            bool isUnderwater(const MWWorld::CellStore* cell, const osg::Vec3f &pos) const override;
            bool isUnderwater(const MWWorld::ConstPtr &object, const float heightRatio) const override;
            bool isWading(const MWWorld::ConstPtr &object) const override;
            bool isWaterWalkingCastableOnTarget(const MWWorld::ConstPtr &target) const override;
            bool isOnGround(const MWWorld::Ptr &ptr) const override;

            osg::Matrixf getActorHeadTransform(const MWWorld::ConstPtr& actor) const override;

            void togglePOV() override;

            bool isFirstPerson() const override;

            void togglePreviewMode(bool enable) override;

            bool toggleVanityMode(bool enable) override;

            void allowVanityMode(bool allow) override;

            void togglePlayerLooking(bool enable) override;

            void changeVanityModeScale(float factor) override;

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

            void setupPlayer() override;
            void renderPlayer() override;

            void activateDoor(const MWWorld::Ptr& door) override;

            void activateDoor(const MWWorld::Ptr& door, int state) override;

            void getActorsStandingOn (const MWWorld::ConstPtr& object, std::vector<MWWorld::Ptr> &actors) override; 
            bool getPlayerStandingOn (const MWWorld::ConstPtr& object) override; 
            bool getActorStandingOn (const MWWorld::ConstPtr& object) override; 
            bool getPlayerCollidingWith(const MWWorld::ConstPtr& object) override; 
            bool getActorCollidingWith (const MWWorld::ConstPtr& object) override; 
            void hurtStandingActors (const MWWorld::ConstPtr& object, float dmgPerSecond) override;
            void hurtCollidingActors (const MWWorld::ConstPtr& object, float dmgPerSecond) override;

            float getWindSpeed() override;

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

            bool getLOS(const MWWorld::ConstPtr& actor,const MWWorld::ConstPtr& targetActor) override;

            float getDistToNearestRayHit(const osg::Vec3f& from, const osg::Vec3f& dir, float maxDist, bool includeWater = false) override;

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

            RestPermitted canRest() const override;

            void rest() override;

            MWRender::Animation* getAnimation(const MWWorld::Ptr &ptr) override;
            const MWRender::Animation* getAnimation(const MWWorld::ConstPtr &ptr) const override;
            void reattachPlayerCamera() override;

            void screenshot (osg::Image* image, int w, int h) override;
            bool screenshot360 (osg::Image* image, std::string settingStr) override;

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

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

            void enableTeleporting(bool enable) override;

            bool isTeleportingEnabled() const override;

            void enableLevitation(bool enable) override;

            bool isLevitationEnabled() const override;

            bool getGodModeState() override;

            bool toggleGodMode() override;

            bool toggleScripts() override;
            bool getScriptsEnabled() const override;

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

            void castSpell (const MWWorld::Ptr& actor, bool manualSpell=false) override;

            void launchMagicBolt (const std::string& spellId, const MWWorld::Ptr& caster, const osg::Vec3f& fallbackDirection) override;
            void launchProjectile (MWWorld::Ptr& actor, MWWorld::Ptr& projectile,
                                           const osg::Vec3f& worldPos, const osg::Quat& orient, MWWorld::Ptr& bow, float speed, float attackStrength) override;

            void applyLoopingParticles(const MWWorld::Ptr& ptr) override;

            const std::vector<std::string>& getContentFiles() const override;
            void breakInvisibility (const MWWorld::Ptr& actor) override;

            // Allow NPCs to use torches?
            bool useTorches() const override;

            bool findInteriorPositionInWorldSpace(const MWWorld::CellStore* cell, osg::Vec3f& result) override;

            void teleportToClosestMarker (const MWWorld::Ptr& ptr,
                                                  const std::string& id) override;

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

            void updateDialogueGlobals() override;

            void confiscateStolenItems(const MWWorld::Ptr& ptr) override;

            void goToJail () override;

            void spawnRandomCreature(const std::string& creatureList) override;

            void spawnBloodEffect (const MWWorld::Ptr& ptr, const osg::Vec3f& worldPosition) override;

            void spawnEffect (const std::string& model, const std::string& textureOverride, const osg::Vec3f& worldPos, float scale = 1.f, bool isMagicVFX = true) override;

            void explodeSpell(const osg::Vec3f& origin, const ESM::EffectList& effects, const MWWorld::Ptr& caster, const MWWorld::Ptr& ignore,
                                      ESM::RangeType rangeType, const std::string& id, const std::string& sourceName,
                                      const bool fromProjectile=false) override;

            void activate (const MWWorld::Ptr& object, const MWWorld::Ptr& actor) override;

            bool isInStorm() const override;

            osg::Vec3f getStormDirection() const override;

            void resetActors() override;

            bool isWalkingOnWater (const MWWorld::ConstPtr& actor) const override;

            osg::Vec3f aimToTarget(const MWWorld::ConstPtr& actor, const MWWorld::ConstPtr& target) override;

            float getHitDistance(const MWWorld::ConstPtr& actor, const MWWorld::ConstPtr& target) override;

            bool isPlayerInJail() const override;

            void setPlayerTraveling(bool traveling) override;
            bool isPlayerTraveling() const override;

            float getTerrainHeightAt(const osg::Vec3f& worldPos) const override;

            osg::Vec3f getHalfExtents(const MWWorld::ConstPtr& actor, bool rendering=false) const override;

            std::string exportSceneGraph(const MWWorld::Ptr& ptr) override;

            void preloadEffects(const ESM::EffectList* effectList) override;
    };
}

#endif