game_object.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_GAME_OBJECT_H
#define TITANIC_GAME_OBJECT_H

#include "audio/mixer.h"
#include "common/stream.h"
#include "titanic/core/named_item.h"
#include "titanic/sound/proximity.h"
#include "titanic/sound/sound_manager.h"
#include "titanic/support/mouse_cursor.h"
#include "titanic/support/credit_text.h"
#include "titanic/support/movie_range_info.h"
#include "titanic/support/rect.h"
#include "titanic/support/strings.h"
#include "titanic/support/movie_clip.h"
#include "titanic/pet_control/pet_section.h"
#include "titanic/gfx/text_control.h"
#include "titanic/game_state.h"

namespace Titanic {

enum Find { FIND_GLOBAL = 1, FIND_ROOM = 2, FIND_PET = 4, FIND_MAILMAN = 8 };
enum Found { FOUND_NONE = 0, FOUND_GLOBAL = 1, FOUND_ROOM = 2, FOUND_PET = 3, FOUND_MAILMAN = 4 };
enum RoomFlagsComparison { RFC_LOCATION = 1, RFC_CLASS_ELEVATOR = 2, RFC_TITANIA = 3 };

enum StarControlAction {
    STAR_SHOW = 0,          
    STAR_HIDE,              
    STAR_VIEW_EARTH,        
    STAR_VIEW_FROM_EARTH,   
    STAR_VIEW_BOUNDARIES,       
    STAR_VIEW_CONSTELLATIONS,   
    STAR_VIEW_RANDOM_STAR,      
    STAR_FULL_SPEED,            
    STAR_TOGGLE_STEREO_PAIR,    
    STAR_TOGGLE_HOME_PHOTO,     
    STAR_TOGGLE_SOLAR_RENDERING,
    STAR_TOGGLE_POS_FRAME,      
    STAR_STEREO_PAIR_ON,        
    STAR_STEREO_PAIR_OFF,       
    STAR_SET_REFERENCE,         
    STAR_FADE_IN,               
    STAR_FADE_OUT,              
    LOCK_STAR,                  
    UNLOCK_STAR,                
    STAR_CLEAR_MODIFIED         
};

class CDontSaveFileItem;
class CMailMan;
class CMusicRoom;
class CRoomItem;
class CStarControl;
class CMouseDragStartMsg;
class CTrueTalkNPC;
class CVideoSurface;
class OSMovie;

class CGameObject : public CNamedItem {
    friend class OSMovie;
    DECLARE_MESSAGE_MAP;
private:
    static int _soundHandles[4];
private:
    void loadResource(const CString &name);

    void processMoveRangeInfo();

    bool clipRect(const Rect &rect1, Rect &rect2) const;
protected:
    static CCreditText *_credits;
protected:
    double _unused1;
    double _unused2;
    double _unused3;
    bool _nonvisual;
    byte _toggleR, _toggleG, _toggleB;
    CMovieClipList _movieClips;
    int _initialFrame;
    CMovieRangeInfoList _movieRangeInfoList;
    int _frameNumber;
    CTextControl *_text;
    uint _textBorder;
    uint _textBorderRight;
    Common::Point _savedPos;
    CVideoSurface *_surface;
    CString _resource;
    int _unused4;
protected:
    void savePosition();

    void resetPosition();

    bool checkStartDragging(CMouseDragStartMsg *msg);

    void gotoView(const CString &viewName, const CString &clipName);

    CViewItem * parseView(const CString &viewString);

    void loadMovie(const CString &name, bool pendingFlag = true);

    void loadImage(const CString &name, bool pendingFlag = true);

    void incTransitions();

    void decTransitions();

    void lockMouse();

    void unlockMouse();

    void hideMouse();

    void showMouse();

    void disableMouse();

    void enableMouse();

    void mouseDisableControl();

    void mouseEnableControl();

    void mouseSetPosition(const Point &pt, double rate);

    void lockInputHandler();

    void unlockInputHandler();

    void loadSound(const CString &name);

    int playSound(const CString &name, uint volume = 100, int balance = 0, bool repeated = false);

    int playSound(const CString &name, CProximity &prox);

    int queueSound(const CString &name, uint priorHandle, uint volume = 100, int balance = 0,
        bool repeated = false, Audio::Mixer::SoundType soundType = Audio::Mixer::kPlainSoundType);

