Torque3D/Engine/source/T3D/fx/particleEmitter.h

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
// Arcane-FX for MIT Licensed Open Source version of Torque 3D from GarageGames
// Copyright (C) 2015 Faust Logic, Inc.
//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//

#ifndef _H_PARTICLE_EMITTER
#define _H_PARTICLE_EMITTER

#ifndef _GAMEBASE_H_
#include "T3D/gameBase/gameBase.h"
#endif
#ifndef _COLOR_H_
#include "core/color.h"
#endif
#ifndef _GFXPRIMITIVEBUFFER_H_
#include "gfx/gfxPrimitiveBuffer.h"
#endif
#ifndef _GFXVERTEXBUFFER_H_
#include "gfx/gfxVertexBuffer.h"
#endif
#ifndef _PARTICLE_H_
#include "T3D/fx/particle.h"
#endif

class RenderPassManager;
class ParticleData;

#ifdef TORQUE_AFX_ENABLED
	#define AFX_CAP_PARTICLE_POOLS
	#if defined(AFX_CAP_PARTICLE_POOLS)
	class afxParticlePoolData;
	class afxParticlePool;
	#endif
#endif

//*****************************************************************************
// Particle Emitter Data
//*****************************************************************************
class ParticleEmitterData : public GameBaseData
{
   typedef GameBaseData Parent;

   static bool _setAlignDirection( void *object, const char *index, const char *data );

  public:
  
   ParticleEmitterData();
   DECLARE_CONOBJECT(ParticleEmitterData);
   static void initPersistFields();
   void packData(BitStream* stream);
   void unpackData(BitStream* stream);
   bool preload(bool server, String &errorStr);
   bool onAdd();
   void allocPrimBuffer( S32 overrideSize = -1 );

  public:
   S32   ejectionPeriodMS;                   ///< Time, in Milliseconds, between particle ejection
   S32   periodVarianceMS;                   ///< Varience in ejection peroid between 0 and n

   F32   ejectionVelocity;                   ///< Ejection velocity
   F32   velocityVariance;                   ///< Variance for velocity between 0 and n
   F32   ejectionOffset;                     ///< Z offset from emitter point to eject from
   F32   ejectionOffsetVariance;             ///< Z offset Variance from emitter point to eject 
   F32   thetaMin;                           ///< Minimum angle, from the horizontal plane, to eject from
   F32   thetaMax;                           ///< Maximum angle, from the horizontal plane, to eject from

   F32   phiReferenceVel;                    ///< Reference angle, from the verticle plane, to eject from
   F32   phiVariance;                        ///< Varience from the reference angle, from 0 to n

   F32   softnessDistance;                   ///< For soft particles, the distance (in meters) where particles will be faded
                                             ///< based on the difference in depth between the particle and the scene geometry.

   /// A scalar value used to influence the effect 
   /// of the ambient color on the particle.
   F32 ambientFactor;

   S32   lifetimeMS;                         ///< Lifetime of particles
   U32   lifetimeVarianceMS;                 ///< Varience in lifetime from 0 to n

   bool  overrideAdvance;                    ///<
   bool  orientParticles;                    ///< Particles always face the screen
   bool  orientOnVelocity;                   ///< Particles face the screen at the start
   bool  useEmitterSizes;                    ///< Use emitter specified sizes instead of datablock sizes
   bool  useEmitterColors;                   ///< Use emitter specified colors instead of datablock colors
   bool  alignParticles;                     ///< Particles always face along a particular axis
   Point3F alignDirection;                   ///< The direction aligned particles should face

   StringTableEntry      particleString;     ///< Used to load particle data directly from a string

   Vector<ParticleData*> particleDataBlocks; ///< Particle Datablocks 
   Vector<U32>           dataBlockIds;       ///< Datablock IDs (parellel array to particleDataBlocks)

   U32                   partListInitSize;   /// initial size of particle list calc'd from datablock info

   GFXPrimitiveBufferHandle   primBuff;

   S32                   blendStyle;         ///< Pre-define blend factor setting
   bool                  sortParticles;      ///< Particles are sorted back-to-front
   bool                  reverseOrder;       ///< reverses draw order
   StringTableEntry      textureName;        ///< Emitter texture file to override particle textures
   GFXTexHandle          textureHandle;      ///< Emitter texture handle from txrName
   bool                  highResOnly;        ///< This particle system should not use the mixed-resolution particle rendering
   bool                  renderReflection;   ///< Enables this emitter to render into reflection passes.
   bool glow;                                ///< Renders this emitter into the glow buffer.

   bool reload();
public:
   bool         fade_color;
   bool         fade_size;
   bool         fade_alpha;
   bool         ejectionInvert;
   U8           parts_per_eject;
   bool         use_emitter_xfm;
#if defined(AFX_CAP_PARTICLE_POOLS) 
public:
   afxParticlePoolData* pool_datablock;
   U32          pool_index;
   bool         pool_depth_fade;
   bool         pool_radial_fade;
   bool         do_pool_id_convert;
#endif
public:
   /*C*/ ParticleEmitterData(const ParticleEmitterData&, bool = false);
   /*D*/ ~ParticleEmitterData();
   virtual ParticleEmitterData* cloneAndPerformSubstitutions(const SimObject*, S32 index=0);
   virtual bool allowSubstitutions() const { return true; }
};

//*****************************************************************************
// Particle Emitter
//*****************************************************************************
class ParticleEmitter : public GameBase
{
   typedef GameBase Parent;
#if defined(AFX_CAP_PARTICLE_POOLS) 
   friend class afxParticlePool;
#endif 

  public:

   typedef GFXVertexPCT ParticleVertexType;

