staticprovider.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_SERVICES_STATIC_PROVIDER_H
#define STARK_SERVICES_STATIC_PROVIDER_H

#include "common/array.h"
#include "common/path.h"
#include "common/scummsys.h"

namespace Stark {

namespace Resources {
class Anim;
class Image;
class Level;
class Location;
class Sound;
}

class ArchiveLoader;
class Global;
class VisualImageXMG;

class StaticProvider {
public:
    explicit StaticProvider(ArchiveLoader *archiveLoader);

    enum UIElement {
        kInventoryScrollUpArrow = 1,
        kInventoryScrollDownArrow = 2,
        kImages = 4,
        kActionMenuBg = 5,
        kTextScrollUpArrow = 6,
        kTextScrollDownArrow = 7,
        kQuit = 8,
        kCheckMark = 13,
        kVolume = 14,
        kDiaryNormal = 15,
        kInventory = 16,
        kExitArrow = 17,
        kExitArrowLeft = 18,
        kExitArrowRight = 19,
        kTextBackgroundActive = 20,
        kTextBackgroundPassive = 21,
        kDiaryTabbed = 22
    };

    enum UIImage {
        kInventoryBg = 0,
        kDialogOptionBullet = 4
    };

    enum UISound {
        kActionMouthHover = 0,
        kActionHover = 1,
        kInventoryNewItem = 2
    };

    void init();

    void onGameLoop();

    void shutdown();

    Resources::Level *getLevel() const { return _level; }

    VisualImageXMG *getCursorImage(uint32 cursor) const;

    VisualImageXMG *getUIElement(UIElement element) const;
    VisualImageXMG *getUIElement(UIElement element, uint32 index) const;

    VisualImageXMG *getUIImage(UIImage image) const;

    Resources::Sound *getUISound(UISound sound) const;

    void goToAnimScriptStatement(UIElement stockUIElement, int animScriptItemIndex);

    Resources::Location *loadLocation(const char *locationName);

    bool isStaticLocation() const;

    Resources::Location *getLocation() const;

    Resources::Sound *getLocationSound(uint16 index) const;

    void unloadLocation(Resources::Location *location);

private:
    ArchiveLoader *_archiveLoader;

    Resources::Level *_level;
    Resources::Location *_location;
    Common::Array<Resources::Anim *> _stockAnims;
    Common::Array<Resources::Image *> _stockImages;

    Common::Path buildLocationArchiveName(const char *locationName) const;
};

} // End of namespace Stark

#endif // STARK_SERVICES_STATIC_PROVIDER_H