]> git.mxchange.org Git - flightgear.git/blob - src/MultiPlayer/mpplayer.cxx
Melchior FRANZ:
[flightgear.git] / src / MultiPlayer / mpplayer.cxx
1 // mpplayer.cxx -- routines for a player within a multiplayer Flightgear
2 //
3 // Written by Duncan McCreanor, started February 2003.
4 // duncan.mccreanor@airservicesaustralia.com
5 //
6 // Copyright (C) 2003  Airservices Australia
7 //
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 // General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 //
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #ifdef FG_MPLAYER_AS
28
29 /******************************************************************
30 * $Id$
31 *
32 * Description: Provides a container for a player in a multiplayer
33 * game. The players network address, model, callsign and positoin
34 * are held. When the player is created and open called, the player's
35 * model is loaded onto the scene. The position transform matrix
36 * is updated by calling SetPosition. When Draw is called the
37 * elapsed time since the last update is checked. If the model
38 * position information has been updated in the last TIME_TO_LIVE
39 * seconds then the model position is updated on the scene.
40 *
41 ******************************************************************/
42
43 #include "mpplayer.hxx"
44
45 #include <stdlib.h>
46 #if !(defined(_MSC_VER) || defined(__MINGW32__))
47 # include <netdb.h>
48 # include <sys/socket.h>
49 # include <netinet/in.h>
50 # include <arpa/inet.h>
51 #endif
52 #include <plib/netSocket.h>
53 #include <plib/sg.h>
54
55 #include <simgear/scene/model/modellib.hxx>
56
57 #include <Main/globals.hxx>
58 #include <Scenery/scenery.hxx>
59
60
61 // These constants are provided so that the ident command can list file versions.
62 const char sMPPLAYER_BID[] = "$Id$";
63 const char sMPPLAYER_HID[] = MPPLAYER_HID;
64
65
66 /******************************************************************
67 * Name: MPPlayer
68 * Description: Constructor.
69 ******************************************************************/
70 MPPlayer::MPPlayer() {
71
72     // Initialise private members
73     m_bInitialised = false;
74     m_LastUpdate = 0;
75     m_PlayerAddress.set("localhost", 0);
76     m_sCallsign = "none";
77
78
79 }
80
81
82 /******************************************************************
83 * Name: ~MPPlayer
84 * Description: Destructor.
85 ******************************************************************/
86 MPPlayer::~MPPlayer() {
87
88     Close();
89
90 }
91
92
93 /******************************************************************
94 * Name: Open
95 * Description: Initialises class.
96 ******************************************************************/
97 bool MPPlayer::Open(const string &sAddress, const int &iPort, const string &sCallsign, const string &sModelName, bool bLocalPlayer) {
98
99     bool bSuccess = true;
100
101     if (!m_bInitialised) {
102
103         m_PlayerAddress.set(sAddress.c_str(), iPort);
104         m_sCallsign = sCallsign;
105         m_sModelName = sModelName;
106         m_bLocalPlayer = bLocalPlayer;
107
108         // If the player is remote then load the model
109         if (!bLocalPlayer) {
110
111              LoadModel();
112
113         }
114
115         m_bInitialised = bSuccess;
116
117     } else {
118         SG_LOG( SG_NETWORK, SG_ALERT, "MPPlayer::Open - Attempt to open an already open player connection." );
119         bSuccess = false;
120     }
121
122
123     /* Return true if open succeeds */
124     return bSuccess;
125
126 }
127
128
129 /******************************************************************
130 * Name: Close
131 * Description: Resets the object.
132 ******************************************************************/
133 void MPPlayer::Close(void) {
134
135     // Remove the model from the game
136     if (m_bInitialised && !m_bLocalPlayer) {
137
138         // Disconnect the model from the transform, then the transform from the scene.
139         m_ModelTrans->removeKid(m_Model);
140         globals->get_scenery()->get_aircraft_branch()->removeKid( m_ModelTrans);
141
142         // Flush the model loader so that it erases the model from its list of
143         // models.
144         globals->get_model_lib()->flush1();
145
146         // Assume that plib/ssg deletes the model and transform as their
147         // refcounts should be zero.
148
149     }
150
151     m_bInitialised = false;
152     m_bUpdated = false;
153     m_LastUpdate = 0;
154     m_sCallsign = "none";
155
156 }
157
158
159 /******************************************************************
160 * Name: SetPosition
161 * Description: Updates position data held for this player and resets
162 * the last update time.
163 ******************************************************************/
164 void MPPlayer::SetPosition(const sgMat4 PlayerPosMat4) {
165
166
167     // Save the position matrix and update time
168     if (m_bInitialised) {
169         sgCopyMat4(m_ModelPos, PlayerPosMat4);
170         time(&m_LastUpdate);
171         m_bUpdated = true;
172     }
173
174
175 }
176
177
178 /******************************************************************
179 * Name: Draw
180 * Description: Updates the position for the player's model
181 * The state of the player's data is returned.
182 ******************************************************************/
183 MPPlayer::TPlayerDataState MPPlayer::Draw(void) {
184
185     MPPlayer::TPlayerDataState eResult = PLAYER_DATA_NOT_AVAILABLE;
186
187     sgCoord sgPlayerCoord;
188
189     if (m_bInitialised && !m_bLocalPlayer) {
190         if ((time(NULL) - m_LastUpdate < TIME_TO_LIVE)) {
191             // Peform an update if it has changed since the last update
192             if (m_bUpdated) {
193
194                 // Transform and update player model
195                 sgSetCoord( &sgPlayerCoord, m_ModelPos);
196                 m_ModelTrans->setTransform( &sgPlayerCoord );
197
198                 eResult = PLAYER_DATA_AVAILABLE;
199
200                 // Clear the updated flag so that the position data
201                 // is only available if it has changed
202                 m_bUpdated = false;
203             }
204
205         // Data has not been updated for some time.
206         } else {
207             eResult = PLAYER_DATA_EXPIRED;
208         }
209
210     }
211
212     return eResult;
213
214 }
215
216
217 /******************************************************************
218 * Name: Callsign
219 * Description: Returns the player's callsign.
220 ******************************************************************/
221 string MPPlayer::Callsign(void) const {
222
223     return m_sCallsign;
224
225 }
226
227
228 /******************************************************************
229 * Name: CompareCallsign
230 * Description: Returns true if the player's callsign matches
231 * the given callsign.
232 ******************************************************************/
233 bool MPPlayer::CompareCallsign(const char *sCallsign) const {
234
235     return (m_sCallsign == sCallsign);
236
237 }
238
239
240 /******************************************************************
241 * Name: LoadModel
242 * Description: Loads the player's aircraft model.
243 ******************************************************************/
244 void MPPlayer::LoadModel(void) {
245
246
247     m_ModelTrans = new ssgTransform;
248
249     // Load the model
250     m_Model = globals->get_model_lib()->load_model( globals->get_fg_root(),
251                                                     m_sModelName,
252                                                     globals->get_props(),
253                                                     globals->get_sim_time_sec() );
254     m_Model->clrTraversalMaskBits( SSGTRAV_HOT );
255
256     // Add model to transform
257     m_ModelTrans->addKid( m_Model );
258
259     // Optimise model and transform
260     ssgFlatten( m_Model );
261     ssgStripify( m_ModelTrans );
262
263     // Place on scene under aircraft branch
264     globals->get_scenery()->get_aircraft_branch()->addKid( m_ModelTrans );
265
266
267 }
268
269
270 /******************************************************************
271 * Name: FillPosMsg
272 * Description: Populates the header and data for a position message.
273 ******************************************************************/
274 void MPPlayer::FillPosMsg(T_MsgHdr *MsgHdr, T_PositionMsg *PosMsg) {
275
276     FillMsgHdr(MsgHdr, POS_DATA_ID);
277
278     strncpy(PosMsg->sModel, m_sModelName.c_str(), MAX_MODEL_NAME_LEN);
279     PosMsg->sModel[MAX_MODEL_NAME_LEN - 1] = '\0';
280     sgCopyMat4(PosMsg->PlayerPos, m_ModelPos);
281
282
283 }
284
285
286 /******************************************************************
287 * Name: FillMsgHdr
288 * Description: Populates the header of a multiplayer message.
289 ******************************************************************/
290 void MPPlayer::FillMsgHdr(T_MsgHdr *MsgHdr, const int iMsgId) {
291
292     struct in_addr address;
293
294     MsgHdr->MsgId = iMsgId;
295
296     switch (iMsgId) {
297         case CHAT_MSG_ID:
298             MsgHdr->iMsgLen = sizeof(T_MsgHdr) + sizeof(T_ChatMsg);
299             break;
300         case POS_DATA_ID:
301             MsgHdr->iMsgLen = sizeof(T_MsgHdr) + sizeof(T_PositionMsg);
302             break;
303         default:
304             MsgHdr->iMsgLen = sizeof(T_MsgHdr);
305             break;
306     }
307
308     address.s_addr = inet_addr( m_PlayerAddress.getHost() );
309     MsgHdr->lReplyAddress = address.s_addr;
310
311     MsgHdr->iReplyPort = m_PlayerAddress.getPort();
312
313     strncpy(MsgHdr->sCallsign, m_sCallsign.c_str(), MAX_CALLSIGN_LEN);
314     MsgHdr->sCallsign[MAX_CALLSIGN_LEN - 1] = '\0';
315
316
317 }
318
319 #endif // FG_MPLAYER_AS
320