Engine directory for ticket #1

Engine/source/forest/forestWindMgr.h

@@ -0,0 +1,101 @@
+//-----------------------------------------------------------------------------
+// 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.
+//-----------------------------------------------------------------------------
+
+#ifndef _FORESTWINDMGR_H_
+#define _FORESTWINDMGR_H_
+
+#ifndef _FORESTWINDEMITTER_H_
+#include "forest/forestWindEmitter.h"
+#endif
+#ifndef _TDICTIONARY_H_
+#include "core/util/tDictionary.h"
+#endif
+#ifndef _ITICKABLE_H_
+#include "core/iTickable.h"
+#endif
+#ifndef _FORESTITEM_H_
+#include "forest/forestItem.h"
+#endif 
+#ifndef _TSINGLETON_H_
+#include "core/util/tSingleton.h"
+#endif
+
+struct TreePlacementInfo
+{
+   F32 scale;
+   Point3F pos;
+   ForestItemKey itemKey; 
+   ForestItemData *dataBlock;
+}; 
+
+class ForestWindMgr : public virtual ITickable
+{
+protected:
+
+   ForestWindEmitterList mEmitters;
+
+   typedef HashTable<U32,ForestWindAccumulator*> IdToWindMap;
+   typedef Signal<void( const Point3F &camPos, const F32 radius, Vector<TreePlacementInfo> *placementInfo )> WindAdvanceSignal;
+
+   IdToWindMap *mSources;
+   IdToWindMap *mPrevSources;
+   Vector<TreePlacementInfo> mPlacementInfo;
+
+   static WindAdvanceSignal smAdvanceSignal;
+
+   virtual void interpolateTick( F32 delta ) {};
+   virtual void processTick();
+   virtual void advanceTime( F32 timeDelta ) {};   
+
+public:
+
+   ForestWindMgr();
+   virtual ~ForestWindMgr();
+
+   void addEmitter( ForestWindEmitter *emitter );
+
+   void removeEmitter( ForestWindEmitter *emitter );
+
+   void updateWind(  const Point3F &camPos, 
+                     const TreePlacementInfo &info,
+                     F32 timeDelta );
+
+   ForestWindAccumulator* getLocalWind( ForestItemKey key );
+
+   // Returns the first non-radial emitter in the list.
+   ForestWindEmitter* getGlobalWind();
+
+
+   static WindAdvanceSignal& getAdvanceSignal() { return smAdvanceSignal; }
+
+   static F32 smWindEffectRadius;
+
+   static void initConsole();
+
+   // For ManagedSingleton.
+   static const char* getSingletonName() { return "ForestWindMgr"; }    
+};
+
+/// Returns the ReflectionManager singleton.
+#define WINDMGR ManagedSingleton<ForestWindMgr>::instance()
+
+#endif // _FORESTWINDMGR_H_