Implementation of reflection and skylight probes.

Moves lighting math to the diffuse/specular two-channel logic.

Engine/source/T3D/lighting/reflectionProbe.h

@@ -0,0 +1,278 @@
+//-----------------------------------------------------------------------------
+// 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 REFLECTIONPROBE_H
+#define REFLECTIONPROBE_H
+
+#ifndef _SCENEOBJECT_H_
+#include "scene/sceneObject.h"
+#endif
+#ifndef _GFXVERTEXBUFFER_H_
+#include "gfx/gfxVertexBuffer.h"
+#endif
+#ifndef _GFXPRIMITIVEBUFFER_H_
+#include "gfx/gfxPrimitiveBuffer.h"
+#endif
+#ifndef _TSSHAPEINSTANCE_H_
+#include "ts/tsShapeInstance.h"
+#endif
+#include "lighting/lightInfo.h"
+
+#ifndef _RENDERPASSMANAGER_H_
+#include "renderInstance/renderPassManager.h"
+#endif
+
+#ifndef PROBEMANAGER_H
+#include "lighting/probeManager.h"
+#endif
+
+class BaseMatInstance;
+
+
+//-----------------------------------------------------------------------------
+// This class implements a basic SceneObject that can exist in the world at a
+// 3D position and render itself. There are several valid ways to render an
+// object in Torque. This class implements the preferred rendering method which
+// is to submit a MeshRenderInst along with a Material, vertex buffer,
+// primitive buffer, and transform and allow the RenderMeshMgr handle the
+// actual setup and rendering for you.
+//-----------------------------------------------------------------------------
+
+class ReflectionProbe : public SceneObject
+{
+   typedef SceneObject Parent;
+
+public:
+
+   enum IndrectLightingModeType
+   {
+      NoIndirect = 0,            
+      AmbientColor = 1, 
+      SphericalHarmonics = 2
+   };
+
+   enum ReflectionModeType
+   {
+      NoReflection = 0,
+      StaticCubemap = 1,
+      BakedCubemap = 2,
+      DynamicCubemap = 5,
+   };
+
+private:
+
+   // Networking masks
+   // We need to implement a mask specifically to handle
+   // updating our transform from the server object to its
+   // client-side "ghost". We also need to implement a
+   // maks for handling editor updates to our properties
+   // (like material).
+   enum MaskBits
+   {
+      TransformMask = Parent::NextFreeMask << 0,
+      UpdateMask = Parent::NextFreeMask << 1,
+      EnabledMask = Parent::NextFreeMask << 2,
+      CubemapMask = Parent::NextFreeMask << 3,
+      ModeMask = Parent::NextFreeMask << 4,
+      RadiusMask = Parent::NextFreeMask << 5,
+      ShapeTypeMask = Parent::NextFreeMask << 6,
+      BakeInfoMask = Parent::NextFreeMask << 7,
+      NextFreeMask = Parent::NextFreeMask << 8
+   };
+
+   bool mBake;
+   bool mEnabled;
+   bool mDirty;
+
+   Resource<TSShape> mEditorShape;
+   TSShapeInstance* mEditorShapeInst;
+
+   //--------------------------------------------------------------------------
+   // Rendering variables
+   //--------------------------------------------------------------------------
+   ProbeInfo::ProbeShapeType mProbeShapeType;
+
+   ProbeInfo* mProbeInfo;
+
+   //Indirect Lighting Contribution stuff
+   IndrectLightingModeType mIndrectLightingModeType;
+   LinearColorF mAmbientColor;
+   LinearColorF mSphericalHarmonics;
+
+   //Reflection Contribution stuff
+   ReflectionModeType mReflectionModeType;
+
+   F32 mRadius;
+
+   String mCubemapName;
+   CubemapData *mCubemap;
+   GFXCubemapHandle  mDynamicCubemap;
+   bool mUseCubemap;
+
+   //irridiance resources
+   GFXCubemapHandle mIrridianceMap;
+
+   //prefilter resources
+   GFXCubemapHandle mPrefilterMap;
+   U32 mPrefilterMipLevels;
+   U32 mPrefilterSize;
+
+   //brdflookup resources - shares the texture target with the prefilter
+   GFXTexHandle mBrdfTexture;
+
+   String mReflectionPath;
+   String mProbeUniqueID;
+
+   // Define our vertex format here so we don't have to
+   // change it in multiple spots later
+   typedef GFXVertexPNTTB VertexType;
+
+   // The GFX vertex and primitive buffers
+   GFXVertexBufferHandle< VertexType > mVertexBuffer;
+   GFXPrimitiveBufferHandle            mPrimitiveBuffer;
+
+   U32 mSphereVertCount;
+   U32 mSpherePrimitiveCount;
+
+   //Debug rendering
+   static bool smRenderReflectionProbes;
+   static bool smRenderPreviewProbes;
+
+   U32 mDynamicLastBakeMS;
+   U32 mRefreshRateMS;
+
+   GBitmap* mCubeFaceBitmaps[6];
+   U32 mCubemapResolution;
+
+   F32 mMaxDrawDistance;
+
+   bool mResourcesCreated;
+
+public:
+   ReflectionProbe();
+   virtual ~ReflectionProbe();
+
+   // Declare this object as a ConsoleObject so that we can
+   // instantiate it into the world and network it
+   DECLARE_CONOBJECT(ReflectionProbe);
+
+   //--------------------------------------------------------------------------
+   // Object Editing
+   // Since there is always a server and a client object in Torque and we
+   // actually edit the server object we need to implement some basic
+   // networking functions
+   //--------------------------------------------------------------------------
+   // Set up any fields that we want to be editable (like position)
+   static void initPersistFields();
+
+   // Allows the object to update its editable settings
+   // from the server object to the client
+   virtual void inspectPostApply();
+
+   static bool _setEnabled(void *object, const char *index, const char *data);
+   static bool _doBake(void *object, const char *index, const char *data);
+
+   static bool protectedSetSHTerms(void *object, const char *index, const char *data);
+   static bool protectedSetSHConsts(void *object, const char *index, const char *data);
+
+   // Handle when we are added to the scene and removed from the scene
+   bool onAdd();
+   void onRemove();
+
+   virtual void writeFields(Stream &stream, U32 tabStop);
+   virtual bool writeField(StringTableEntry fieldname, const char *value);
+
+   // Override this so that we can dirty the network flag when it is called
+   void setTransform(const MatrixF &mat);
+
+   // This function handles sending the relevant data from the server
+   // object to the client object
+   U32 packUpdate(NetConnection *conn, U32 mask, BitStream *stream);
+   // This function handles receiving relevant data from the server
+   // object and applying it to the client object
+   void unpackUpdate(NetConnection *conn, BitStream *stream);
+
+   //--------------------------------------------------------------------------
+   // Object Rendering
+   // Torque utilizes a "batch" rendering system. This means that it builds a
+   // list of objects that need to render (via RenderInst's) and then renders
+   // them all in one batch. This allows it to optimized on things like
+   // minimizing texture, state, and shader switching by grouping objects that
+   // use the same Materials.
+   //--------------------------------------------------------------------------
+
+   // Create the geometry for rendering
+   void createGeometry();
+
+   // Get the Material instance
+   void updateMaterial();
+
+   void updateProbeParams();
+
+   bool createClientResources();
+   void generateTextures();
+
+   // This is the function that allows this object to submit itself for rendering
+   void prepRenderImage(SceneRenderState *state);
+
+   void _onRenderViz(ObjectRenderInst *ri,
+      SceneRenderState *state,
+      BaseMatInstance *overrideMat);
+
+   void setPreviewMatParameters(SceneRenderState* renderState, BaseMatInstance* mat);
+
+   //Spherical Harmonics
+   void calculateSHTerms();
+   F32 texelSolidAngle(F32 aU, F32 aV, U32 width, U32 height);
+   F32 areaElement(F32 x, F32 y);
+
+   //
+   MatrixF getSideMatrix(U32 side);
+   LinearColorF decodeSH(Point3F normal);
+
+   //
+   void calcDirectionVector(U32 face, U32 face_x, U32 face_y, F32& out_x, F32& out_y, F32& out_z) const;
+   F32 calcSolidAngle(U32 face, U32 x, U32 y) const;
+   LinearColorF sampleFace(U32 face, F32 s, F32 t);
+   LinearColorF readTexelClamped(U32 face, U32 x, U32 y);
+   void computeTexCoords(F32 x, F32 y, F32 z, U32& out_face, F32& out_s, F32& out_t);
+   LinearColorF readTexel(U32 face, U32 x, U32 y) const;
+
+   //
+   LinearColorF sampleSide(U32 termindex, U32 sideIndex);
+   F32 harmonics(U32 termId, Point3F normal);
+
+
+   //Baking
+   void bake(String outputPath, S32 resolution);
+};
+
+typedef ProbeInfo::ProbeShapeType ReflectProbeType;
+DefineEnumType(ReflectProbeType);
+
+typedef ReflectionProbe::IndrectLightingModeType IndrectLightingModeEnum;
+DefineEnumType(IndrectLightingModeEnum);
+
+typedef ReflectionProbe::ReflectionModeType ReflectionModeEnum;
+DefineEnumType(ReflectionModeEnum);
+
+#endif // _ReflectionProbe_H_