ryzom/client/src/fx_cl.cpp

   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) 2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   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 #include "stdpch.h"
  23
  24 #include "fx_cl.h"
  25 #include "fx_manager.h"
  26 #include "ingame_database_manager.h"
  27 #include "pacs_client.h"
  28 #include "misc.h"
  29 #include "debug_client.h"
  30 #include "client_sheets/fx_sheet.h"
  31
  32 #include "nel/3d/u_driver.h"
  33 #include "nel/3d/u_scene.h"
  34 #include "nel/misc/path.h"
  35
  36 using namespace NL3D;
  37 using namespace NLMISC;
  38
  39
  40 ////////////
  41 // EXTERN //
  42 ////////////
  43 extern UDriver                  *Driver;
  44 extern UScene                   *Scene;
  45
  46 /*
  47  * Constructor
  48  */
  49 CFxCL::CFxCL() : CEntityCL(), _FXSheet(NULL), _BadBuild(false)
  50 {
  51         init();
  52 }
  53
  54
  55
  56
  57 /*
  58  * init :
  59  * Initialize the Object with this function for all constructors.
  60  */
  61 void CFxCL::init()
  62 {
  63         //_CrtCheckMemory();
  64         CEntityCL::init();
  65         //_CrtCheckMemory();
  66 }
  67
  68
  69 /*
  70  * Build the entity from a sheet.
  71  */
  72 bool CFxCL::build( const CEntitySheet *sheet )
  73 {
  74         //_CrtCheckMemory();
  75
  76         // Get the FX filename and user params from the sheet (only the first one of PSList)
  77         _FXSheet = dynamic_cast<const CFXSheet*>(sheet);
  78         if ( (! _FXSheet) || (_FXSheet->PSList.empty()) )
  79         {
  80                 _BadBuild = true;
  81                 nlwarning( "Bad sheet %s for fx", sheet ? sheet->Id.toString().c_str() : "NULL" );
  82                 return false;
  83         }
  84
  85         // Base class init
  86         initialize();
  87         Type = Entity;
  88         if(IngameDbMngr.getNodePtr())
  89         {
  90                 CCDBNodeBranch *nodeRoot = dynamic_cast<CCDBNodeBranch *>(IngameDbMngr.getNodePtr()->getNode(0));
  91                 if(nodeRoot)
  92                 {
  93                         _DBEntry = dynamic_cast<CCDBNodeBranch *>(nodeRoot->getNode(_Slot));
  94                         if(_DBEntry == 0)
  95                                 pushDebugStr("Cannot get a pointer on the DB entry.");
  96                 }
  97         }
  98
  99         //_CrtCheckMemory();
 100         return true;
 101 }
 102
 103
 104 /*
 105  * setFx :
 106  * Initialize properties of the entity (according to the class).
 107  */
 108 bool CFxCL::setFx( const std::string &fileName )
 109 {
 110         //_CrtCheckMemory();
 111         // Delete the old _Instance if needed
 112         if(!_Instance.empty())
 113         {
 114                 if ( Scene )
 115                         Scene->deleteInstance(_Instance);
 116                 _Instance = NULL;
 117         }
 118
 119         // Create the FX object and insert it into the scene
 120         _Instance = Scene->createInstance( fileName );
 121         UParticleSystemInstance fxInst;
 122         fxInst.cast (_Instance);
 123         if (fxInst.empty())
 124         {
 125                 Scene->deleteInstance( _Instance );
 126                 _Instance = NULL;
 127                 nlwarning( "FX file '%s' not found.", fileName.c_str()) ;
 128                 return false;
 129         }
 130         //_CrtCheckMemory();
 131         return true;
 132 }
 133
 134
 135 /*
 136  * Update the item position.
 137  */
 138 void CFxCL::updateVisualPropertyPos(const NLMISC::TGameCycle &/* gameCycle */, const sint64 &prop, const NLMISC::TGameCycle &/* pI */)
 139 {
 140         //_CrtCheckMemory();
 141         // Check the DB entry (the warning is already done in the build method).
 142         if(_DBEntry == 0)
 143                 return;
 144         // Get The property 'Y'.
 145         CCDBNodeLeaf *nodeY     = dynamic_cast<CCDBNodeLeaf *>(_DBEntry->getNode(CLFECOMMON::PROPERTY_POSY));
 146         if(nodeY == 0)
 147         {
 148                 nlwarning("ITM:updtVPPos:%d: Cannot find the property 'PROPERTY_POSY(%d)'.", _Slot, CLFECOMMON::PROPERTY_POSY);
 149                 return;
 150         }
 151         // Get The property 'Z'.
 152         CCDBNodeLeaf *nodeZ     = dynamic_cast<CCDBNodeLeaf *>(_DBEntry->getNode(CLFECOMMON::PROPERTY_POSZ));
 153         if(nodeZ == 0)
 154         {
 155                 nlwarning("ITM:updtVPPos:%d: Cannot find the property 'PROPERTY_POSZ(%d)'.", _Slot, CLFECOMMON::PROPERTY_POSZ);
 156                 return;
 157         }
 158         // Insert the primitive into the world.
 159         if(_Primitive)
 160                 _Primitive->insertInWorldImage(dynamicWI);
 161
 162         // Set the primitive position and snap the entity to the ground.
 163         CVectorD requestedPos( (float)(prop)/1000.0f,
 164                                                    (float)(nodeY->getValue64())/1000.0f,
 165                                                    (float)(nodeZ->getValue64())/1000.0f );
 166         pacsPos( requestedPos );
 167         snapToGround();
 168
 169         // Set normal mode and unflag _FirsPos to prevent the fx to be clipped out
 170         _Mode = MBEHAV::NORMAL;
 171         _First_Pos = false;
 172
 173         if (_BadBuild) return;
 174
 175         if (_Instance.empty())
 176         {
 177                 if ( ! setFx( _FXSheet->PSList[0].PSName ) )
 178                 {
 179                         _BadBuild = true;
 180                         return;
 181                 }
 182                 UParticleSystemInstance fxInst;
 183                 fxInst.cast (_Instance);
 184                 fxInst.setUserParam( 0, _FXSheet->PSList[0].Power[CFXSheet::CPSStruct::StandardIndex].UserParam0 );
 185                 fxInst.setUserParam( 1, _FXSheet->PSList[0].Power[CFXSheet::CPSStruct::StandardIndex].UserParam1 );
 186
 187
 188         }
 189
 190         // Change the instance position.
 191         if (!_Instance.empty())
 192         {
 193                 CVector prevPos;
 194                 _Instance.getPos(prevPos);
 195                 _Instance.setPos( pos() );
 196                 UParticleSystemInstance fxInst;
 197                 fxInst.cast (_Instance);
 198                 fxInst.getShapeAABBox( _SelectBox );
 199                 _SelectBox.setCenter( pos() + _SelectBox.getCenter() );
 200                 //nldebug( "SelectBox: %s %s", _SelectBox.getCenter().asString().c_str(), _SelectBox.getHalfSize().asString().c_str() );
 201
 202                 // Adjust the collision.
 203                 if( _Primitive )
 204                 {
 205                         _Primitive->setRadius(std::min(std::max((_SelectBox.getHalfSize()).x, (_SelectBox.getHalfSize()).y), (float)(RYZOM_ENTITY_SIZE_MAX/2)));
 206                         _Primitive->setHeight((_SelectBox.getHalfSize()).z);
 207                 }
 208
 209                 if (_Instance.getPos() != prevPos)
 210                 {
 211                         // a move or init occurred -> must update cluster system
 212                         UGlobalPosition gPos;
 213                         if( _Primitive )
 214                         {
 215                                 _Primitive->getGlobalPosition(gPos, dynamicWI);
 216                         }
 217                         else
 218                         {
 219                                 GR->retrievePosition(pos());
 220                         }
 221                         UInstanceGroup *clusterSystem = getCluster(gPos);
 222                         _Instance.setClusterSystem(clusterSystem);
 223                 }
 224
 225         }
 226
 227
 228         //_CrtCheckMemory();
 229 }
 230
 231
 232 /*
 233  * Update the position of the entity after the motion.
 234  */
 235 /*void CFxCL::updatePos( const NLMISC::TTime &time, CEntityCL *target )
 236 {
 237         CEntityCL::updatePos( time, target );
 238 }*/
 239 /*
 240  * updateDisplay : get the entity position and set all visual stuff with it.
 241  */
 242 /*void CFxCL::updateVisible( const NLMISC::TTime &time, CEntityCL *target )
 243 {
 244         CEntityCL::updateVisible( time, target );
 245 }*/
 246
 247
 248 /*
 249  * Draw the selection Box.
 250  */
 251 void CFxCL::drawBox()
 252 {
 253         ::drawBox(selectBox().getMin(), selectBox().getMax(), CRGBA(250,250,0));
 254 }// drawBox //
 255
 256
 257 /*
 258  * Destructor
 259  */
 260 CFxCL::~CFxCL()
 261 {
 262         //_CrtCheckMemory();
 263         if (_Instance.empty())
 264                 return;
 265
 266         // Stop emitters
 267         UParticleSystemInstance fxInst;
 268         fxInst.cast (_Instance);
 269         if (!fxInst.removeByID(NELID("STOP")) && !fxInst.removeByID(NELID("main")))
 270         {
 271                 fxInst.activateEmitters( false );
 272         }
 273
 274         // Delegate the clean removal of the fx to the fx manager
 275         FXMngr.fx2remove( fxInst );
 276         // The fx manager now has ownership on the fx, so set the pointer to NULL,
 277         // (otherwise it is delete in CentityCL dtor)
 278         _Instance = NULL;
 279 }