aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/star_control/viewport.h
blob: ae42e84ea45cb755b8049673eae46ea57123c2e8 (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
155
156
157
158
159
160
161
162
163
164
165
/* 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_VIEWPORT_H
#define TITANIC_VIEWPORT_H

#include "titanic/star_control/base_stars.h" // Includes StarMode enum
#include "titanic/star_control/fpose.h" // Includes FMatrix and FVector

class SimpleFile;

namespace Titanic {

/**
 * The color of the stars when drawn (CBaseStars::draw)
 * For starview it should be white
 * For skyview it should be pink
 */
enum StarColor { WHITE = 0, PINK = 2 };

/**
 * Implements the viewport functionality for viewing the star field in
 * a given position and orientation.
 * CStarCamera is a big user of this class
 */
class CViewport {
private:
	double _fieldC;
	double _centerYAngleDegrees;
	double _centerZAngleDegrees;
	int _width;
	int _height;
	FMatrix _orientation;
	FPose _currentPose;
	FPose _rawPose;
	FPoint _center;
	bool _poseUpToDate;
private:
	void reset();
public:
	FVector _position;
	double _field10;
	double _field14;
	StarColor _starColor;	// Used in CBaseStars::draw
	double _valArray[2];	// has value 0.0 or 30.0
	double _isZero;
	double _pixel1OffSetX;	// Used in CBaseStars::draw3 and CBaseStars::draw4 has value 0.0 or 28000.0
	double _pixel2OffSetX;	// Used in CBaseStars::draw3 and CBaseStars::draw4 has value 0.0 or -28000.0
	FVector _centerVector;
public:
	CViewport();
	CViewport(CViewport *src);

	/**
	 * Copys the data from another instance
	 */
	void copyFrom(const CViewport *src);

	/**
	 * Load the data for the class from file
	 */
	void load(SimpleFile *file, int param);

	/**
	 * Save the data for the class to file
	 */
	void save(SimpleFile *file, int indent);

	/**
	 * Sets the position
	 */
	void setPosition(const FVector &v);

	/**
	 * Sets the position
	 */
	void setPosition(const FPose &pose);

	/**
	 * Sets the orientation from a passed matrix
	 */
	void setOrientation(const FMatrix &m);

	/**
	 * Sets the orientation from a passed vector
	 */
	void setOrientation(const FVector &v);

	void randomizeOrientation();

	/**
	 * The view has changed between starview and skyview
	 * Change the enum that tracks the color of the stars
	 * Also change the X coordinate pixel offset used for star drawing
	 */
	void changeStarColorPixel(StarMode mode, double pixelOffSet);
	void reposition(double factor);

	/**
	 * Applys a rotation matrix to the current
	 * orientation
	 */
	void changeOrientation(const FMatrix &matrix);

	FPose getPose();
	FPose getRawPose();
	FVector getRelativePosNoCentering(int index, const FVector &src);
	FVector getRelativePosCentering(int index, const FVector &src);
	FVector getRelativePosCenteringRaw(int index, const FVector &src);

	/**
	 * All arguments are return values
	 * First is the x center coordinate relative to y
	 * Second is the x center coordinate relative to z
	 * Third is the first x center pixel offset
	 * Fourth is the second x center pixel offset
	 */
	void getRelativeXCenterPixels(double *v1, double *v2, double *v3, double *v4);

	/**
	 * Returns the viewport's orientation
	 */
	const FMatrix &getOrientation() const;

	void setC(double v);
	void set10(double v);
	void set14(double v);

	/**
	 * Sets the center vector y angle
	 * The actual center y value doesn't
	 * change untill reset is called
	 */
	void setCenterYAngle(double angleDegrees);

	/**
	 * Sets the center vector z angle
	 * The actual center z value doesn't
	 * change untill reset is called
	 */
	void setCenterZAngle(double angleDegrees);
};

} // End of namespace Titanic

#endif /* TITANIC_VIEWPORT_H */