matInstanceHook.h

Engine/source/materials/matInstanceHook.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _MATINSTANCEHOOK_H_
25#define _MATINSTANCEHOOK_H_
26
27#ifndef _TDICTIONARY_H_
28#include "core/util/tDictionary.h"
29#endif
30
31
32/// The hook type wrapper object
33class MatInstanceHookType
34{
35protected:
36
37   typedef HashTable<String,U32> TypeMap;
38
39   /// Returns the map of all the hook types.  We create
40   /// it as a method static so that its available to other
41   /// statics regardless of initialization order.
42   static inline TypeMap& getTypeMap()
43   {
44      static TypeMap smTypeMap;
45      return smTypeMap;
46   }
47
48   /// The hook type index for this type.
49   U32 mTypeIndex;
50
51public:
52
53   MatInstanceHookType( const char *type );
54
55   inline MatInstanceHookType( const MatInstanceHookType &type )
56      : mTypeIndex( type.mTypeIndex )
57   {
58   }
59
60   inline operator U32 () const { return mTypeIndex; }
61};
62
63
64/// This class is used to define hook objects attached to
65/// material instances and provide a registration system
66/// for different hook types.
67///
68/// @see BaseMatInstance
69/// @see MaterialManager
70///
71class MatInstanceHook
72{
73public:
74
75   ///
76   virtual ~MatInstanceHook() {}
77
78   /// 
79   virtual const MatInstanceHookType& getType() const = 0;
80};
81
82#endif // _MATINSTANCEHOOK_H_
83
84
85
86
87
88
89