Torque3D/Engine/source/postFx/postEffectVis.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.
//-----------------------------------------------------------------------------

#ifndef _POSTEFFECTVIS_H_
#define _POSTEFFECTVIS_H_

#ifndef _TSINGLETON_H_
#include "core/util/tSingleton.h"
#endif

#ifndef _POST_EFFECT_H_
#include "postFx/postEffect.h"
#endif

class GuiWindowCtrl;
class GuiBitmapCtrl;
class GuiControl;

class PostEffectVis
{
   // Protected constructor.
   // Use PFXVIS define to access singleton.
   PostEffectVis();
   friend class ManagedSingleton<PostEffectVis>;   

public:

   ~PostEffectVis();

   /// Open visualization windows for all input and target textures.
   void open( PostEffect *pfx );

   /// Close all visualization windows.
   void clear();

   /// Hide or show all visualization windows.
   void setVisible( bool visible );

   /// Callback from PostEffectManager at the start of a frame.
   void onStartOfFrame();
   
   /// Callback from PostEffect to update visualization.
   void onPFXProcessed( PostEffect *pfx );
      
   /// Callback when a visualization window is closed.
   void onWindowClosed( GuiWindowCtrl *ctrl );      

protected:

   /// Get or create the content control, the parent of all visualization windows.
   GuiControl* _getContentControl();

protected:

   enum TexIndex
   {
      Target = 0,
      Input1, 
      Input2, 
      Input3, 
      Input4,       
      TexCount
   };

   /// Structure representing a single 'opened' PostEffect
   /// including GuiControls for displaying any input/target textures.
   struct VisWindow
   {
      PostEffect *pfx;
      GuiWindowCtrl *window[TexCount];
      GuiBitmapCtrl *bmp[TexCount];
   };

   void _setDefaultCaption( VisWindow &vis, U32 texIndex );

   typedef Vector< VisWindow > VisVector;
   
   VisVector mWindows;

   GuiControl *mContent;
   
public:

   // For ManagedSingleton.
   static const char* getSingletonName() { return "PostEffectVis"; }
};

class PfxVis
{
   DECLARE_STATIC_CLASS(PfxVis)
};

/// Returns the PostEffectVis singleton.
#define PFXVIS ManagedSingleton<PostEffectVis>::instance()

#endif // _POSTEFFECTVIS_H_