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_WITCHER_AREA_H
#define ENGINES_WITCHER_AREA_H

#include <list>
#include <map>

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

#include "src/aurora/types.h"
#include "src/aurora/locstring.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/witcher/object.h"

namespace Engines {

namespace Witcher {

class Module;

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

    // General properties

    const Common::UString &getResRef() const;
    const Aurora::LocString &getName() const;

    void refreshLocalized();

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

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

    // Events

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

    void removeFocus();


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


protected:
    void notifyCameraMoved();


private:
    typedef Common::PtrList<Engines::Witcher::Object> ObjectList;
    typedef std::map<uint32, Engines::Witcher::Object *> ObjectMap;


    Module *_module;

    Common::UString _resRef; 

    uint32 _musicDayTrack;    
    uint32 _musicNightTrack;  
    uint32 _musicBattleTrack; 

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

    bool _visible; 

    Sound::ChannelHandle _ambientMusic; 

    Common::UString _modelName; 
    Common::ScopedPtr<Graphics::Aurora::Model> _model; 

    ObjectList _objects;   
    ObjectMap  _objectMap; 

    Engines::Witcher::Object *_activeObject;

    bool _highlightAll; 

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

    Common::Mutex _mutex; 


    // Loading helpers

    void clear();

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

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

    void loadObject(Engines::Witcher::Object &object);
    void loadWaypoints (const Aurora::GFF3List &list);
    void loadPlaceables(const Aurora::GFF3List &list);
    void loadDoors     (const Aurora::GFF3List &list);

    // Model loading/unloading helpers

    void loadModels();
    void unloadModels();

    void loadAreaModel();
    void unloadAreaModel();

    // Highlight / active helpers

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

    void highlightAll(bool enabled);

    void click(int x, int y);
};

} // End of namespace Witcher

} // End of namespace Engines

#endif // ENGINES_WITCHER_AREA_H