aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/pet_control/pet_element.h
blob: bbf3e835375f611914aa81474785e2597c01896c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/* 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef TITANIC_PET_ELEMENT_H
#define TITANIC_PET_ELEMENT_H

#include "titanic/support/simple_file.h"
#include "titanic/support/string.h"
#include "titanic/core/link_item.h"
#include "titanic/messages/mouse_messages.h"

namespace Titanic {

enum PetElementMode { MODE_UNSELECTED = 0, MODE_SELECTED = 1, MODE_FOCUSED = 2 };

class CGameObject;
class CPetControl;

class CPetElement {
protected:
	Rect _bounds;
	PetElementMode _mode;
public:
	CPetElement();
	virtual ~CPetElement() {}

	/**
	 * Sets up the element
	 */
	virtual void setup(PetElementMode mode, const CString &name,
		CPetControl *petControl) {}

	/**
	 * Reset the element
	 */
	virtual void reset(const CString &name, CPetControl *petControl, PetElementMode mode) {}

	/**
	 * Draw the item
	 */
	virtual void draw(CScreenManager *screenManager) {}

	/**
	 * Draw the item
	 */
	virtual void draw(CScreenManager *screenManager, const Point &destPos) {}

	/**
	 * Get the bounds for the element
	 */
	virtual Rect getBounds() const;

	/**
	 * Handles processing mouse button down messages
	 */
	virtual bool MouseButtonDownMsg(const Point &pt);

	/**
	 * Handles processing mouse button up messages
	 */
	virtual bool MouseButtonUpMsg(const Point &pt);

	/**
	 * Handles processing mouse button double click messages
	 */
	virtual bool MouseDoubleClickMsg(const Point &pt) const;

	/**
	 * Handles processing mouse move messages
	 */
	virtual bool MouseMoveMsg(const Point &pt);

	/**
	 * Returns whether the passed point falls inside the item
	 */
	virtual bool contains2(const Point &pt) const;

	/**
	 * Plays back a range of frames in the loaded video file for the element
	 */
	virtual void playMovie(uint startFrame, uint endFrame) const;

	/**
	 * Change the status of the associated object
	 */
	virtual void changeStatus(int newStatus) const;

	/**
	 * Returns true if the object associated with the item has an active movie
	 */
	virtual bool hasActiveMovie() const;

	/**
	 * Loads a frame
	 */
	virtual void loadFrame(int frameNumber);

	/**
	 * Get the current frame
	 */
	virtual int getMovieFrame() const;

	/**
	 * Get the game object associated with this item
	 */
	virtual CGameObject *getObject() const { return nullptr; }

	virtual void changeMode(PetElementMode newMode) { _mode = newMode; }

	void setMode(PetElementMode mode);

	/**
	 * Set whether the element is selected
	 */
	void setSelected(bool flag);

	/**
	 * Set the bounds for the element
	 */
	void setBounds(const Rect &r) { _bounds = r; }

	/**
	 * Translate the position of the element
	 */
	void translate(int deltaX, int deltaY) { _bounds.translate(deltaX, deltaY); }

	/**
	 * Translate the position of the element
	 */
	void translate(const Point &delta) { _bounds.translate(delta.x, delta.y); }
};

} // End of namespace Titanic

#endif /* TITANIC_PET_ELEMENT_H */