    void stopSound(int handle, uint seconds = 0);

    bool isSoundActive(int handle) const;

    void setSoundVolume(int handle, uint percent, uint seconds);

    void playAmbientSound(const CString &resName, VolumeMode mode, bool initialMute, bool repeated,
        int handleIndex, Audio::Mixer::SoundType soundType = Audio::Mixer::kMusicSoundType);

    void stopAmbientSound(bool transition, int handleIndex);

    void setAmbientSoundVolume(VolumeMode mode, uint seconds, int handleIndex);

    void stopSoundChannel(bool channel3);

    int addTimer(int endVal, uint firstDuration, uint repeatDuration);

    int addTimer(uint firstDuration, uint repeatDuration = 0);

    void stopTimer(int id);

    int startAnimTimer(const CString &action, uint firstDuration, uint repeatDuration = 0);

    void stopAnimTimer(int id);

    void sleep(uint milli);

    Point getMousePos() const;

    /*
     * Compares the current view's name in a Room.Node.View tuplet
     * string form to the passed string
     */
    bool compareViewNameTo(const CString &name) const;

    bool compareRoomNameTo(const CString &name);

    CGameObject *getMailManFirstObject() const;

    CGameObject *getMailManNextObject(CGameObject *prior) const;

    CGameObject *findMailByFlags(RoomFlagsComparison compareType, uint roomFlags);

    CGameObject *getNextMail(CGameObject *prior);

    CGameObject *findRoomObject(const CString &name) const;

    CGameObject *findInRoom(const CString &name);

    void moveToView();

    void moveToView(const CString &name);

    bool changeView(const CString &viewName, const CString &clipName);

    bool changeView(const CString &viewName);

    void playClip(const CString &name, uint flags = 0);

    void playClip(uint startFrame, uint endFrame);

    bool playCutscene(uint startFrame, uint endFrame);

    void playRandomClip(const char *const *names, uint flags = 0);

    CString getViewFullName() const;

    bool clipExistsByStart(const CString &name, int startFrame = 0) const;

    bool clipExistsByEnd(const CString &name, int endFrame = 0) const;

    void petClear() const;

    CMailMan *getMailMan() const;

    CDontSaveFileItem *getDontSave() const;

    CTreeItem *getDontSaveChild(ClassDef *classDef) const;

    CRoomItem *getHiddenRoom() const;

    CRoomItem *locateRoom(const CString &name) const;

    CTreeItem *findUnder(CTreeItem *parent, const CString &name) const;

    CRoomItem *findRoomByName(const CString &name);

    CMusicRoom *getMusicRoom() const;

    void setPassengerClass(PassengerClass newClass);

    void setToggleColor(byte r, byte g, byte b);

    int getClipDuration(const CString &name, int frameRate = 14) const;

    uint32 getTicksCount();

    Common::SeekableReadStream *getResource(const CString &name);

    bool mailExists(uint roomFlags) const;

    CGameObject *findMail(uint roomFlags) const;

    void resetMail();

    void petLockInput();

    void petUnlockInput();

    void quitGame();

    void setMovieFrameRate(double rate);

    int getRandomNumber(int max, int *oldVal = nullptr);

    bool isBotDisallowedLocation();
public:
    Rect _bounds;
    bool _isPendingMail;
    uint _destRoomFlags;
    uint _roomFlags;
    bool _handleMouseFlag;
    CursorId _cursorId;
    bool _visible;
public:
    static void init();

    static void deinit();
public:
    CLASSDEF;
    CGameObject();
    ~CGameObject() override;

    void save(SimpleFile *file, int indent) override;

    void load(SimpleFile *file) override;

    const CMovieClipList *getMovieClips() const override { return &_movieClips; }

    void draw(CScreenManager *screenManager) override;

    Rect getBounds() const override;

    void freeSurface() override;

    void draw(CScreenManager *screenManager, const Rect &destRect, const Rect &srcRect);

    void draw(CScreenManager *screenManager, const Point &destPos);

    void draw(CScreenManager *screenManager, const Point &destPos, const Rect &srcRect);

    virtual bool isPet() const;

    bool checkPoint(const Point &pt, bool ignoreSurface = false, bool visibleOnly = false);

    bool findPoint(Quadrant quadrant, Point &pt);

    void setPosition(const Point &newPos);

