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_NWN_AREA_H
#define ENGINES_NWN_AREA_H

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

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

#include "src/aurora/types.h"

#include "src/graphics/aurora/types.h"

#include "src/sound/types.h"

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

#include "src/engines/nwn/tileset.h"
#include "src/engines/nwn/object.h"

namespace Engines {

namespace NWN {

class Module;

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

    // General properties

    const Common::UString &getResRef();
    const Common::UString &getName();
    const Common::UString &getDisplayName();

    const Common::UString &getEnvironmentMap() const;

    // 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();


    static Common::UString getName(const Common::UString &resRef);


protected:
    void notifyCameraMoved();


private:
    enum Orientation {
        kOrientation0   = 0, 
        kOrientation90  = 1, 
        kOrientation180 = 2, 
        kOrientation270 = 3  
    };

    struct Tile {
        uint32 tileID; 

        uint32 height; 
        Orientation orientation; 

        uint8 mainLight[2]; 
        uint8  srcLight[2]; 

        bool animLoop[3]; 

        const Tileset::Tile *tile; 

        Graphics::Aurora::Model *model; 
    };

    typedef Common::PtrList<NWN::Object> ObjectList;
    typedef std::map<uint32, NWN::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; 

    uint32 _width;  
    uint32 _height; 

    Common::UString _tilesetName; 
    Common::ScopedPtr<Tileset> _tileset; 

    std::vector<Tile> _tiles; 

    ObjectList _objects;   
    ObjectMap  _objectMap; 

    NWN::Object *_activeObject;

    bool _highlightAll; 

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

    Common::Mutex _mutex; 


    // Loading helpers

    void clear();
    void load();

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

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

    void loadTiles(const Aurora::GFF3List &tiles);
    void loadTile(const Aurora::GFF3Struct &t, Tile &tile);

    void loadObject(NWN::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);

    // Model loading/unloading helpers

    void loadModels();
    void unloadModels();

    void loadTileModels();
    void unloadTileModels();

    void loadTileset();
    void unloadTileset();

    void loadTiles();
    void unloadTiles();

    // Highlight / active helpers

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

    void highlightAll(bool enabled);

    void click(int x, int y);


    static Common::UString createDisplayName(const Common::UString &name);

    friend class Console;
};

} // End of namespace NWN

} // End of namespace Engines

#endif // ENGINES_NWN_AREA_H