OgreScriptTranslator.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-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 
29 #ifndef __SCRIPTTRANSLATOR_H_
30 #define __SCRIPTTRANSLATOR_H_
31 
32 #include "OgrePrerequisites.h"
33 #include "OgreScriptCompiler.h"
34 #include "OgreHeaderPrefix.h"
35 
36 namespace Ogre{
49  {
50  public:
56  virtual void translate(ScriptCompiler *compiler, const AbstractNodePtr &node) = 0;
57  protected:
58  // needs virtual destructor
59  virtual ~ScriptTranslator() {}
61  void processNode(ScriptCompiler *compiler, const AbstractNodePtr &node);
62 
64  static AbstractNodeList::const_iterator getNodeAt(const AbstractNodeList &nodes, int index);
66  static bool getBoolean(const AbstractNodePtr &node, bool *result);
68  static bool getString(const AbstractNodePtr &node, String *result);
70  static bool getReal(const AbstractNodePtr &node, Real *result);
72  static bool getFloat(const AbstractNodePtr &node, float *result);
74  static bool getInt(const AbstractNodePtr &node, int *result);
76  static bool getUInt(const AbstractNodePtr &node, uint32 *result);
78  static bool getColour(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, ColourValue *result, int maxEntries = 4);
80  static bool getSceneBlendFactor(const AbstractNodePtr &node, SceneBlendFactor *sbf);
82  static bool getCompareFunction(const AbstractNodePtr &node, CompareFunction *func);
84  static bool getMatrix4(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, Matrix4 *m);
86  static bool getInts(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, int *vals, int count);
88  static bool getFloats(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, float *vals, int count);
90  static bool getStencilOp(const AbstractNodePtr &node, StencilOperation *op);
92  static bool getConstantType(AbstractNodeList::const_iterator i, GpuConstantType *op);
93 
94  };
95 
102  {
103  public:
104  // required - virtual destructor
106 
108  virtual size_t getNumTranslators() const = 0;
111  };
112 
113  /**************************************************************************
114  * Material compilation section
115  *************************************************************************/
117  {
118  protected:
121  public:
123  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
124  };
125 
127  {
128  protected:
130  public:
132  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
133  };
134 
136  {
137  protected:
139  public:
141  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
142  protected:
153  };
154 
156  {
157  protected:
159  public:
161  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
162  };
163 
165  {
166  public:
168  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
169  };
170 
172  {
173  public:
175  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
176  protected:
180  public:
182  };
183 
185  {
186  public:
188  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
189  protected:
190  };
191 
192  /**************************************************************************
193  * Particle System section
194  *************************************************************************/
196  {
197  protected:
199  public:
201  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
202  };
204  {
205  protected:
207  public:
209  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
210  };
212  {
213  protected:
215  public:
217  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
218  };
219 
220  /**************************************************************************
221  * Compositor section
222  *************************************************************************/
224  {
225  protected:
227  public:
229  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
230  };
232  {
233  protected:
235  public:
237  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
238  };
240  {
241  protected:
243  public:
245  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
246  };
248  {
249  protected:
251  public:
253  void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
254  };
255 
256  /**************************************************************************
257  * BuiltinScriptTranslatorManager
258  *************************************************************************/
261  {
262  private:
277  public:
280  virtual size_t getNumTranslators() const;
283  };
286 }
287 
288 #include "OgreHeaderSuffix.h"
289 
290 #endif
291 
OgreHeaderSuffix.h
Ogre::CompositorTranslator
Definition: OgreScriptTranslator.h:224
OgreScriptCompiler.h
Ogre::ParticleAffectorTranslator::ParticleAffectorTranslator
ParticleAffectorTranslator()
Ogre::CompositionPassTranslator::mPass
CompositionPass * mPass
Definition: OgreScriptTranslator.h:250
Ogre::ParticleEmitterTranslator
Definition: OgreScriptTranslator.h:204
Ogre::TextureUnitState
Class representing the state of a single texture unit during a Pass of a Technique,...
Definition: OgreTextureUnitState.h:63
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre::ScriptTranslator::getFloats
static bool getFloats(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, float *vals, int count)
Converts the range of nodes to an array of floats and returns true if successful.
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::ScriptTranslator
This class translates script AST (abstract syntax tree) into Ogre resources.
Definition: OgreScriptTranslator.h:49
Ogre::TextureUnitTranslator::mUnit
TextureUnitState * mUnit
Definition: OgreScriptTranslator.h:158
Ogre::BuiltinScriptTranslatorManager::BuiltinScriptTranslatorManager
BuiltinScriptTranslatorManager()
Ogre::MaterialTranslator
Definition: OgreScriptTranslator.h:117
Ogre::Compositor
Class representing a Compositor object.
Definition: OgreCompositor.h:51
Ogre::BuiltinScriptTranslatorManager::mTechniqueTranslator
TechniqueTranslator mTechniqueTranslator
Definition: OgreScriptTranslator.h:264
Ogre::GpuProgramTranslator::GpuProgramTranslator
GpuProgramTranslator()
Ogre::BuiltinScriptTranslatorManager::mCompositionPassTranslator
CompositionPassTranslator mCompositionPassTranslator
Definition: OgreScriptTranslator.h:276
Ogre::CompositionPass
Object representing one pass or operation in a composition sequence.
Definition: OgreCompositionPass.h:48
Ogre::CompositionTechniqueTranslator::mTechnique
CompositionTechnique * mTechnique
Definition: OgreScriptTranslator.h:234
Ogre::ScriptTranslator::processNode
void processNode(ScriptCompiler *compiler, const AbstractNodePtr &node)
Retrieves a new translator from the factories and uses it to process the give node.
Ogre::CompositionTargetPassTranslator::CompositionTargetPassTranslator
CompositionTargetPassTranslator()
Ogre::PassTranslator::PassTranslator
PassTranslator()
Ogre::BuiltinScriptTranslatorManager::mTextureUnitTranslator
TextureUnitTranslator mTextureUnitTranslator
Definition: OgreScriptTranslator.h:266
Ogre::BuiltinScriptTranslatorManager::getNumTranslators
virtual size_t getNumTranslators() const
Returns the number of translators being managed.
Ogre::PassTranslator::translateComputeProgramRef
void translateComputeProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::GpuProgramTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::BuiltinScriptTranslatorManager
This class manages the builtin translators.
Definition: OgreScriptTranslator.h:261
Ogre::BuiltinScriptTranslatorManager::mPassTranslator
PassTranslator mPassTranslator
Definition: OgreScriptTranslator.h:265
Ogre::CompositionPassTranslator
Definition: OgreScriptTranslator.h:248
Ogre::CompositionPassTranslator::CompositionPassTranslator
CompositionPassTranslator()
Ogre::MaterialTranslator::mMaterial
Material * mMaterial
Definition: OgreScriptTranslator.h:119
Ogre::CompositorTranslator::mCompositor
Compositor * mCompositor
Definition: OgreScriptTranslator.h:226
Ogre::Material
Class encapsulates rendering properties of an object.
Definition: OgreMaterial.h:89
Ogre::CompositionTargetPassTranslator::mTarget
CompositionTargetPass * mTarget
Definition: OgreScriptTranslator.h:242
Ogre::BuiltinScriptTranslatorManager::getTranslator
virtual ScriptTranslator * getTranslator(const AbstractNodePtr &node)
Returns a manager for the given object abstract node, or null if it is not supported.
Ogre::ParticleSystemTranslator::mSystem
Ogre::ParticleSystem * mSystem
Definition: OgreScriptTranslator.h:198
Ogre::ParticleSystemTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::ObjectAbstractNode
This specific abstract node represents a script object.
Definition: OgreScriptCompiler.h:124
Ogre::BuiltinScriptTranslatorManager::mMaterialTranslator
MaterialTranslator mMaterialTranslator
Definition: OgreScriptTranslator.h:263
Ogre::BuiltinScriptTranslatorManager::mParticleEmitterTranslator
ParticleEmitterTranslator mParticleEmitterTranslator
Definition: OgreScriptTranslator.h:271
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::CompositorTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::SharedParamsTranslator
Definition: OgreScriptTranslator.h:185
Ogre::GpuProgramTranslator::translateProgramParameters
static void translateProgramParameters(ScriptCompiler *compiler, GpuProgramParametersSharedPtr params, ObjectAbstractNode *obj)
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::PassTranslator::translateTesselationHullProgramRef
void translateTesselationHullProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::ParticleSystemTranslator::ParticleSystemTranslator
ParticleSystemTranslator()
Ogre::Pass
Class defining a single pass of a Technique (of a Material), i.e.
Definition: OgrePass.h:81
Ogre::PassTranslator::translateShadowReceiverFragmentProgramRef
void translateShadowReceiverFragmentProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::GpuProgramTranslator::translateUnifiedGpuProgram
void translateUnifiedGpuProgram(ScriptCompiler *compiler, ObjectAbstractNode *obj)
Ogre::Technique
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:54
Ogre::CompositionTechnique
Base composition technique, can be subclassed in plugins.
Definition: OgreCompositionTechnique.h:46
Ogre::GpuProgramTranslator::translateHighLevelGpuProgram
void translateHighLevelGpuProgram(ScriptCompiler *compiler, ObjectAbstractNode *obj)
Ogre::ScriptTranslatorManager::~ScriptTranslatorManager
virtual ~ScriptTranslatorManager()
Definition: OgreScriptTranslator.h:105
Ogre::CompareFunction
CompareFunction
Comparison functions used for the depth/stencil buffer operations and others.
Definition: OgreCommon.h:65
Ogre::BuiltinScriptTranslatorManager::mTextureSourceTranslator
TextureSourceTranslator mTextureSourceTranslator
Definition: OgreScriptTranslator.h:267
Ogre::ParticleAffectorTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::PassTranslator::translateFragmentProgramRef
void translateFragmentProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::ScriptTranslator::getMatrix4
static bool getMatrix4(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, Matrix4 *m)
Converts the range of nodes to a Matrix4 and returns true if successful.
Ogre::StencilOperation
StencilOperation
Enum describing the various actions which can be taken on the stencil buffer.
Definition: OgreRenderSystem.h:82
Ogre::PassTranslator::translateVertexProgramRef
void translateVertexProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::ScriptTranslator::translate
virtual void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)=0
This function translates the given node into Ogre resource(s).
OgreHeaderPrefix.h
Ogre::Matrix4
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:79
Ogre::TextureSourceTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::PassTranslator::mPass
Pass * mPass
Definition: OgreScriptTranslator.h:138
Ogre::SceneBlendFactor
SceneBlendFactor
Blending factors for manually blending objects with the scene.
Definition: OgreBlendMode.h:235
Ogre::PassTranslator::translateShadowReceiverVertexProgramRef
void translateShadowReceiverVertexProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::GpuProgramTranslator
Definition: OgreScriptTranslator.h:172
Ogre::CompositionTargetPassTranslator
Definition: OgreScriptTranslator.h:240
Ogre::TextureUnitTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::CompositionTargetPass
Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework.
Definition: OgreCompositionTargetPass.h:46
OgrePrerequisites.h
Ogre::PassTranslator::translateShadowCasterVertexProgramRef
void translateShadowCasterVertexProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::MaterialTranslator::mTextureAliases
Ogre::AliasTextureNamePairList mTextureAliases
Definition: OgreScriptTranslator.h:120
Ogre::ScriptCompiler
This is the main class for the compiler.
Definition: OgreScriptCompiler.h:189
Ogre::ScriptTranslatorManager
The ScriptTranslatorManager manages the lifetime and access to script translators.
Definition: OgreScriptTranslator.h:102
Ogre::TextureUnitTranslator::TextureUnitTranslator
TextureUnitTranslator()
Ogre::CompositionTechniqueTranslator::CompositionTechniqueTranslator
CompositionTechniqueTranslator()
Ogre::PassTranslator
Definition: OgreScriptTranslator.h:136
Ogre::SharedParamsTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::ParticleSystemTranslator
Definition: OgreScriptTranslator.h:196
Ogre::AliasTextureNamePairList
map< String, String >::type AliasTextureNamePairList
Alias / Texture name pair (first = alias, second = texture name)
Definition: OgreCommon.h:553
Ogre::PassTranslator::translateTesselationDomainProgramRef
void translateTesselationDomainProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::PassTranslator::translateGeometryProgramRef
void translateGeometryProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::MaterialTranslator::MaterialTranslator
MaterialTranslator()
Ogre::SharedParamsTranslator::SharedParamsTranslator
SharedParamsTranslator()
Ogre::BuiltinScriptTranslatorManager::mGpuProgramTranslator
GpuProgramTranslator mGpuProgramTranslator
Definition: OgreScriptTranslator.h:268
Ogre::BuiltinScriptTranslatorManager::mParticleAffectorTranslator
ParticleAffectorTranslator mParticleAffectorTranslator
Definition: OgreScriptTranslator.h:272
Ogre::PassTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::ScriptTranslator::getSceneBlendFactor
static bool getSceneBlendFactor(const AbstractNodePtr &node, SceneBlendFactor *sbf)
Converts the node to a SceneBlendFactor enum and returns true if successful.
Ogre::BuiltinScriptTranslatorManager::mParticleSystemTranslator
ParticleSystemTranslator mParticleSystemTranslator
Definition: OgreScriptTranslator.h:270
Ogre::ParticleEmitter
Abstract class defining the interface to be implemented by particle emitters.
Definition: OgreParticleEmitter.h:73
Ogre::CompositionPassTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::ParticleEmitterTranslator::ParticleEmitterTranslator
ParticleEmitterTranslator()
Ogre::SharedPtr
Reference-counted shared pointer, used for objects where implicit destruction is required.
Definition: OgreSharedPtr.h:112
Ogre::BuiltinScriptTranslatorManager::mCompositionTargetPassTranslator
CompositionTargetPassTranslator mCompositionTargetPassTranslator
Definition: OgreScriptTranslator.h:275
Ogre::CompositionTechniqueTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::GpuConstantType
GpuConstantType
Enumeration of the types of constant we may encounter in programs.
Definition: OgreGpuProgramParams.h:55
Ogre::ScriptTranslator::getStencilOp
static bool getStencilOp(const AbstractNodePtr &node, StencilOperation *op)
Converts the node to a StencilOperation enum and returns true if successful.
Ogre::BuiltinScriptTranslatorManager::mCompositionTechniqueTranslator
CompositionTechniqueTranslator mCompositionTechniqueTranslator
Definition: OgreScriptTranslator.h:274
Ogre::TechniqueTranslator::mTechnique
Technique * mTechnique
Definition: OgreScriptTranslator.h:129
Ogre::PassTranslator::translateShadowCasterFragmentProgramRef
void translateShadowCasterFragmentProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node)
Ogre::TechniqueTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::ColourValue
Class representing colour.
Definition: OgreColourValue.h:58
Ogre::ParticleAffectorTranslator
Definition: OgreScriptTranslator.h:212
Ogre::ScriptTranslator::getCompareFunction
static bool getCompareFunction(const AbstractNodePtr &node, CompareFunction *func)
Converts the node to a CompareFunction enum and returns true if successful.
Ogre::AbstractNodeList
list< AbstractNodePtr >::type AbstractNodeList
Definition: OgreScriptCompiler.h:88
Ogre::TextureUnitTranslator
Definition: OgreScriptTranslator.h:156
Ogre::CompositorTranslator::CompositorTranslator
CompositorTranslator()
Ogre::ParticleEmitterTranslator::mEmitter
Ogre::ParticleEmitter * mEmitter
Definition: OgreScriptTranslator.h:206
Ogre::ParticleSystem
Class defining particle system based special effects.
Definition: OgreParticleSystem.h:68
Ogre::ScriptTranslator::~ScriptTranslator
virtual ~ScriptTranslator()
Definition: OgreScriptTranslator.h:59
Ogre::ScriptTranslatorManager::getTranslator
virtual ScriptTranslator * getTranslator(const AbstractNodePtr &)=0
Returns a manager for the given object abstract node, or null if it is not supported.
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::ParticleAffectorTranslator::mAffector
Ogre::ParticleAffector * mAffector
Definition: OgreScriptTranslator.h:214
Ogre::ScriptTranslator::getInts
static bool getInts(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, int *vals, int count)
Converts the range of nodes to an array of ints and returns true if successful.
Ogre::BuiltinScriptTranslatorManager::mSharedParamsTranslator
SharedParamsTranslator mSharedParamsTranslator
Definition: OgreScriptTranslator.h:269
Ogre::ScriptTranslator::getConstantType
static bool getConstantType(AbstractNodeList::const_iterator i, GpuConstantType *op)
Converts the node to a GpuConstantType enum and returns true if successful.
Ogre::TechniqueTranslator::TechniqueTranslator
TechniqueTranslator()
Ogre::TextureSourceTranslator::TextureSourceTranslator
TextureSourceTranslator()
Ogre::ParticleAffector
Abstract class defining the interface to be implemented by particle affectors.
Definition: OgreParticleAffector.h:65
Ogre::TextureSourceTranslator
Definition: OgreScriptTranslator.h:165
Ogre::MaterialTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::ScriptTranslatorManager::getNumTranslators
virtual size_t getNumTranslators() const =0
Returns the number of translators being managed.
Ogre::ParticleEmitterTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::GpuProgramTranslator::translateGpuProgram
void translateGpuProgram(ScriptCompiler *compiler, ObjectAbstractNode *obj)
Ogre::CompositionTargetPassTranslator::translate
void translate(ScriptCompiler *compiler, const AbstractNodePtr &node)
This function translates the given node into Ogre resource(s).
Ogre::CompositionTechniqueTranslator
Definition: OgreScriptTranslator.h:232
Ogre::TechniqueTranslator
Definition: OgreScriptTranslator.h:127
Ogre::ScriptTranslator::getNodeAt
static AbstractNodeList::const_iterator getNodeAt(const AbstractNodeList &nodes, int index)
Retrieves the node iterator at the given index.
Ogre::BuiltinScriptTranslatorManager::mCompositorTranslator
CompositorTranslator mCompositorTranslator
Definition: OgreScriptTranslator.h:273

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.