area.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_KOTOR2_AREA_H
#define ENGINES_KOTOR2_AREA_H

#include <vector>
#include <list>
#include <map>

#include "src/common/ptrlist.h"
#include "src/common/ustring.h"
#include "src/common/mutex.h"

#include "src/aurora/types.h"
#include "src/aurora/lytfile.h"
#include "src/aurora/visfile.h"

#include "src/sound/types.h"

#include "src/events/types.h"
#include "src/events/notifyable.h"

#include "src/engines/kotor2/object.h"
#include "src/engines/kotor2/trigger.h"

namespace Engines {

namespace KotOR2 {

class Module;
class Room;
class Situated;

class Area : public KotOR2::Object, public Events::Notifyable {
public:
    Area(Module &module, const Common::UString &resRef);
    ~Area();

    // General properties

    const Common::UString &getResRef();

    // Visibility

    void show();
    void hide();

    // Music/Sound

    uint32 getMusicDayTrack   () const; 
    uint32 getMusicNightTrack () const; 
    uint32 getMusicBattleTrack() const; 

    void setMusicDayTrack   (uint32 track); 
    void setMusicNightTrack (uint32 track); 
    void setMusicBattleTrack(uint32 track); 

    void stopSound();        
    void stopAmbientMusic(); 
    void stopAmbientSound(); 

    void playAmbientMusic(Common::UString music = "");
    void playAmbientSound(Common::UString sound = "");

    // Events

    void addEvent(const Events::Event &event);
    void processEventQueue();

    void removeFocus();

    // Walkmesh
    float evaluateElevation(float x, float y);
    bool testCollision(const glm::vec3 &orig, const glm::vec3 &dest) const;
    void toggleWalkmesh();

    // .--- Triggers
    void toggleTriggers();
    void evaluateTriggers(float x, float y);
    // '---

    void showAllRooms();

    void notifyObjectMoved(Object &o);
    void notifyPCMoved();

    void getCameraStyle(float &distance, float &pitch, float &height) const;
    const std::vector<Common::UString> &getRoomsVisibleFrom(const Common::UString &room) const;
    KotOR2::Object *getActiveObject();
    KotOR2::Object *getObjectByTag(const Common::UString &tag);


protected:
    void notifyCameraMoved();


private:
    struct CameraStyle {
        float distance;
        float pitch;
        float height;

        CameraStyle();
    };

    typedef Common::PtrList<Room> RoomList;

    typedef Common::PtrList<KotOR2::Object> ObjectList;
    typedef std::map<uint32, KotOR2::Object *> ObjectMap;


    Module *_module; 

    Common::UString _resRef;      
    Common::UString _displayName; 

    Common::UString _ambientDay;   
    Common::UString _ambientNight; 

    uint32 _musicDayTrack;    
    uint32 _musicNightTrack;  
    uint32 _musicBattleTrack; 

    Common::UString _musicDay;    
    Common::UString _musicNight;  
    Common::UString _musicBattle; 

    std::vector<Common::UString> _musicBattleStinger;

    float _ambientDayVol;   
    float _ambientNightVol; 

    bool _visible; 

    Sound::ChannelHandle _ambientSound; 
    Sound::ChannelHandle _ambientMusic; 

    Aurora::LYTFile _lyt; 
    Aurora::VISFile _vis; 

    RoomList _rooms; 

    ObjectList _objects;   
    ObjectMap  _objectMap; 

    KotOR2::Object *_activeObject;

    bool _highlightAll; 

    std::list<Events::Event> _eventQueue; 

    Common::Mutex _mutex; 

    std::vector<Trigger *> _triggers;
    bool _triggersVisible;
    Trigger *_activeTrigger;

    CameraStyle _cameraStyle;
    bool _walkmeshInvisible;
    std::list<Situated *> _situatedObjects;


    // Loading helpers

    void clear();
    void load();

    void loadLYT();
    void loadVIS();

    void loadARE(const Aurora::GFF3Struct &are);
    void loadGIT(const Aurora::GFF3Struct &git);

    void loadCameraStyle(uint32 id);

    void loadRooms();

    void loadProperties(const Aurora::GFF3Struct &props);

    void loadObject(KotOR2::Object &object);

    void loadWaypoints (const Aurora::GFF3List &list);
    void loadPlaceables(const Aurora::GFF3List &list);
    void loadDoors     (const Aurora::GFF3List &list);
    void loadCreatures (const Aurora::GFF3List &list);
    void loadTriggers  (const Aurora::GFF3List &list);

    void unload();

    // Highlight / active helpers

    void checkActive(int x = -1, int y = -1);
    void setActive(KotOR2::Object *object);
    KotOR2::Object *getObjectAt(int x, int y);

    void highlightAll(bool enabled);

    void click(int x, int y);

    Room *getRoomAt(float x, float y) const;


    friend class Console;
};

} // End of namespace KotOR2

} // End of namespace Engines

#endif // ENGINES_KOTOR2_AREA_H