   ParticleEmitter();
   ~ParticleEmitter();

   DECLARE_CONOBJECT(ParticleEmitter);

   static Point3F mWindVelocity;
   static void setWindVelocity( const Point3F &vel ){ mWindVelocity = vel; }
   
   LinearColorF getCollectiveColor();

   /// Sets sizes of particles based on sizelist provided
   /// @param   sizeList   List of sizes
   void setSizes( F32 *sizeList );

   /// Sets colors for particles based on color list provided
   /// @param   colorList   List of colors
   void setColors( LinearColorF *colorList );

   ParticleEmitterData *getDataBlock(){ return mDataBlock; }
   bool onNewDataBlock( GameBaseData *dptr, bool reload );

   /// By default, a particle renderer will wait for it's owner to delete it.  When this
   /// is turned on, it will delete itself as soon as it's particle count drops to zero.
   void deleteWhenEmpty();

   /// @name Particle Emission
   /// Main interface for creating particles.  The emitter does _not_ track changes
   ///  in axis or velocity over the course of a single update, so this should be called
   ///  at a fairly fine grain.  The emitter will potentially track the last particle
   ///  to be created into the next call to this function in order to create a uniformly
   ///  random time distribution of the particles.  If the object to which the emitter is
   ///  attached is in motion, it should try to ensure that for call (n+1) to this
   ///  function, start is equal to the end from call (n).  This will ensure a uniform
   ///  spatial distribution.
   /// @{

   void emitParticles(const Point3F& start,
                      const Point3F& end,
                      const Point3F& axis,
                      const Point3F& velocity,
                      const U32      numMilliseconds);
   void emitParticles(const Point3F& point,
                      const bool     useLastPosition,
                      const Point3F& axis,
                      const Point3F& velocity,
                      const U32      numMilliseconds);
   void emitParticles(const Point3F& rCenter,
                      const Point3F& rNormal,
                      const F32      radius,
                      const Point3F& velocity,
                      S32 count);
   /// @}

   bool mDead;

  protected:
   /// @name Internal interface
   /// @{

   /// Adds a particle
   /// @param   pos   Initial position of particle
   /// @param   axis
   /// @param   vel   Initial velocity
   /// @param   axisx
   void addParticle(const Point3F &pos, const Point3F &axis, const Point3F &vel, const Point3F &axisx, const U32 age_offset);


   inline void setupBillboard( Particle *part,
                               Point3F *basePts,
                               const MatrixF &camView,
                               const LinearColorF &ambientColor,
                               ParticleVertexType *lVerts );

   inline void setupOriented( Particle *part,
                              const Point3F &camPos,
                              const LinearColorF &ambientColor,
                              ParticleVertexType *lVerts );

   inline void setupAligned(  const Particle *part, 
                              const LinearColorF &ambientColor,
                              ParticleVertexType *lVerts );

   /// Updates the bounding box for the particle system
   void updateBBox();

   /// @}
  protected:
   bool onAdd();
   void onRemove();

   void processTick(const Move *move);
   void advanceTime(F32 dt);

   // Rendering
  protected:
   void prepRenderImage( SceneRenderState *state );
   void copyToVB( const Point3F &camPos, const LinearColorF &ambientColor );

   // PEngine interface
  private:

   // AFX subclasses to ParticleEmitter require access to some members and methods of
   // ParticleEmitter which are normally declared with private scope. In this section,
   // protected and private scope statements have been inserted inline with the original
   // code to expose the necessary members and methods.
   void update( U32 ms );
protected:
   inline void updateKeyData( Particle *part );
 

  private:

   /// Constant used to calculate particle 
   /// rotation from spin and age.
   static const F32 AgedSpinToRadians;

   ParticleEmitterData* mDataBlock;

protected: 
   U32       mInternalClock;

   U32       mNextParticleTime;

   Point3F   mLastPosition;
   bool      mHasLastPosition;
private:   
   MatrixF   mBBObjToWorld;

   bool      mDeleteWhenEmpty;
   bool      mDeleteOnTick;

protected: 
   S32       mLifetimeMS;
   S32       mElapsedTimeMS;

private:  
   F32       sizes[ ParticleData::PDC_NUM_KEYS ];
   LinearColorF    colors[ ParticleData::PDC_NUM_KEYS ];

   GFXVertexBufferHandle<ParticleVertexType> mVertBuff;

protected:
   //   These members are for implementing a link-list of the active emitter 
   //   particles. Member part_store contains blocks of particles that can be
   //   chained in a link-list. Usually the first part_store block is large
   //   enough to contain all the particles but it can be expanded in emergency
   //   circumstances.
   Vector <Particle*> part_store;
   Particle*  part_freelist;
   Particle   part_list_head;
   S32        n_part_capacity;
   S32        n_parts;
private:    
   S32       mCurBuffSize;

  protected:
   F32 fade_amt;
   bool forced_bbox;
   bool db_temp_clone;
   Point3F pos_pe;
   S8 sort_priority;
   virtual void sub_particleUpdate(Particle*) { }
  public:
   virtual void emitParticlesExt(const MatrixF& xfm, const Point3F& point, const Point3F& velocity, const U32 numMilliseconds);
   void setFadeAmount(F32 amt) { fade_amt = amt; }  
   void setForcedObjBox(Box3F& box);
   void setSortPriority(S8 priority);
#if defined(AFX_CAP_PARTICLE_POOLS)
  protected:
   afxParticlePool* pool;
  public:
   void clearPool() { pool = 0; }
   void setPool(afxParticlePool* p) { pool = p; }
#endif
};

#endif // _H_PARTICLE_EMITTER