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 #include <simgear/scene/model/placementtrans.hxx>
  57
  58 #include <Main/globals.hxx>
  59 #include <Scenery/scenery.hxx>
  60
  61
  62 // These constants are provided so that the ident command can list file versions.
  63 const char sMPPLAYER_BID[] = "$Id$";
  64 const char sMPPLAYER_HID[] = MPPLAYER_HID;
  65
  66
  67 /******************************************************************
  68 * Name: MPPlayer
  69 * Description: Constructor.
  70 ******************************************************************/
  71 MPPlayer::MPPlayer() {
  72
  73     // Initialise private members
  74     m_bInitialised = false;
  75     m_LastUpdate = 0;
  76     m_PlayerAddress.set("localhost", 0);
  77     m_sCallsign = "none";
  78
  79
  80 }
  81
  82
  83 /******************************************************************
  84 * Name: ~MPPlayer
  85 * Description: Destructor.
  86 ******************************************************************/
  87 MPPlayer::~MPPlayer() {
  88
  89     Close();
  90
  91 }
  92
  93
  94 /******************************************************************
  95 * Name: Open
  96 * Description: Initialises class.
  97 ******************************************************************/
  98 bool MPPlayer::Open(const string &sAddress, const int &iPort, const string &sCallsign, const string &sModelName, bool bLocalPlayer) {
  99
 100     bool bSuccess = true;
 101
 102     if (!m_bInitialised) {
 103
 104         m_PlayerAddress.set(sAddress.c_str(), iPort);
 105         m_sCallsign = sCallsign;
 106         m_sModelName = sModelName;
 107         m_bLocalPlayer = bLocalPlayer;
 108
 109         // If the player is remote then load the model
 110         if (!bLocalPlayer) {
 111              try {
 112                  LoadModel();
 113              } catch (...) {
 114                  SG_LOG( SG_NETWORK, SG_ALERT, "Failed to load remote model '" << sModelName << "'." );
 115                  return false;
 116              }
 117         }
 118
 119         m_bInitialised = bSuccess;
 120
 121     } else {
 122         SG_LOG( SG_NETWORK, SG_ALERT, "MPPlayer::Open - Attempt to open an already open player connection." );
 123         bSuccess = false;
 124     }
 125
 126
 127     /* Return true if open succeeds */
 128     return bSuccess;
 129
 130 }
 131
 132
 133 /******************************************************************
 134 * Name: Close
 135 * Description: Resets the object.
 136 ******************************************************************/
 137 void MPPlayer::Close(void) {
 138
 139     // Remove the model from the game
 140     if (m_bInitialised && !m_bLocalPlayer) {
 141
 142         // Disconnect the model from the transform, then the transform from the scene.
 143         m_ModelTrans->removeKid(m_Model);
 144         globals->get_scenery()->unregister_placement_transform(m_ModelTrans);
 145         globals->get_scenery()->get_aircraft_branch()->removeKid( m_ModelTrans);
 146
 147         // Flush the model loader so that it erases the model from its list of
 148         // models.
 149         globals->get_model_lib()->flush1();
 150
 151         // Assume that plib/ssg deletes the model and transform as their
 152         // refcounts should be zero.
 153
 154     }
 155
 156     m_bInitialised = false;
 157     m_bUpdated = false;
 158     m_LastUpdate = 0;
 159     m_sCallsign = "none";
 160
 161 }
 162
 163
 164 /******************************************************************
 165 * Name: SetPosition
 166 * Description: Updates position data held for this player and resets
 167 * the last update time.
 168 ******************************************************************/
 169 void MPPlayer::SetPosition(const sgQuat PlayerOrientation,
 170                            const sgdVec3 PlayerPosition) {
 171
 172
 173     // Save the position matrix and update time
 174     if (m_bInitialised) {
 175         sgdCopyVec3(m_ModelPosition, PlayerPosition);
 176         sgCopyVec4(m_ModelOrientation, PlayerOrientation);
 177         time(&m_LastUpdate);
 178         m_bUpdated = true;
 179     }
 180
 181
 182 }
 183
 184
 185 /******************************************************************
 186 * Name: Draw
 187 * Description: Updates the position for the player's model
 188 * The state of the player's data is returned.
 189 ******************************************************************/
 190 MPPlayer::TPlayerDataState MPPlayer::Draw(void) {
 191
 192     MPPlayer::TPlayerDataState eResult = PLAYER_DATA_NOT_AVAILABLE;
 193
 194     if (m_bInitialised && !m_bLocalPlayer) {
 195         if ((time(NULL) - m_LastUpdate < TIME_TO_LIVE)) {
 196             // Peform an update if it has changed since the last update
 197             if (m_bUpdated) {
 198
 199                 // Transform and update player model
 200                 sgMat4 orMat;
 201                 sgMakeIdentMat4(orMat);
 202                 sgQuatToMatrix(orMat, m_ModelOrientation);
 203                 m_ModelTrans->setTransform(m_ModelPosition, orMat);
 204
 205                 eResult = PLAYER_DATA_AVAILABLE;
 206
 207                 // Clear the updated flag so that the position data
 208                 // is only available if it has changed
 209                 m_bUpdated = false;
 210             }
 211
 212         // Data has not been updated for some time.
 213         } else {
 214             eResult = PLAYER_DATA_EXPIRED;
 215         }
 216
 217     }
 218
 219     return eResult;
 220
 221 }
 222
 223
 224 /******************************************************************
 225 * Name: Callsign
 226 * Description: Returns the player's callsign.
 227 ******************************************************************/
 228 string MPPlayer::Callsign(void) const {
 229
 230     return m_sCallsign;
 231
 232 }
 233
 234
 235 /******************************************************************
 236 * Name: CompareCallsign
 237 * Description: Returns true if the player's callsign matches
 238 * the given callsign.
 239 ******************************************************************/
 240 bool MPPlayer::CompareCallsign(const char *sCallsign) const {
 241
 242     return (m_sCallsign == sCallsign);
 243
 244 }
 245
 246
 247 /******************************************************************
 248 * Name: LoadModel
 249 * Description: Loads the player's aircraft model.
 250 ******************************************************************/
 251 void MPPlayer::LoadModel(void) {
 252
 253
 254     m_ModelTrans = new ssgPlacementTransform;
 255
 256     // Load the model
 257     m_Model = globals->get_model_lib()->load_model( globals->get_fg_root(),
 258                                                     m_sModelName,
 259                                                     globals->get_props(),
 260                                                     globals->get_sim_time_sec() );
 261     m_Model->clrTraversalMaskBits( SSGTRAV_HOT );
 262
 263     // Add model to transform
 264     m_ModelTrans->addKid( m_Model );
 265
 266     // Optimise model and transform
 267     ssgFlatten( m_Model );
 268     ssgStripify( m_ModelTrans );
 269
 270     // Place on scene under aircraft branch
 271     globals->get_scenery()->get_aircraft_branch()->addKid( m_ModelTrans );
 272     globals->get_scenery()->register_placement_transform( m_ModelTrans);
 273
 274
 275 }
 276
 277
 278 /******************************************************************
 279 * Name: FillPosMsg
 280 * Description: Populates the header and data for a position message.
 281 ******************************************************************/
 282 void MPPlayer::FillPosMsg(T_MsgHdr *MsgHdr, T_PositionMsg *PosMsg) {
 283
 284     FillMsgHdr(MsgHdr, POS_DATA_ID);
 285
 286     strncpy(PosMsg->sModel, m_sModelName.c_str(), MAX_MODEL_NAME_LEN);
 287     PosMsg->sModel[MAX_MODEL_NAME_LEN - 1] = '\0';
 288     sgdCopyVec3(PosMsg->PlayerPosition, m_ModelPosition);
 289     sgCopyQuat(PosMsg->PlayerOrientation, m_ModelOrientation);
 290
 291
 292 }
 293
 294
 295 /******************************************************************
 296 * Name: FillMsgHdr
 297 * Description: Populates the header of a multiplayer message.
 298 ******************************************************************/
 299 void MPPlayer::FillMsgHdr(T_MsgHdr *MsgHdr, const int iMsgId) {
 300
 301     struct in_addr address;
 302
 303     MsgHdr->MsgId = iMsgId;
 304
 305     switch (iMsgId) {
 306         case CHAT_MSG_ID:
 307             MsgHdr->iMsgLen = sizeof(T_MsgHdr) + sizeof(T_ChatMsg);
 308             break;
 309         case POS_DATA_ID:
 310             MsgHdr->iMsgLen = sizeof(T_MsgHdr) + sizeof(T_PositionMsg);
 311             break;
 312         default:
 313             MsgHdr->iMsgLen = sizeof(T_MsgHdr);
 314             break;
 315     }
 316
 317     address.s_addr = inet_addr( m_PlayerAddress.getHost() );
 318     MsgHdr->lReplyAddress = address.s_addr;
 319
 320     MsgHdr->iReplyPort = m_PlayerAddress.getPort();
 321
 322     strncpy(MsgHdr->sCallsign, m_sCallsign.c_str(), MAX_CALLSIGN_LEN);
 323     MsgHdr->sCallsign[MAX_CALLSIGN_LEN - 1] = '\0';
 324
 325
 326 }
 327
 328 #endif // FG_MPLAYER_AS
 329