matStateHint.h

Classes:

class
A simple object for generating and comparing string based hints used for sorting and identifying materials uniquely by its shaders and states.
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 _MATSTATEHINT_H_
25#define _MATSTATEHINT_H_
26
27#ifndef _TORQUE_STRING_H_
28#include "core/util/str.h"
29#endif
30
31class ProcessedMaterial;
32
33
34/// A simple object for generating and comparing string based
35/// hints used for sorting and identifying materials uniquely
36/// by its shaders and states.
37class MatStateHint
38{
39public:
40
41   /// Constructor.
42   MatStateHint() {}
43
44   /// Constructor for building special hints.
45   MatStateHint( const String &state ) 
46      : mState( state.intern() )
47   {
48   }
49
50   /// Initialize the state hint from a ProcessMaterial.  This
51   /// assumes that the ProcessedMaterial has properly initialized
52   /// its passes to describe the material uniquely.
53   void init( const ProcessedMaterial *mat );
54
55   /// Clears the hint.
56   void clear() { mState.clear(); }
57
58   /// Returns a 32bit hash key used for sorting by material state.
59   operator U32() const { return mState.getHashCaseSensitive(); }
60
61   /// Fast comparision of state for equality.
62   bool operator==( const MatStateHint& hint ) const { return mState == hint.mState; }
63
64   /// Fast comparision of state for inequality.
65   bool operator!=( const MatStateHint& hint ) const { return mState != hint.mState; }
66
67   /// A default state hint.
68   static const MatStateHint Default;
69
70protected:
71
72   /// An interned string of the combined material shader and state info
73   /// for evert pass of the processed material.
74   String mState;
75   
76};
77
78#endif // _MATSTATEHINT_H_
79