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_SONIC_AREA_H
#define ENGINES_SONIC_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/events/types.h"
#include "src/events/notifyable.h"

#include "src/engines/sonic/object.h"

namespace Engines {

namespace Sonic {

class Module;

class AreaBackground;
class AreaMiniMap;

class Object;

class Area : public Sonic::Object, public Events::Notifyable {
public:
    Area(Module &module, uint32 id);
    ~Area();

    // General properties

    const Common::UString &getName();

    uint32 getWidth() const;  
    uint32 getHeight() const; 

    float getStartX() const; 
    float getStartY() const; 

    // Entering/Leaving

    void enter(); 
    void leave(); 

    // Visibility

    void show(); 
    void hide(); 

    // Events

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

    void removeFocus();

    // Utility methods

    static void getCameraPosition(float x, float y, float &cameraX, float &cameraY, float &cameraZ);
    static void getWorldPosition(float x, float y, float z, float &worldX, float &worldY, float &worldZ);


protected:
    void notifyCameraMoved();


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


    Module *_module;

    Common::UString _name;
    Common::UString _background;
    Common::UString _layout;

    uint32 _width;
    uint32 _height;

    float _startPosX;
    float _startPosY;

    Common::UString _miniMap;

    uint32 _miniMapWidth;
    uint32 _miniMapHeight;

    Common::UString _soundMap;

    int32 _soundMapBank;
    int32 _sound;
    int32 _soundType;
    int32 _soundBank;

    uint32 _numberRings;
    uint32 _numberChaoEggs;

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

    Common::ScopedPtr<AreaBackground> _bgPanel;
    Common::ScopedPtr<AreaMiniMap>    _mmPanel;

    ObjectList _objects;
    ObjectMap  _objectMap;

    Object *_activeObject;

    bool _highlightAll;

    Common::Mutex _mutex;


    // Loading helpers

    void load();
    void loadDefinition();
    void loadBackground();
    void loadMiniMap();
    void loadLayout();

    void loadObject(Object &object);

    void loadPlaceables(const Aurora::GFF4List &list);

    void getCameraLimits(float &minX, float &minY, float &minZ,
                         float &maxX, float &maxY, float &maxZ) const;

    // Highlight / active helpers

    void checkActive();
    void setActive(Object *object);
    Object *getObjectAt(int x, int y);

    void highlightAll(bool enabled);
};

} // End of namespace Sonic

} // End of namespace Engines

#endif // ENGINES_SONIC_AREA_H