Cortex  10.0.0-a4
State.h
1 //
3 // Copyright (c) 2007-2013, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECOREGL_STATE_H
36 #define IECOREGL_STATE_H
37 
38 #include "IECore/CompoundData.h"
39 
40 #include "IECoreGL/Export.h"
41 #include "IECoreGL/Bindable.h"
42 #include "IECoreGL/TypeIds.h"
43 
44 namespace IECoreGL
45 {
46 
47 IE_CORE_FORWARDDECLARE( State );
48 IE_CORE_FORWARDDECLARE( StateComponent );
49 
50 class IECOREGL_API State : public Bindable
51 {
52 
53  public :
54 
57  class IECOREGL_API ScopedBinding : private boost::noncopyable
58  {
59 
60  public :
61 
65  ScopedBinding( const State &s, State &currentState );
67  ScopedBinding( const State &s, State &currentState, bool bind );
70  ~ScopedBinding();
71 
72  private :
73 
74  void init( const State &s, bool bind = true );
75 
76  State &m_currentState;
77  std::vector<StateComponentPtr> m_savedComponents;
78 
79  };
80 
81  State( bool complete );
82  State( const State &other );
83 
84  ~State() override;
85 
86  IE_CORE_DECLARERUNTIMETYPEDEXTENSION( IECoreGL::State, StateTypeId, Bindable );
87 
88  // Binds this state
89  void bind() const override;
90 
93  void add( StatePtr s );
94 
100  void add( StateComponentPtr s, bool override = false );
101  template<typename T>
102  T *get();
103  template<typename T>
104  const T *get() const;
105  StateComponent *get( IECore::TypeId componentType );
106  const StateComponent *get( IECore::TypeId componentType ) const;
107  template<typename T> void remove();
108  void remove( IECore::TypeId componentType );
109 
110  bool isComplete() const;
111 
113  IECore::CompoundData *userAttributes();
114  const IECore::CompoundData *userAttributes() const;
115 
116  typedef StateComponentPtr (*CreatorFn)();
117  static void registerComponent( IECore::TypeId, CreatorFn );
118 
121  static const State *defaultState();
122 
137  static void bindBaseState();
138 
139  private :
140 
141  IE_CORE_FORWARDDECLARE( Implementation )
142  ImplementationPtr m_implementation;
143 
144  typedef std::map<IECore::TypeId, CreatorFn> CreatorMap;
145  static CreatorMap *creators();
146 
147 };
148 
149 } // namespace IECoreGL
150 
151 #include "IECoreGL/State.inl"
152 
153 #endif // IECOREGL_STATE_H
Definition: StateComponent.h:51
The namespace within which all CoreGL functionality is defined.
Definition: AlphaTexture.h:41
Definition: MStringLess.h:40
Definition: CompoundData.h:47
TypeId
Definition: TypeIds.h:46
Definition: Bindable.h:49
IECOREGL_API void init(bool glAlreadyInitialised=false)
Definition: State.h:57
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43