libogre-1.8-dev 1.8.1+dfsg-0ubuntu3 / usr / include / OGRE / OgreScriptTranslator.h

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __SCRIPTTRANSLATOR_H_
#define __SCRIPTTRANSLATOR_H_

#include "OgrePrerequisites.h"
#include "OgreScriptCompiler.h"

namespace Ogre{
	/** \addtogroup Core
	*  @{
	*/
	/** \addtogroup General
	*  @{
	*/
	/** This class translates script AST (abstract syntax tree) into
	 *  Ogre resources. It defines a common interface for subclasses
	 *  which perform the actual translation.
	 */

	class _OgreExport ScriptTranslator : public ScriptTranslatorAlloc
	{
	public:
		/**
		 * This function translates the given node into Ogre resource(s).
		 * @param compiler The compiler invoking this translator
		 * @param node The current AST node to be translated
		 */
		virtual void translate(ScriptCompiler *compiler, const AbstractNodePtr &node) = 0;
	protected:
		// needs virtual destructor
		virtual ~ScriptTranslator() {}
		/// Retrieves a new translator from the factories and uses it to process the give node
		void processNode(ScriptCompiler *compiler, const AbstractNodePtr &node);

		/// Retrieves the node iterator at the given index
		static AbstractNodeList::const_iterator getNodeAt(const AbstractNodeList &nodes, int index);
		/// Converts the node to a boolean and returns true if successful
		static bool getBoolean(const AbstractNodePtr &node, bool *result);
		/// Converts the node to a string and returns true if successful
		static bool getString(const AbstractNodePtr &node, String *result);
		/// Converts the node to a Real and returns true if successful
		static bool getReal(const AbstractNodePtr &node, Real *result);
		/// Converts the node to a float and returns true if successful
		static bool getFloat(const AbstractNodePtr &node, float *result);
		/// Converts the node to an integer and returns true if successful
		static bool getInt(const AbstractNodePtr &node, int *result); 
		/// Converts the node to an unsigned integer and returns true if successful
		static bool getUInt(const AbstractNodePtr &node, uint32 *result); 
		/// Converts the range of nodes to a ColourValue and returns true if successful
		static bool getColour(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, ColourValue *result, int maxEntries = 4);
		/// Converts the node to a SceneBlendFactor enum and returns true if successful
		static bool getSceneBlendFactor(const AbstractNodePtr &node, SceneBlendFactor *sbf);
		/// Converts the node to a CompareFunction enum and returns true if successful
		static bool getCompareFunction(const AbstractNodePtr &node, CompareFunction *func);
		/// Converts the range of nodes to a Matrix4 and returns true if successful
		static bool getMatrix4(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, Matrix4 *m);
		/// Converts the range of nodes to an array of ints and returns true if successful
		static bool getInts(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, int *vals, int count);
		/// Converts the range of nodes to an array of floats and returns true if successful
		static bool getFloats(AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, float *vals, int count);
		/// Converts the node to a StencilOperation enum and returns true if successful
		static bool getStencilOp(const AbstractNodePtr &node, StencilOperation *op); 
		/// Converts the node to a GpuConstantType enum and returns true if successful
		static bool getConstantType(AbstractNodeList::const_iterator i, GpuConstantType *op); 

	};

	/** The ScriptTranslatorManager manages the lifetime and access to
	 *  script translators. You register these managers with the
	 *  ScriptCompilerManager tied to specific object types.
	 *  Each manager may manage multiple types.
	 */
	class ScriptTranslatorManager : public ScriptTranslatorAlloc
	{
	public:
		// required - virtual destructor
		virtual ~ScriptTranslatorManager() {}

		/// Returns the number of translators being managed
		virtual size_t getNumTranslators() const = 0;
		/// Returns a manager for the given object abstract node, or null if it is not supported
		virtual ScriptTranslator *getTranslator(const AbstractNodePtr&) = 0;
	};

	/**************************************************************************
	 * Material compilation section
	 *************************************************************************/
	class _OgreExport MaterialTranslator : public ScriptTranslator
	{
	protected:
		Material *mMaterial;
		Ogre::AliasTextureNamePairList mTextureAliases;
	public:
		MaterialTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
		
	class _OgreExport TechniqueTranslator : public ScriptTranslator
	{
	protected:
		Technique *mTechnique;
	public:
		TechniqueTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
	
