afxRenderHighlightMgr.h

Engine/source/afx/afxRenderHighlightMgr.h
Classes:

class
Detailed Description

 1
 2
 3//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
 4// Arcane-FX for MIT Licensed Open Source version of Torque 3D from GarageGames
 5// Copyright (C) 2015 Faust Logic, Inc.
 6//
 7// Permission is hereby granted, free of charge, to any person obtaining a copy
 8// of this software and associated documentation files (the "Software"), to
 9// deal in the Software without restriction, including without limitation the
10// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11// sell copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in
15// all copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23// IN THE SOFTWARE.
24//
25//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
26
27//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
28// The afxRenderHighlightMgr class is adapted from the resource,
29// "Silhoute selection via postFX for Torque3D" posted by Konrad Kiss.
30// http://www.garagegames.com/community/resources/view/17821
31// Supporting code mods in other areas of the engine are marked as
32// "(selection-highlight)".
33//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
34
35#ifndef _afxRENDERHIGHLIGHTMGR_H_
36#define _afxRENDERHIGHLIGHTMGR_H_
37
38#ifndef _TEXTARGETBIN_MGR_H_
39#include "renderInstance/renderTexTargetBinManager.h"
40#endif
41
42
43class PostEffect;
44
45
46///
47class afxRenderHighlightMgr : public RenderTexTargetBinManager
48{  
49   typedef RenderTexTargetBinManager Parent;
50
51public:
52
53   afxRenderHighlightMgr();
54   virtual ~afxRenderHighlightMgr();
55
56   /// Returns the selection post effect.
57   PostEffect* getSelectionEffect();
58
59   /// Returns true if the highlight post effect is
60   /// enabled and the selection buffer should be updated.
61   bool isSelectionEnabled();
62
63   // RenderBinManager
64   virtual void addElement( RenderInst *inst );
65   virtual void render( SceneRenderState *state );
66
67   // ConsoleObject
68   DECLARE_CONOBJECT( afxRenderHighlightMgr );
69
70protected:
71
72   SimObjectPtr<PostEffect> mSelectionEffect;  
73
74};
75
76
77#endif // _afxRENDERHIGHLIGHTMGR_H_
78