ryzom/client/src/interface_v3/character_3d.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21
  22 #ifndef CL_CHARACTER_3D_H
  23 #define CL_CHARACTER_3D_H
  24
  25 // ------------------------------------------------------------------------------------------------
  26 #include "game_share/character_summary.h"
  27 #include "game_share/slot_types.h"
  28 #include "nel/3d/u_skeleton.h"
  29 #include "nel/gui/interface_options.h"
  30 #include "interface_options_ryzom.h"
  31 #include "nel/gui/interface_element.h"
  32
  33
  34 // ------------------------------------------------------------------------------------------------
  35 namespace NL3D
  36 {
  37         class UScene;
  38         class UInstance;
  39         class UAnimationSet;
  40         class USkeleton;
  41         class UPlayList;
  42 };
  43
  44 // ------------------------------------------------------------------------------------------------
  45 enum TChar3DPart
  46 {
  47         Char3DPart_Chest = 0,
  48         Char3DPart_Legs,
  49         Char3DPart_Arms,
  50         Char3DPart_Feet,
  51         Char3DPart_Face,
  52         Char3DPart_Head,
  53         Char3DPart_Hands,
  54         Char3DPart_HandRightItem,
  55         Char3DPart_HandLeftItem,
  56         Char3DPart_INVALID
  57 };
  58
  59 #define NB_CHARACTER3D_PARTS 9
  60 #define NB_MORPH_TARGETS 8
  61
  62 // ------------------------------------------------------------------------------------------------
  63 struct SCharacter3DSetup
  64 {
  65         // A Part of the character body
  66         // if the name, color or quality changed the instances are rebuilt. It is not for all fxs.
  67         struct SCharacterPart
  68         {
  69                 std::string                                     Name;           // name of the .shape
  70                 std::string                                     AdvFx;          // advantage fx .ps
  71                 std::vector<std::string>                StatFxNames;    // all the static fx .ps
  72                 std::vector<std::string>                StatFxBones;    // the bones on which to bind the static fx (weird but done like that in CCharacterCL)
  73                 std::vector<NLMISC::CVector>    StatFxOffss;    // the offset on the bone
  74                 sint32                                          Color;          // a color slot (in the color table of the color slot manager)
  75                 sint32                                          Quality;        // quality of the item
  76         };
  77         // Primary information (if changed instances are rebuilt)
  78         std::string             Skeleton;                                       // filename (.skel)
  79         SCharacterPart  Parts[NB_CHARACTER3D_PARTS];
  80
  81         sint32                  Tattoo;
  82         sint32                  EyesColor;
  83         sint32                  HairColor;
  84
  85         sint32                  AnimPlayed;
  86
  87         float CharHeight;       // from -1 (smallest) to 1 (tallest)
  88         float ChestWidth;       // Slim -1  Normal 0  Fat 1
  89         float ArmsWidth;
  90         float LegsWidth;
  91         float BreastSize;
  92
  93         float MorphTarget[NB_MORPH_TARGETS]; // -100.0 - 100.0 (percentage of the mt)
  94
  95         // Additionnal information (if changed the instances are not reconstructed)
  96         EGSPD::CPeople::TPeople People;
  97         bool                            Male; // false == Female
  98         bool                            LeftHandItemIsShield; // If false this is a weapon if it exists
  99         bool                            HideFace;
 100
 101         // Constructor (setup a default fyros male)
 102         SCharacter3DSetup ();
 103
 104         // Initialize the structure with race_stats form
 105         void setupDefault (EGSPD::CPeople::TPeople eRace, bool bMale);
 106
 107         // Initialize the structure from a character summary struct
 108         void setupFromCharacterSummary (const CCharacterSummary &cs);
 109
 110         // Initialize the structure from a DataBase Branch (look in cpp to see the structure)
 111         void setupFromDataBase (const std::string &branchName);
 112
 113         // Initialize the structure from the SERVER:... DataBase Branch (which is messy)
 114         void setupFromSERVERDataBase (uint8 entityID = 0);
 115
 116         // Convert Tool
 117
 118         // Database Converter Tool
 119         static void setupDBFromCharacterSummary (const std::string &branchName, const CCharacterSummary &cs);
 120         static void setupCharacterSummaryFromDB (CCharacterSummary &cs, const std::string &branchName);
 121         static void setupCharacterSummaryFromSERVERDB (CCharacterSummary &cs, uint8 entityID = 0);
 122
 123         // Slots enums
 124         static TChar3DPart convert_VisualSlot_To_Char3DPart (SLOTTYPE::EVisualSlot vs);
 125         static SLOTTYPE::EVisualSlot convert_Char3DPart_To_VisualSlot (TChar3DPart cp);
 126         static std::string convert_VisualSlot_To_String (SLOTTYPE::EVisualSlot vs);
 127
 128         static uint64 getDB (const std::string &name);
 129         static void setDB (const std::string &name, uint64 val);
 130 private:
 131
 132         void setupFromCS_ModelCol (SLOTTYPE::EVisualSlot s, sint32 model, sint32 col);
 133
 134 };
 135
 136 // ------------------------------------------------------------------------------------------------
 137 class CCharacter3D : public CReflectableRefPtrTarget
 138 {
 139
 140 public:
 141
 142         CCharacter3D();
 143         ~CCharacter3D();
 144
 145         bool init (NL3D::UScene *pScene);
 146         void setup (const SCharacter3DSetup &newSetup);
 147         SCharacter3DSetup getCurrentSetup () { return _CurrentSetup; }
 148
 149         void setPos (float x, float y, float z);                        // reference point : Feet
 150         void setClusterSystem (NL3D::UInstanceGroup *pIG);
 151         void setRotEuler (float rx, float ry, float rz);
 152
 153         void getPos (float &x, float &y, float &z)      { x = _CurPosX; y = _CurPosY; z = _CurPosZ; }
 154         void getHeadPos (float &x, float &y, float &z);
 155         void getRotEuler (float &rx, float &ry, float &rz) { rx = _CurRotX; ry = _CurRotY; rz = _CurRotZ; }
 156
 157         void setAnim (uint animID);
 158
 159         void animate (double globalTime); // Should be called each frame
 160
 161         EGSPD::CPeople::TPeople getPeople() { return _CurrentSetup.People; }
 162         void                                    setPeople(EGSPD::CPeople::TPeople       people) { _CurrentSetup.People = people; }
 163
 164         bool    getSex() { return _CurrentSetup.Male; }
 165         void    setSex(bool male) { _CurrentSetup.Male = male; }
 166
 167         // get skeleton
 168         NL3D::USkeleton getSkeleton() { return _Skeleton; }
 169
 170         void copyAnimation(bool copyAnim) { _CopyAnim=copyAnim; }
 171
 172 private:
 173
 174         void resetAnimation (NL3D::UAnimationSet *animSet);
 175         void animblink (double globalTime);
 176         NLMISC::CVector getBonePos (const std::string &boneName);
 177
 178         // Internal stuff
 179         void setSkeleton (const std::string &filename);
 180         void createInstance (TChar3DPart i, const SCharacter3DSetup::SCharacterPart &part);
 181         void bindToSkeleton (TChar3DPart i);
 182         uint32 peopleToSkin (EGSPD::CPeople::TPeople p) const;
 183
 184         void    disableFaceMorphAndBlinks();
 185
 186 private:
 187
 188         NL3D::UScene                                    *_Scene; // reference to the scene containing the character
 189         //
 190         NL3D::UPlayListManager                  *_PlayListManager;
 191         NL3D::UAnimationSet                             *_AnimationSet; // reference to the option AnimationSet
 192         //
 193         NL3D::UPlayList                                 *_PlayList;
 194         NL3D::UPlayList                                 *_FacePlayList;
 195
 196         std::vector<COptionsAnimationSet::CAnim>                _AnimMale;
 197         std::vector<COptionsAnimationSet::CAnim>                _AnimFemale;
 198
 199         // Other instances
 200         NL3D::UInstance                                 _Instances[NB_CHARACTER3D_PARTS];
 201
 202         struct SInstanceFx
 203         {
 204                 NL3D::UInstance                                 AdvantageFx;
 205                 std::vector<NL3D::UInstance>    StaticFx;
 206         };
 207         SInstanceFx                                             _InstancesFx[NB_CHARACTER3D_PARTS];
 208
 209         // Skeleton
 210         NL3D::USkeleton                                 _Skeleton;
 211
 212         // Root is the parent of skeleton (needed because skeleton receive animation values)
 213         NL3D::UTransform                                _Root;
 214
 215         NL3D::UInstanceGroup                    *_ClusterSystem;
 216
 217         float                                                   _CurPosX, _CurPosY, _CurPosZ;
 218         float                                                   _CurRotX, _CurRotY, _CurRotZ;
 219
 220         // The animated pelvis pos
 221         NLMISC::CVector                                 _PelvisPos;
 222         float                                                   _CustomScalePos;
 223
 224         double                                                  _NextBlinkTime;
 225
 226         // Cache information
 227         SCharacter3DSetup                               _CurrentSetup;
 228
 229         bool                                                    _CopyAnim;
 230 };
 231
 232 #endif // CL_CHARACTER_3D_H