Engine directory for ticket #1

Engine/source/scene/reflectionManager.h

@@ -0,0 +1,154 @@
+//-----------------------------------------------------------------------------
+// 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 _REFLECTIONMANAGER_H_
+#define _REFLECTIONMANAGER_H_
+
+#ifndef _GFXDEVICE_H_
+#include "gfx/gfxDevice.h"
+#endif
+#ifndef _TVECTOR_H_
+#include "core/util/tVector.h"
+#endif
+#ifndef _UTIL_DELEGATE_H_
+#include "core/util/delegate.h"
+#endif
+#ifndef _GFXTEXTUREHANDLE_H_
+#include "gfx/gfxTextureHandle.h"
+#endif
+#ifndef _TSINGLETON_H_
+#include "core/util/tSingleton.h"
+#endif
+#ifndef _REFLECTOR_H_
+#include "scene/reflector.h"
+#endif
+
+class PlatformTimer;
+class BaseMatInstance;
+
+enum ReflectMode
+{
+   ReflectNever = 0,
+   ReflectDynamic,
+   ReflectAlways        
+};
+
+typedef Delegate<bool(bool)> ReflectDelegate;     
+class SceneObject;
+
+struct Reflector
+{
+   SceneObject *object;
+   ReflectDelegate updateFn;
+   F32 priority;
+   U32 maxRateMs;
+   F32 maxDist;
+   U32 lastUpdateMs;
+   F32 score;
+   bool updated;
+   bool tried;
+   bool hasTexture;
+};
+
+typedef Vector<Reflector> ReflectorVec;
+
+GFX_DeclareTextureProfile( ReflectRenderTargetProfile );
+GFX_DeclareTextureProfile( RefractTextureProfile );
+
+class ReflectionManager
+{
+public:
+
+   ReflectionManager();
+   virtual ~ReflectionManager();     
+
+   static void initConsole();
+
+   /// Called to change the reflection texture format.
+   void setReflectFormat( GFXFormat format ) { mReflectFormat = format; }
+
+   /// Returns the current reflection format.
+   GFXFormat getReflectFormat() const { return mReflectFormat; }
+
+   /// Doll out callbacks to registered objects based on 
+   /// scoring and elapsed time.  This should be called 
+   /// once for each viewport that renders.
+   void update(   F32 timeSlice, 
+                  const Point2I &resolution, 
+                  const CameraQuery &query );
+
+   void registerReflector( ReflectorBase *reflector );
+   void unregisterReflector( ReflectorBase *reflector );
+
+   GFXTexHandle allocRenderTarget( const Point2I &size );  
+
+   GFXTextureObject* getRefractTex();
+
+   BaseMatInstance* getReflectionMaterial( BaseMatInstance *inMat ) const;
+
+   const U32& getLastUpdateMs() const { return mLastUpdateMs; }
+
+protected:
+
+   bool _handleDeviceEvent( GFXDevice::GFXDeviceEventType evt );
+
+protected:
+   
+   /// ReflectionManager tries not to spend more than this amount of time
+   /// updating reflections per frame.
+   static U32 smFrameReflectionMS;
+
+   /// RefractTex has dimensions equal to the active render target scaled in
+   /// both x and y by this float.
+   static F32 smRefractTexScale;
+
+   /// A timer used for tracking update time.
+   PlatformTimer *mTimer;
+
+   /// All registered reflections which we handle updating.
+   ReflectorList mReflectors;
+
+   /// Refraction texture copied from the backbuffer once per frame that
+   /// gets used by all WaterObjects.
+   GFXTexHandle mRefractTex;
+
+   /// The texture format to use for reflection and
+   /// refraction texture sources.
+   GFXFormat mReflectFormat;
+
+   /// Set when the refraction texture is dirty
+   /// and requires an update.
+   bool mUpdateRefract;
+
+   /// Platform time in milliseconds of the last update.
+   U32 mLastUpdateMs;
+   
+public:
+   // For ManagedSingleton.
+   static const char* getSingletonName() { return "ReflectionManager"; }   
+};
+
+
+/// Returns the ReflectionManager singleton.
+#define REFLECTMGR ManagedSingleton<ReflectionManager>::instance()
+
+#endif // _REFLECTIONMANAGER_H_