pet_section.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 TITANIC_PET_SECTION_H
#define TITANIC_PET_SECTION_H

#include "titanic/messages/mouse_messages.h"
#include "titanic/support/simple_file.h"

namespace Titanic {

enum PetArea {
    PET_INVENTORY = 0, PET_CONVERSATION = 1, PET_REMOTE = 2,
    PET_ROOMS = 3, PET_REAL_LIFE = 4, PET_STARFIELD = 5, PET_TRANSLATION = 6
};

class CPetControl;
class CPetElement;
class CTextControl;
class CScreenManager;
class CRoomItem;

struct CPetSectionSubData {
    int _field0;
    int _field4;
    int _field8;
    int _fieldC;

    CPetSectionSubData() : _field0(0), _field4(0), _field8(0),
        _fieldC(0) {}
};

class CPetSection {
public:
    CPetControl *_petControl;
protected:
    void areaChanged(PetArea area);

    CString getActiveNPCName() const;

    void copyColors(uint tableNum, uint colors[5]);
public:
    CPetSection() : _petControl(nullptr) {}
    virtual ~CPetSection() {}

    virtual bool setup(CPetControl *petControl) { return false; }

    virtual bool reset() { return false; }

    virtual void draw(CScreenManager *screenManager) {}

    virtual Rect getBounds() const { return Rect(); }

    virtual void changed(int changeType) {}

    virtual bool MouseButtonDownMsg(CMouseButtonDownMsg *msg) { return false; }
    virtual bool MouseDragStartMsg(CMouseDragStartMsg *msg) { return false; }
    virtual bool MouseDragMoveMsg(CMouseDragMoveMsg *msg) { return false; }
    virtual bool MouseDragEndMsg(CMouseDragEndMsg *msg) { return false; }
    virtual bool MouseButtonUpMsg(CMouseButtonUpMsg *msg) { return false; }
    virtual bool MouseDoubleClickMsg(CMouseDoubleClickMsg *msg) { return false; }
    virtual bool MouseWheelMsg(CMouseWheelMsg *msg) { return false; }
    virtual bool KeyCharMsg(CKeyCharMsg *msg) { return false; }
    virtual bool VirtualKeyCharMsg(CVirtualKeyCharMsg *msg) { return false; }

    virtual bool checkDragEnd(CGameObject *item) { return false; }

    virtual CGameObject *dragEnd(const Point &pt) const { return nullptr; }

    virtual void displayMessage(const CString &msg);

    virtual bool isValid(CPetControl *petControl) { return false; }

    virtual void load(SimpleFile *file, int param) {}

    virtual void postLoad() {}

    virtual void save(SimpleFile *file, int indent) {}

    virtual void enter(PetArea oldArea) {}

    virtual void leave() {}

    virtual void proc23() {}

    virtual void enterRoom(CRoomItem *room) {}

    virtual void timerExpired(int val);

    virtual CTextControl *getText() { return nullptr; }

    virtual void removeText(int duration);

    virtual void removeText();

    virtual void stopTextTimer();

    virtual CPetElement *getElement(uint id) { return nullptr; }

    virtual CGameObject *getBackground(int index) const { return nullptr; }

    virtual void displayNPCName(CGameObject *npc) {}

    virtual void proc33() {}

    virtual void setNPC(const CString &name) {}

    virtual void resetNPC() {}

    virtual void showCursor() {}

    virtual void hideCursor() {}

    virtual void highlight(int id) {}

    CPetControl *getPetControl() const { return _petControl; }

    uint getColor(uint index);

    const uint *getColorTable(int tableNum = -1);
};

} // End of namespace Titanic

#endif /* TITANIC_PET_SECTION_H */