OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OgreShaderSubRenderState.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org
6 
7 Copyright (c) 2000-2011 Torus Knot Software Ltd
8 Permission is hereby granted, free of charge, to any person obtaining a copy
9 of this software and associated documentation files (the "Software"), to deal
10 in the Software without restriction, including without limitation the rights
11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 copies of the Software, and to permit persons to whom the Software is
13 furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16 all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 THE SOFTWARE.
25 -----------------------------------------------------------------------------
26 */
27 #ifndef _ShaderSubRenderState_
28 #define _ShaderSubRenderState_
29 
31 #include "OgreGpuProgram.h"
32 #include "OgreSceneManager.h"
33 #include "OgreMaterialSerializer.h"
34 #include "OgreScriptCompiler.h"
36 
37 
38 namespace Ogre {
39 namespace RTShader {
40 
49 
50 
57 {
58 
59 // Interface.
60 public:
61 
63  SubRenderState ();
64 
66  virtual ~SubRenderState ();
67 
68 
73  virtual const String& getType () const = 0;
74 
75 
81  virtual int getExecutionOrder () const = 0;
82 
83 
87  virtual void copyFrom (const SubRenderState& rhs) = 0;
88 
92  SubRenderState& operator= (const SubRenderState& rhs);
93 
100  virtual bool createCpuSubPrograms (ProgramSet* programSet);
101 
111  virtual void updateGpuProgramsParams (Renderable* rend, Pass* pass, const AutoParamDataSource* source, const LightList* pLightList) { }
112 
120  virtual bool preAddToRenderState (RenderState* renderState, Pass* srcPass, Pass* dstPass) { return true; }
121 
125  SubRenderStateAccessorPtr getAccessor ();
126 
130  SubRenderStateAccessorPtr getAccessor () const;
131 
132 // Protected methods
133 protected:
134 
139  virtual bool resolveParameters (ProgramSet* programSet);
140 
145  virtual bool resolveDependencies (ProgramSet* programSet);
146 
151  virtual bool addFunctionInvocations (ProgramSet* programSet);
152 
153 // Attributes.
154 private:
155  mutable SubRenderStateAccessorPtr mThisAccessor; // The accessor of this instance.
156  SubRenderStateAccessorPtr mOtherAccessor; // The accessor of the source instance which used as base to create this instance.
157 
158 };
159 
161 typedef SubRenderStateList::iterator SubRenderStateListIterator;
162 typedef SubRenderStateList::const_iterator SubRenderStateListConstIterator;
163 
165 typedef SubRenderStateSet::iterator SubRenderStateSetIterator;
166 typedef SubRenderStateSet::const_iterator SubRenderStateSetConstIterator;
167 
168 
176 {
177 public:
180  void addSubRenderStateInstance(SubRenderState* subRenderState) const
181  {
182  mSubRenderStateInstancesSet.insert(subRenderState);
183  }
184 
187  void removeSubRenderStateInstance(SubRenderState* subRenderState) const
188  {
189  SubRenderStateSetIterator itFind = mSubRenderStateInstancesSet.find(subRenderState);
190 
191  if (itFind != mSubRenderStateInstancesSet.end())
192  {
193  mSubRenderStateInstancesSet.erase(itFind);
194  }
195  }
196 
198  SubRenderStateSet& getSubRenderStateInstanceSet() { return mSubRenderStateInstancesSet; }
199 
201  const SubRenderStateSet& getSubRenderStateInstanceSet() const { return mSubRenderStateInstancesSet; }
202 
203 protected:
206  SubRenderStateAccessor(const SubRenderState* templateSubRenderState) : mTemplateSubRenderState(templateSubRenderState) {}
207 
208 
209 protected:
212 
213 private:
214  friend class SubRenderState;
215 
216 };
217 
218 
231 {
232 
233 public:
235  virtual ~SubRenderStateFactory ();
236 
242  virtual const String& getType () const = 0;
243 
246  virtual SubRenderState* createInstance ();
247 
255  virtual SubRenderState* createInstance (ScriptCompiler* compiler, PropertyAbstractNode* prop, Pass* pass) { return NULL; }
256 
260  virtual void destroyInstance (SubRenderState* subRenderState);
261 
264  virtual void destroyAllInstances ();
265 
275  virtual void writeInstance (MaterialSerializer* ser, SubRenderState* subRenderState, Pass* srcPass, Pass* dstPass) {}
276 
277 protected:
282  virtual SubRenderState* createInstanceImpl () = 0;
283 
284 // Attributes.
285 protected:
286  SubRenderStateSet mSubRenderStateList; // List of all sub render states instances this factory created.
287 };
288 
292 }
293 }
294 
295 #endif
296 
SubRenderStateList::const_iterator SubRenderStateListConstIterator
SharedPtr< SubRenderStateAccessor > SubRenderStateAccessorPtr
virtual void updateGpuProgramsParams(Renderable *rend, Pass *pass, const AutoParamDataSource *source, const LightList *pLightList)
Update GPU programs parameters before a rendering operation occurs.
const SubRenderStateSet & getSubRenderStateInstanceSet() const
Return a set of all instances of the template SubRenderState.
#define _OgreRTSSExport
This class uses as accessor from a template SubRenderState to all of its instances that created based...
Class defining a single pass of a Technique (of a Material), i.e.
Definition: OgrePass.h:80
Abstract class defining the interface all renderable objects must implement.
Class for serializing Materials to / from a .material script.
Abstract factory interface for creating SubRenderState implementation instances.
This abstract node represents a script property.
This is a container class for sub render state class.
SubRenderStateAccessor(const SubRenderState *templateSubRenderState)
Construct SubRenderState accessor based on the given template SubRenderState.
virtual bool preAddToRenderState(RenderState *renderState, Pass *srcPass, Pass *dstPass)
Called before adding this sub render state to the given render state.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
SubRenderStateAccessorPtr mOtherAccessor
SubRenderStateSet::iterator SubRenderStateSetIterator
SubRenderStateSet::const_iterator SubRenderStateSetConstIterator
virtual SubRenderState * createInstance(ScriptCompiler *compiler, PropertyAbstractNode *prop, Pass *pass)
Create an instance of the SubRenderState based on script properties.
vector< SubRenderState * >::type SubRenderStateList
SubRenderStateSet & getSubRenderStateInstanceSet()
Return a set of all instances of the template SubRenderState.
void addSubRenderStateInstance(SubRenderState *subRenderState) const
Add SubRenderState instance to this accessor.
This class is the base interface of sub part from a shader based rendering pipeline.
set< SubRenderState * >::type SubRenderStateSet
SubRenderStateList::iterator SubRenderStateListIterator
_StringBase String
This is the main class for the compiler.
Container class for shader based programs.
SubRenderStateAccessorPtr mThisAccessor
void removeSubRenderStateInstance(SubRenderState *subRenderState) const
Remove SubRenderState instance to this accessor.
virtual void writeInstance(MaterialSerializer *ser, SubRenderState *subRenderState, Pass *srcPass, Pass *dstPass)
Write the given sub-render state instance using the material serializer.
This utility class is used to hold the information used to generate the matrices and other informatio...