    Point getControid() const;

    void playMovie(uint flags);

    void playMovie(int startFrame, int endFrame, uint flags);

    void playMovie(int startFrame, int endFrame, int initialFrame, uint flags);

    bool hasActiveMovie() const;

    void stopMovie();

    void movieSetPlaying(bool flag);

    int getMovieFrame() const;

    int getFrameNumber() const { return _frameNumber; }

    void loadFrame(int frameNumber);

    void loadSurface();

    void makeDirty();

    void makeDirty(const Rect &r);

    void setVisible(bool val);

    PassengerClass getPassengerClass() const;

    PassengerClass getPriorClass() const;

    void setMailDest(uint roomFlags);

    bool surfaceHasFrame() const;

    Found find(const CString &name, CGameObject **item, int findAreas);

    CGameObject *getHiddenObject(const CString &name) const;

    void dragMove(const Point &pt);

    CGameObject *getDraggingObject() const;

    static bool compareRoomFlags(RoomFlagsComparison compareType, uint flags1, uint flags2);

    /*--- Text display methods ---*/

    void createCredits();

    void setText(const CString &str, int border = 0, int borderRight = 0);

    void setTextHasBorders(bool hasBorders);

    void setTextBounds();

    void setTextColor(byte r, byte g, byte b);

    void setTextFontNumber(int fontNumber);

    int getTextWidth() const;

    void scrollTextUp();

    void scrollTextDown();

    CTextCursor *getTextCursor() const;

    Movement getMovement() const;

    /*--- CGameManager Methods ---*/

    CRoomItem *getRoom() const;

    CNodeItem *getNode() const;

    CViewItem *getView() const;

    CString getRoomName() const;

    CString getRoomNodeName() const;

    void addMail(uint destRoomFlags);

    void sendMail(uint currRoomFlags, uint newRoomFlags);

    CString getFullViewName();

    /*--- CPetControl Methods ---*/

    CPetControl *getPetControl() const;

    void petAddToCarryParcel(CGameObject *obj);

    void petAddToInventory();

    CTreeItem *petContainerRemove(CGameObject *obj);

    bool petCheckNode(const CString &name);

    bool petDismissBot(const CString &name);

    bool petDoorOrBellbotPresent() const;

    void petDisplayMessage(int unused, StringId stringId);

    void petDisplayMessage(int unused, const CString &str);

    void petDisplayMessage(StringId stringId, int param = 0);

    void petDisplayMessage(const CString &str, int param = 0);

    int petGetRoomsWellEntry() const;

    void petHide();

    void petHideCursor();

    void petHighlightGlyph(int id);

    void petInvChange();

    void petMoveToHiddenRoom();

    void petReassignRoom(PassengerClass passClassNum);

    void petSetArea(PetArea newArea) const;

    void petSetRemoteTarget();

    void petSetRoomsWellEntry(int entryNum);

    void petSetRoomsElevatorBroken(bool flag);

    void petShow();

    void petIncAreaLocks();

    void petDecAreaLocks();

    void petShowCursor();

    void petOnSummonBot(const CString &name, int val);

    /*--- CStarControl Methods ---*/

    CStarControl *getStarControl() const;

    void starFn(StarControlAction action);

    bool starIsSolved() const;

    /*--- CTrueTalkManager Methods ---*/

    void startTalking(CTrueTalkNPC *npc, uint id, CViewItem *view = nullptr);

    void startTalking(const CString &name, uint id, CViewItem *view = nullptr);

    void setTalking(CTrueTalkNPC *npc, bool viewFlag, CViewItem *view = nullptr);


    void talkSetDialRegion(const CString &name, int dialNum, int regionNum);

    int talkGetDialRegion(const CString &name, int dialNum);

    /*--- CVideoSurface Methods ---*/

    void movieEvent(int frameNumber);

    void movieEvent();

    /*--- CGameState Methods ---*/

    void stateSetSoundMakerAllowed(bool flag);

    void stateChangeSeason();

    Season stateGetSeason() const;

    void stateSetParrotMet();

    bool stateGetParrotMet() const;

    void incParrotResponse();

    int getParrotResponse() const;

    uint getNodeChangedCtr() const;

    uint getNodeEnterTicks() const;
};

} // End of namespace Titanic

#endif /* TITANIC_GAME_OBJECT_H */