control.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 ZVISION_CONTROL_H
#define ZVISION_CONTROL_H

#include "common/keyboard.h"
#include "common/str.h"

namespace Common {
class SeekableReadStream;
struct Point;
class WriteStream;
}

namespace ZVision {

class ZVision;

class Control {
public:

    enum ControlType {
        CONTROL_UNKNOW,
        CONTROL_INPUT,
        CONTROL_PUSHTGL,
        CONTROL_SLOT,
        CONTROL_LEVER,
        CONTROL_SAVE,
        CONTROL_SAFE,
        CONTROL_FIST,
        CONTROL_TITLER,
        CONTROL_HOTMOV,
        CONTROL_PAINT
    };

    Control(ZVision *engine, uint32 key, ControlType type) : _engine(engine), _key(key), _type(type), _venusId(-1) {}
    virtual ~Control() {}

    uint32 getKey() {
        return _key;
    }

    ControlType getType() {
        return _type;
    }

    virtual void focus() {}
    virtual void unfocus() {}
    virtual bool onMouseDown(const Common::Point &screenSpacePos, const Common::Point &backgroundImageSpacePos) {
        return false;
    }
    virtual bool onMouseUp(const Common::Point &screenSpacePos, const Common::Point &backgroundImageSpacePos) {
        return false;
    }
    virtual bool onMouseMove(const Common::Point &screenSpacePos, const Common::Point &backgroundImageSpacePos) {
        return false;
    }
    virtual bool onKeyDown(Common::KeyState keyState) {
        return false;
    }
    virtual bool onKeyUp(Common::KeyState keyState) {
        return false;
    }
    virtual bool process(uint32 deltaTimeInMillis) {
        return false;
    }

    void setVenus();

protected:
    ZVision *_engine;
    uint32 _key;
    int32 _venusId;

    void getParams(const Common::String &inputStr, Common::String &parameter, Common::String &values);
// Static member functions
public:
    static void parseFlatControl(ZVision *engine);
    static void parsePanoramaControl(ZVision *engine, Common::SeekableReadStream &stream);
    static void parseTiltControl(ZVision *engine, Common::SeekableReadStream &stream);
private:
    ControlType _type;
};

} // End of namespace ZVision

#endif