1 // mpplayer.hxx -- routines for a player within a multiplayer Flightgear
3 // Written by Duncan McCreanor, started February 2003.
4 // duncan.mccreanor@airservicesaustralia.com
6 // Copyright (C) 2003 Airservices Australia
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.
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.
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.
27 #define MPPLAYER_HID "$Id$"
29 /****************************************************************
32 * Description: This class holds information about a player in a
33 * multiplayer game. The model for a remote player is loaded and
34 * added onto the aircraft branch of the scene on calling Open.
35 * The model is unloaded from the scene when Close is called
36 * or the object is deleted. The model's positioning transform is
37 * updated by calling SetPosition. The updated position transform
38 * is applied to the model on the scene by calling Draw.
40 ******************************************************************/
42 #include "mpmessages.hxx"
46 #include <plib/netSocket.h>
47 #include <simgear/io/sg_socket_udp.hxx>
53 // Number of seconds before a player is consider to be lost
54 #define TIME_TO_LIVE 10
66 /** Enumeration of the states for the player's data */
67 enum PlayerDataState {PLAYER_DATA_NOT_AVAILABLE = 0, PLAYER_DATA_AVAILABLE, PLAYER_DATA_EXPIRED};
69 /** Player data state */
70 typedef enum PlayerDataState TPlayerDataState;
72 /** Initialises the class.
73 * @param sIP IP address or host name for sending data to the player
74 * @param sPort Port number for sending data to the player
75 * @param sCallsign Callsign of the player (must be unique across all instances of MPPlayer).
76 * @param sModelName Path and name of the aircraft model file for the player
77 * @param bLocalPlayer True if this player is the local player, else false
78 * @return True if class opens successfully, else false
80 bool Open(const string &sIP, const int &iPort, const string &sCallsign,
81 const string &sModelName, const bool bLocalPlayer);
83 /** Closes the player connection */
86 /** Sets the positioning matrix held for this player
87 * @param PlayerPosMat4 Matrix for positioning player's aircraft
89 void SetPosition(const sgMat4 PlayerPosMat4);
91 /** Transform and place model for player
93 TPlayerDataState Draw(void);
95 /** Returns the callsign for the player
96 * @return Aircraft's callsign
98 string Callsign(void) const;
100 /** Compares the player's callsign with the given callsign
101 * @param sCallsign Callsign to compare
102 * @return True if callsign matches
104 bool CompareCallsign(const char *sCallsign) const;
106 /** Populates a position message for the player
107 * @param MsgHdr Header to be populated
108 * @param PosMsg Position message to be populated
110 void FillPosMsg(T_MsgHdr *MsgHdr, T_PositionMsg *PosMsg);
112 /** Populates a mesage header with information for the player
113 * @param MsgHdr Header to be populated
114 * @param iMsgId Message type identifier to insert into header
116 void FillMsgHdr(T_MsgHdr *MsgHdr, const int iMsgId);
121 /** Loads the model of the aircraft */
122 void LoadModel(void);
124 /** True if object is initialised */
127 /** Position matrix for the player's aircraft */
130 /** Used to remove player if no activity */
133 /** Set when the player data is updated and cleared when read */
136 /** Player's callsign */
139 /** Aircraft model name for player */
142 /** The player's loaded model */
145 /** Model transform */
146 ssgTransform *m_ModelTrans;
148 /** True if this player is the local player */
151 /** Address information for the player */
152 netAddress m_PlayerAddress;