	class _OgreExport PassTranslator : public ScriptTranslator
	{
	protected:
		Pass *mPass;
	public:
		PassTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	protected:
		void translateVertexProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
		void translateGeometryProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
		void translateFragmentProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
		void translateShadowCasterVertexProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
		void translateShadowCasterFragmentProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
		void translateShadowReceiverVertexProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
		void translateShadowReceiverFragmentProgramRef(ScriptCompiler *compiler, ObjectAbstractNode *node);
	};

	class _OgreExport TextureUnitTranslator : public ScriptTranslator
	{
	protected:
		TextureUnitState *mUnit;
	public:
		TextureUnitTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};

	class _OgreExport TextureSourceTranslator : public ScriptTranslator
	{
	public:
		TextureSourceTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};

	class _OgreExport GpuProgramTranslator : public ScriptTranslator
	{	
	public:
		GpuProgramTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	protected:
		void translateGpuProgram(ScriptCompiler *compiler, ObjectAbstractNode *obj);
		void translateHighLevelGpuProgram(ScriptCompiler *compiler, ObjectAbstractNode *obj);
		void translateUnifiedGpuProgram(ScriptCompiler *compiler, ObjectAbstractNode *obj);
	public:
		static void translateProgramParameters(ScriptCompiler *compiler, GpuProgramParametersSharedPtr params, ObjectAbstractNode *obj);
	};

	class _OgreExport SharedParamsTranslator : public ScriptTranslator
	{	
	public:
		SharedParamsTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	protected:
	};

	/**************************************************************************
	 * Particle System section
	 *************************************************************************/
	class _OgreExport ParticleSystemTranslator : public ScriptTranslator
	{
	protected:
		Ogre::ParticleSystem *mSystem;
	public:
		ParticleSystemTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
	class _OgreExport ParticleEmitterTranslator : public ScriptTranslator
	{
	protected:
		Ogre::ParticleEmitter *mEmitter;
	public:
		ParticleEmitterTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
	class _OgreExport ParticleAffectorTranslator : public ScriptTranslator
	{
	protected:
		Ogre::ParticleAffector *mAffector;
	public:
		ParticleAffectorTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};

	/**************************************************************************
	 * Compositor section
	 *************************************************************************/
	class _OgreExport CompositorTranslator : public ScriptTranslator
	{
	protected:
		Compositor *mCompositor;
	public:
		CompositorTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
	class _OgreExport CompositionTechniqueTranslator : public ScriptTranslator
	{
	protected:
		CompositionTechnique *mTechnique;
	public:
		CompositionTechniqueTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
	class _OgreExport CompositionTargetPassTranslator : public ScriptTranslator
	{
	protected:
		CompositionTargetPass *mTarget;
	public:
		CompositionTargetPassTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};
	class _OgreExport CompositionPassTranslator : public ScriptTranslator
	{
	protected:
		CompositionPass *mPass;
	public:
		CompositionPassTranslator();
		void translate(ScriptCompiler *compiler, const AbstractNodePtr &node);
	};

	/**************************************************************************
	 * BuiltinScriptTranslatorManager
	 *************************************************************************/
	/// This class manages the builtin translators
	class _OgreExport BuiltinScriptTranslatorManager : public ScriptTranslatorManager
	{
	private:
		MaterialTranslator mMaterialTranslator;
		TechniqueTranslator mTechniqueTranslator;
		PassTranslator mPassTranslator;
		TextureUnitTranslator mTextureUnitTranslator;
		TextureSourceTranslator mTextureSourceTranslator;
		GpuProgramTranslator mGpuProgramTranslator;
		SharedParamsTranslator mSharedParamsTranslator;
		ParticleSystemTranslator mParticleSystemTranslator;
		ParticleEmitterTranslator mParticleEmitterTranslator;
		ParticleAffectorTranslator mParticleAffectorTranslator;
		CompositorTranslator mCompositorTranslator;
		CompositionTechniqueTranslator mCompositionTechniqueTranslator;
		CompositionTargetPassTranslator mCompositionTargetPassTranslator;
		CompositionPassTranslator mCompositionPassTranslator;
	public:
		BuiltinScriptTranslatorManager();
		/// Returns the number of translators being managed
		virtual size_t getNumTranslators() const;
		/// Returns a manager for the given object abstract node, or null if it is not supported
		virtual ScriptTranslator *getTranslator(const AbstractNodePtr &node);
	};
	/** @} */
	/** @} */
}


#endif