location.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 STARK_RESOURCES_LOCATION_H
#define STARK_RESOURCES_LOCATION_H

#include "common/hashmap.h"
#include "common/rect.h"
#include "common/str.h"

#include "engines/stark/gfx/renderentry.h"
#include "engines/stark/resources/object.h"

namespace Stark {

namespace Formats {
class XRCReadStream;
}

namespace Resources {

class ItemVisual;
class Layer;
class ModelItem;
class Sound;

class Location : public Object {
public:
    static const Type::ResourceType TYPE = Type::kLocation;

    Location(Object *parent, byte subType, uint16 index, const Common::String &name);
    virtual ~Location();

    // Resource API
    void onAllLoaded() override;
    void onEnterLocation() override;
    void onGameLoop() override;
    void saveLoadCurrent(ResourceSerializer *serializer) override;

    bool has3DLayer();

    Gfx::RenderEntryArray listRenderEntries();

    Gfx::LightEntryArray listLightEntries();

    void initScroll(const Common::Point &maxScroll);

    Common::Point getScrollPosition() const;

    void setScrollPosition(const Common::Point &position);

    bool scrollToCoordinateSmooth(uint32 coordinate);

    void scrollToCharacterImmediate();

    void goToLayer(Layer *layer);

    void setHasActiveScroll();

    void stopAllScrolls();

    void startFollowingCharacter();

    void stopFollowingCharacter();

    void scrollToCoordinateImmediate(uint32 coordinate);

    ItemVisual *getCharacterItem(int32 character) const;

    void registerCharacterItem(int32 character, ItemVisual *item);

    const Common::Array<ModelItem *> &listModelItems() const;

    void resetAnimationBlending();

    Sound *findStockSound(uint32 stockSoundType) const;

    void startRumble(int32 rumbleDurationRemaining);

    void fadeInInit(int32 fadeDuration);
    void fadeOutInit(int32 fadeDuration);

    void swayScene(int32 periodMs, const Math::Angle &angle, float amplitude, float offset);

    void floatScene(int32 periodMs, float amplitude, float offset);

    Layer *getLayerByName(const Common::String &name);

    Gfx::RenderEntry *getRenderEntryByName(const Common::String &name);

    Common::Array<Layer *> listLayers() { return _layers; }

    Common::Array<Common::Point> listExitPositions();

protected:
    void printData() override;

private:
    bool scrollToSmooth(const Common::Point &position, bool followCharacter);
    bool scrollToCharacter(ModelItem *item);
    Common::Point getCharacterScrollPosition(ModelItem *item);
    uint getScrollStepFollow();
    Common::Point getScrollPointFromCoordinate(uint32 coordinate) const;

    Sound *findStockSound(const Object *parent, uint32 stockSoundType) const;

    Common::Array<Layer *> _layers;
    Layer *_currentLayer;

    bool _canScroll;
    bool _hasActiveScroll;
    bool _scrollFollowCharacter;
    Common::Point _scroll;
    Common::Point _maxScroll;

    uint getScrollStep();

    typedef Common::HashMap<int32, ItemVisual *> CharacterMap;
    CharacterMap _characterItemMap;

    Common::Array<ModelItem *> _modelItems;

    int32 _rumbleDurationRemaining;

    bool _fadeOut;
    int32 _fadeDuration;
    float _fadePosition;

    int32 _swayPeriodMs;
    Math::Angle _swayAngle;
    float _swayAmplitude;
    float _swayOffset;
    float _swayPosition;

    int32 _idleActionWaitMs;

    int32 _floatPeriodMs;
    float _floatAmplitude;
    float _floatPosition;
};

} // End of namespace Resources
} // End of namespace Stark

#endif // STARK_RESOURCES_LOCATION_H