Torque3D Documentation / _generateds / instancingMatHook.h

instancingMatHook.h

Engine/source/ts/instancingMatHook.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 _INSTANCINGMATHOOK_H_
25#define _INSTANCINGMATHOOK_H_
26
27#ifndef _MATINSTANCEHOOK_H_
28#include "materials/matInstanceHook.h"
29#endif
30
31class BaseMatInstance;
32
33
34class InstancingMaterialHook : public MatInstanceHook
35{
36public:
37
38   /// The material hook type.
39   static const MatInstanceHookType Type;
40
41   InstancingMaterialHook();
42   virtual ~InstancingMaterialHook();
43
44   // MatInstanceHook
45   virtual const MatInstanceHookType& getType() const { return Type; }
46
47   /// Returns the instancing material instance or the input material 
48   /// instance if one could not be created.
49   static BaseMatInstance* getInstancingMat( BaseMatInstance *matInst );
50
51protected:
52
53   /// The instancing material.
54   BaseMatInstance *mMatInst;
55
56};
57
58#endif // _INSTANCINGMATHOOK_H_
59