ryzom/client/src/player_r2_cl.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef CL_PLAYER_R2_CL_H
  20 #define CL_PLAYER_R2_CL_H
  21
  22
  23 /////////////
  24 // INCLUDE //
  25 /////////////
  26 // Misc.
  27 #include "nel/misc/types_nl.h"
  28 // 3d
  29 #include "nel/3d/u_point_light.h"
  30 // Client.
  31 #include "character_cl.h"
  32 // Client Sheets
  33 #include "client_sheets/race_stats_sheet.h"
  34 // Game Share
  35 #include "game_share/people.h"
  36
  37
  38 ///////////
  39 // CLASS //
  40 ///////////
  41 class CPlayerSheet;
  42
  43 /**
  44  * Class to manage a R2 player.
  45  * \author Typhaine Le Gallo
  46  * \author Nevrax France
  47  * \date 2005
  48  */
  49 class CPlayerR2CL : public CCharacterCL
  50 {
  51 public:
  52         NLMISC_DECLARE_CLASS(CPlayerR2CL);
  53
  54         /// Constructor
  55         CPlayerR2CL();
  56         /// Destructor
  57         virtual ~CPlayerR2CL();
  58
  59         /// Build the entity from a sheet.
  60         virtual bool build(const CEntitySheet *sheet);
  61
  62         /// Method to return the attack radius of an entity
  63         virtual double attackRadius() const;
  64         /** Return the position the attacker should have to combat according to the attack angle.
  65          * \param ang : 0 = the front, >0 and <Pi = left side, <0 and >-Pi = right side.
  66          */
  67         virtual NLMISC::CVectorD getAttackerPos(double ang, double dist) const;
  68
  69         /** \name DEBUG
  70          * Methods only here for the debug.
  71          */
  72         //@{
  73         /// Display Debug Information.
  74         virtual void displayDebug(float x, float &y, float lineStep);
  75         //@}
  76
  77         /// Return the People for the entity.
  78         //virtual EGSPD::CPeople::TPeople people() const;
  79         //virtual void setPeople(EGSPD::CPeople::TPeople people);
  80
  81         /// Return a pointer on the sheet used to create this player.
  82         //const CRaceStatsSheet *playerSheet() const {return _PlayerSheet;}
  83
  84         /// Return the entity scale. (return 1.0 if there is any problem).
  85         virtual float getScale() const;
  86         // return vector of ground fxs sorted by ground type, or NULL is ground fxs are not supported for the entity
  87         //virtual const std::vector<CGroundFXSheet> *getGroundFX() const;
  88         virtual bool supportGroundFX() const { return true; }
  89
  90         /// Return true if this player is in the same faction as the user's (except if neutral)
  91         bool isFromSameNonNeutralPvpClanAsUser() const;
  92
  93         // From CEntityCL
  94         //const char *getBoneNameFromBodyPart(BODY::TBodyPart part, BODY::TSide side) const;
  95
  96         // retrieve right hand item sheet
  97         virtual const CItemSheet *getRightHandItemSheet() const;
  98         virtual const CItemSheet *getLeftHandItemSheet() const;
  99
 100         //virtual const CAttack *getAttack(const CAttackIDSheet &id) const;
 101
 102         virtual float getScaleRef() const;
 103
 104         // from CEntityCL
 105         void makeTransparent(bool t);
 106         virtual void setDiffuse(bool onOff, NLMISC::CRGBA diffuse);
 107
 108 protected:
 109         /// Pointer on the Sheet with basic parameters.
 110         //const CPlayerSheet            *_Sheet;
 111         /// Pointer on the Sheet with basic parameters.
 112         //const CRaceStatsSheet *_PlayerSheet;
 113         /// Player Face
 114         SInstanceCL                             _Face;
 115         /// Default Look
 116         std::string                             _DefaultChest;
 117         std::string                             _DefaultLegs;
 118         std::string                             _DefaultArms;
 119         std::string                             _DefaultHands;
 120         std::string                             _DefaultFeet;
 121         std::string                             _DefaultHair;
 122         sint32                                  _HairColor;
 123         sint32                                  _EyesColor;
 124         /// 'true' while the entity is not ready to be displayed.
 125         bool                                    _WaitForAppearance;
 126         // AsyncTexturing: true if all instances are not loaded.
 127         bool                                    _PlayerCLAsyncTextureLoading;
 128         // Is the light On or Off.
 129         bool                                    _LightOn;
 130         // Light
 131         NL3D::UPointLight               _Light;
 132
 133         std::string _CacheSkeletonShapeName;
 134
 135 protected:
 136         // Return the automaton type of the entity (homin, creature, etc.)
 137         //virtual std::string automatonType() const;
 138
 139         // Initialize the graphic for the player.
 140         void init3d();
 141
 142         /// Initialize properties of the entity (according to the class).
 143         virtual void initProperties();
 144
 145         /// Set the equipmenent worn.
 146         void equip(SLOTTYPE::EVisualSlot slot, const std::string &shapeName, const CItemSheet *item = 0);
 147         /// Compute the equipmenent worn.
 148         void equip(SLOTTYPE::EVisualSlot slot, uint index, uint color);
 149
 150         /// Update the Visual Property A
 151         virtual void updateVisualPropertyVpa(const NLMISC::TGameCycle &gameCycle, const sint64 &prop);
 152         /// Update the Visual Property B
 153         virtual void updateVisualPropertyVpb(const NLMISC::TGameCycle &gameCycle, const sint64 &prop);
 154         /// Update the Visual Property C
 155         virtual void updateVisualPropertyVpc(const NLMISC::TGameCycle &gameCycle, const sint64 &prop);
 156         // Get The Entity Skin
 157         //virtual sint skin() const;
 158
 159         /// Update blink
 160         virtual SInstanceCL *getFace ();
 161
 162         // Draw the name.
 163         virtual void drawName(const NLMISC::CMatrix &mat);
 164
 165         /** \name 3D System
 166          * Methods to manage basics 3D systems
 167          */
 168         //@{
 169         /** update the display of the AsyncTexture of the entity. called in updateDisplay()
 170          *      Deriver: See CPlayerCL implementation
 171          *      \return distance from entity to camera computed (helper for deriver)
 172          */
 173         virtual float           updateAsyncTexture();
 174
 175         /// Update the Lod Texture When needed
 176         virtual void            updateLodTexture();
 177         //@}
 178         /// Return the basic max speed for the entity in meter per sec
 179         virtual double getMaxSpeed() const;
 180
 181         // Read/Write Variables from/to the stream.
 182         virtual void readWrite(NLMISC::IStream &f);
 183         // To call after a read from a stream to re-initialize the entity.
 184         virtual void load();
 185
 186         /// Return name position on Z axis defined in sheet
 187         //virtual float getNamePosZ() const;
 188
 189         // virtual for special PlayerCL _Face mgt
 190         virtual void doSetVisualSelectionBlink(bool bOnOff, NLMISC::CRGBA emitColor);
 191
 192         CGenderInfo * getGenderInfo();
 193
 194 };
 195
 196
 197 #endif // CL_PLAYER_R2_CL_H
 198
 199 /* End of player_r2_cl.h */