scene.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef ASYLUM_VIEWS_SCENE_H
#define ASYLUM_VIEWS_SCENE_H
 
#include "common/array.h"
#include "common/events.h"
#include "common/rational.h"
 
#include "graphics/surface.h"
 
#include "asylum/system/screen.h"
 
#include "asylum/eventhandler.h"
#include "asylum/shared.h"
 
#define SCENE_FILE_MASK "scn.%03d"
#define MUSIC_FILE_MASK "mus.%03d"
 
// If defined, will show the scene update times on the debugger output
//#define DEBUG_SCENE_TIMES
 
namespace Asylum {
 
class Actor;
class AsylumEngine;
class Puzzle;
class Cursor;
class GraphicResource;
class Polygons;
class Polygon;
class ResourcePack;
class SceneTitle;
class Screen;
class Special;
class Speech;
class Sound;
class Text;
class VideoPlayer;
class WorldStats;
 
struct ActionArea;
struct AmbientSoundItem;
struct GraphicFrame;
struct ObjectItem;
 
enum HitType {
    kHitNone       = -1,
    kHitActionArea = 2,
    kHitObject    = 3,
    kHitActor      = 4
};
 
enum ActionAreaType {
    kActionAreaType1 = 1,
    kActionAreaType2 = 2
};
 
enum KeyDirection {
    kWalkUp = 1,
    kWalkDown = 2,
    kWalkLeft = 4,
    kWalkRight = 8
};
 
class Scene : public EventHandler {
public:
    Scene(AsylumEngine *engine);
    virtual ~Scene();
 
    void load(ResourcePackId packId);
 
    void enter(ResourcePackId packId);
 
    void enterLoad();
 
    bool handleEvent(const AsylumEvent &ev);
 
    ResourcePackId  getPackId() { return _packId; }
 
    Actor *getActor(ActorIndex index = kActorInvalid);
 
    void changePlayer(ActorIndex index);
 
    void changePlayerUpdate(ActorIndex index);
 
    bool updateSceneCoordinates(int32 targetX, int32 targetY, int32 val, bool checkSceneCoords = false, int32 *param = NULL);
 
    bool updateScreen();
 
    void updateAmbientSounds();
 
    void drawRain();
 
    int32 findActionArea(ActionAreaType type, const Common::Point &pt, bool highlight = false);
 
    bool rectIntersect(int32 x, int32 y, int32 x1, int32 y1, int32 x2, int32 y2, int32 x3, int32 y3) const;
 
    Polygons    *polygons()   { return _polygons; }
    WorldStats  *worldstats() { return _ws; }
    uint32 getFrameCounter() { return _frameCounter; }
 
    const byte *getSavedPalette() { return _savedPalette; }
    const Graphics::Surface &getSavedScreen() { return _savedScreen; }
 
private:
    AsylumEngine  *_vm;
 
    ResourcePackId _packId;
 
    Polygons     *_polygons;
    WorldStats   *_ws;
 
    struct UpdateItem {
        ActorIndex index;
        int32 priority;
    };
 
    // Music volume
    int32 _musicVolume;
 
    Common::Array<UpdateItem> _updateList;
    uint32 _frameCounter;
 
    Graphics::Surface _savedScreen;
    byte _savedPalette[PALETTE_SIZE];
 
    bool _debugShowVersion;
 
    byte _keyState;
    bool _rightButtonDown;
 
    // Message handling
    void activate();
    bool init();
    bool update();
    bool actionDown(AsylumAction a);
    bool actionUp(AsylumAction a);
    bool key(const AsylumEvent &evt);
    bool clickDown(const AsylumEvent &evt);
 
    // Scene update
 
    bool updateScene();
 
    void updateMouse();
 
    void updateActors();
 
    void updateObjects();
 
    void updateMusic();
 
    void updateAdjustScreen();
 
    void updateCoordinates();
 
    void updateCursor(ActorDirection direction, const Common::Rect &rect);
 
    // Scene drawing
 
    void preload();
 
    bool drawScene();
 
    void buildUpdateList();
 
    void processUpdateList();
 
    static bool updateListCompare(const UpdateItem &item1, const UpdateItem &item2);
 
    void checkVisibleActorsPriority();
 
    void adjustActorPriority(ActorIndex index);
 
    int32 _chapter5RainFrameIndex;
 
    // HitTest
 
    int32 hitTest(HitType &type);
 
    int32 hitTestScene(HitType &type);
 
    int32 hitTestActionArea();
 
    ActorIndex hitTestActor();
 
    bool hitTestPlayer();
 
    int32 hitTestObject();
 
    bool hitTestPixel(ResourceId resourceId, uint32 frame, int16 x, int16 y, bool flipped);
 
    // Hit actions
 
    void handleHit(int32 index, HitType type);
 
    void clickInventory();
 
    void hitAreaChapter2(int32 id);
    bool _isCTRLPressed;
    int32 _hitAreaChapter7Counter;
    void hitAreaChapter7(int32 id);
    void hitAreaChapter11(int32 id);
 
    void hitActorChapter2(ActorIndex index);
    void hitActorChapter11(ActorIndex index);
 
    // Helpers
 
    void playIntroSpeech();
 
    void stopSpeech();
 
    bool speak(Common::KeyCode code);
 
    bool pointBelowLine(const Common::Point &point, const Common::Rect &rect) const;
 
    void adjustCoordinates(Common::Point *point);
 
    // Scene debugging
    void debugShowActors();
    void debugShowObjects();
    void debugShowPolygons();
    void debugShowPolygon(uint32 index, uint32 color = 0xFF);
    void debugHighlightPolygon(uint32 index);
    void debugShowSceneRects();
    void debugScreenScrolling();
    void debugShowWalkRegion(Polygon *poly);
 
    friend class SceneTitle;
};
 
} // end of namespace Asylum
 
#endif // ASYLUM_VIEWS_SCENE_H