shattered_ogrerb 0.5.0.1

data/vendor/ogrerb/src_headers/OGRE/OgreCompositor.h

@@ -0,0 +1,179 @@
+/*
+-----------------------------------------------------------------------------
+This source file is part of OGRE
+    (Object-oriented Graphics Rendering Engine)
+For the latest info, see http://www.ogre3d.org/
+
+Copyright (c) 2000-2006 Torus Knot Software Ltd
+Also see acknowledgements in Readme.html
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA 02111-1307, USA, or go to
+http://www.gnu.org/copyleft/lesser.txt.
+
+You may alternatively use this source under the terms of a specific version of
+the OGRE Unrestricted License provided you have obtained such a license from
+Torus Knot Software Ltd.
+-----------------------------------------------------------------------------
+*/
+#ifndef __Compositor_H__
+#define __Compositor_H__
+
+#include "OgrePrerequisites.h"
+#include "OgreIteratorWrappers.h"
+#include "OgreResource.h"
+
+namespace Ogre {
+    /** Class representing a Compositor object. Compositors provide the means 
+        to flexibly "composite" the final rendering result from multiple scene renders
+        and intermediate operations like rendering fullscreen quads. This makes 
+        it possible to apply postfilter effects, HDRI postprocessing, and shadow 
+        effects to a Viewport.
+     */
+    class _OgreExport Compositor: public Resource
+    {
+    public:
+        Compositor(ResourceManager* creator, const String& name, ResourceHandle handle,
+            const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
+        ~Compositor();
+        
+        /// Data types for internal lists
+        typedef std::vector<CompositionTechnique *> Techniques;
+        typedef VectorIterator<Techniques> TechniqueIterator;
+        
+        /** Create a new technique, and return a pointer to it.
+        */
+        CompositionTechnique *createTechnique();
+        
+        /** Remove a technique. It will also be destroyed.
+        */
+        void removeTechnique(size_t idx);
+        
+        /** Get a technique.
+        */
+        CompositionTechnique *getTechnique(size_t idx);
+        
+        /** Get the number of techniques.
+        */
+        size_t getNumTechniques();
+        
+        /** Remove all techniques
+        */
+        void removeAllTechniques();
+        
+        /** Get an iterator over the Techniques in this compositor. */
+        TechniqueIterator getTechniqueIterator(void);
+        
+        /** Get a supported technique.
+        @remarks
+            The supported technique list is only available after this compositor has been compiled,
+            which typically happens on loading it. Therefore, if this method returns
+            an empty list, try calling Compositor::load.
+        */
+        CompositionTechnique *getSupportedTechnique(size_t idx);
+        
+        /** Get the number of supported techniques.
+        @remarks
+            The supported technique list is only available after this compositor has been compiled,
+            which typically happens on loading it. Therefore, if this method returns
+            an empty list, try calling Compositor::load.
+        */
+        size_t getNumSupportedTechniques();
+        
+        /** Gets an iterator over all the Techniques which are supported by the current card. 
+        @remarks
+            The supported technique list is only available after this compositor has been compiled,
+            which typically happens on loading it. Therefore, if this method returns
+            an empty list, try calling Compositor::load.
+        */
+        TechniqueIterator getSupportedTechniqueIterator(void);
+    protected:
+        /// @copydoc Resource::loadImpl
+        void loadImpl(void);
+
+        /// @copydoc Resource::unloadImpl
+        void unloadImpl(void);
+        /// @copydoc Resource::calculateSize
+        size_t calculateSize(void) const;
+        
+        /** Check supportedness of techniques.
+         */
+        void compile();
+    private:
+        Techniques mTechniques;
+        Techniques mSupportedTechniques;
+        
+        /// Compilation required
+        /// This is set if the techniques change and the supportedness of techniques has to be
+        /// re-evaluated.
+        bool mCompilationRequired;
+    };
+
+    /** Specialisation of SharedPtr to allow SharedPtr to be assigned to CompositorPtr 
+    @note Has to be a subclass since we need operator=.
+    We could templatise this instead of repeating per Resource subclass, 
+    except to do so requires a form VC6 does not support i.e.
+    ResourceSubclassPtr<T> : public SharedPtr<T>
+    */
+    class _OgreExport CompositorPtr : public SharedPtr<Compositor> 
+    {
+    public:
+        CompositorPtr() : SharedPtr<Compositor>() {}
+        explicit CompositorPtr(Compositor* rep) : SharedPtr<Compositor>(rep) {}
+        CompositorPtr(const CompositorPtr& r) : SharedPtr<Compositor>(r) {} 
+        CompositorPtr(const ResourcePtr& r) : SharedPtr<Compositor>()
+        {
+            // lock & copy other mutex pointer
+            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
+            {
+                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
+                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
+                pRep = static_cast<Compositor*>(r.getPointer());
+                pUseCount = r.useCountPointer();
+                if (pUseCount)
+                {
+                    ++(*pUseCount);
+                }
+            }
+        }
+
+        /// Operator used to convert a ResourcePtr to a CompositorPtr
+        CompositorPtr& operator=(const ResourcePtr& r)
+        {
+            if (pRep == static_cast<Compositor*>(r.getPointer()))
+                return *this;
+            release();
+            // lock & copy other mutex pointer
+            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
+            {
+                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
+                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
+                pRep = static_cast<Compositor*>(r.getPointer());
+                pUseCount = r.useCountPointer();
+                if (pUseCount)
+                {
+                    ++(*pUseCount);
+                }
+            }
+			else
+			{
+				// RHS must be a null pointer
+				assert(r.isNull() && "RHS must be null if it has no mutex!");
+				setNull();
+			}
+            return *this;
+        }
+    };
+}
+
+#endif

data/vendor/ogrerb/src_headers/OGRE/OgreCompositorChain.h

@@ -0,0 +1,208 @@
+/*
+-----------------------------------------------------------------------------
+This source file is part of OGRE
+    (Object-oriented Graphics Rendering Engine)
+For the latest info, see http://www.ogre3d.org/
+
+Copyright (c) 2000-2006 Torus Knot Software Ltd
+Also see acknowledgements in Readme.html
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA 02111-1307, USA, or go to
+http://www.gnu.org/copyleft/lesser.txt.
+
+You may alternatively use this source under the terms of a specific version of
+the OGRE Unrestricted License provided you have obtained such a license from
+Torus Knot Software Ltd.
+-----------------------------------------------------------------------------
+*/
+#ifndef __CompositorChain_H__
+#define __CompositorChain_H__
+
+#include "OgrePrerequisites.h"
+#include "OgreRenderTargetListener.h"
+#include "OgreRenderQueueListener.h"
+#include "OgreCompositorInstance.h"
+#include "OgreCompositor.h"
+namespace Ogre {
+    
+    /** Chain of compositor effects applying to one viewport.
+     */
+    class _OgreExport CompositorChain: public RenderTargetListener
+    {
+    public:
+        CompositorChain(Viewport *vp);
+        /** Another gcc warning here, which is no problem because RenderTargetListener is never used
+            to delete an object.
+            warning: `class Ogre::CompositorChain' has virtual functions but non-virtual destructor
+        */
+        virtual ~CompositorChain();
+        
+        /// Data types
+        typedef std::vector<CompositorInstance*> Instances;
+        typedef VectorIterator<Instances> InstanceIterator;
+        
+        /// Identifier for "last" compositor in chain
+        static const size_t LAST = (size_t)-1;
+        /// Identifier for best technique
+        static const size_t BEST = 0;
+        
+        /** Apply a compositor. Initially, the filter is enabled.
+        @param filter     Filter to apply
+        @param addPosition    Position in filter chain to insert this filter at; defaults to the end (last applied filter)
+        @param technique      Technique to use; CompositorChain::BEST (default) chooses to the best one 
+                            available (first technique supported)
+        */
+        CompositorInstance* addCompositor(CompositorPtr filter, size_t addPosition=LAST, size_t technique=BEST);
+    
+        /** Remove a compositor.
+        @param position    Position in filter chain of filter to remove; defaults to the end (last applied filter)
+        */
+        void removeCompositor(size_t position=LAST);
+        
+        /** Get the number of compositors.
+        */
+        size_t getNumCompositors();
+        
+        /** Remove all compositors.
+        */
+        void removeAllCompositors();
+        
+        /** Get compositor instance by position.
+         */
+        CompositorInstance *getCompositor(size_t index);
+
+		/** Get the original scene compositor instance for this chain (internal use). 
+		*/
+		CompositorInstance* _getOriginalSceneCompositor(void) { return mOriginalScene; }
+    
+        /** Get an iterator over the compositor instances. The first compositor in this list is applied first, the last one is applied last.
+        */
+        InstanceIterator getCompositors();
+    
+        /** Enable or disable a compositor, by position. Disabling a compositor stops it from rendering
+            but does not free any resources. This can be more efficient than using removeCompositor and 
+			addCompositor in cases the filter is switched on and off a lot.
+        @param position    Position in filter chain of filter
+        */
+        void setCompositorEnabled(size_t position, bool state);
+    
+        /** @see RenderTargetListener::preRenderTargetUpdate */
+		virtual void preRenderTargetUpdate(const RenderTargetEvent& evt);
+		/** @see RenderTargetListener::preViewportUpdate */
+        virtual void preViewportUpdate(const RenderTargetViewportEvent& evt);
+        /** @see RenderTargetListener::postViewportUpdate */
+        virtual void postViewportUpdate(const RenderTargetViewportEvent& evt);
+		/** @see RenderTargetListener::viewportRemoved */
+		virtual void viewportRemoved(const RenderTargetViewportEvent& evt);
+        
+        /** Mark state as dirty, and to be recompiled next frame.
+         */
+        void _markDirty();
+        
+        /** Get viewport that is the target of this chain
+         */
+        Viewport *getViewport();
+
+		/** Remove a compositor by pointer. This is internally used by CompositionTechnique to
+			"weak" remove any instanced of a deleted technique.
+        */
+        void _removeInstance(CompositorInstance *i);
+
+		/** Internal method for registering a queued operation for deletion later **/
+		void _queuedOperation(CompositorInstance::RenderSystemOperation* op);
+
+		/** Compile this Composition chain into a series of RenderTarget operations.
+		*/
+		void _compile();
+    protected:    
+        /// Viewport affected by this CompositorChain
+        Viewport *mViewport;
+        
+        /** Plainly renders the scene; implicit first compositor in the chain.
+        */
+        CompositorInstance *mOriginalScene;
+        
+        /// Postfilter instances in this chain
+        Instances mInstances;
+        
+        /// State needs recompile
+        bool mDirty;
+		/// Any compositors enabled?
+		bool mAnyCompositorsEnabled;
+
+        /// Compiled state (updated with _compile)
+        CompositorInstance::CompiledState mCompiledState;
+        CompositorInstance::TargetOperation mOutputOperation;
+		/// Render System operations queued by last compile, these are created by this
+		/// instance thus managed and deleted by it. The list is cleared with 
+		/// clearCompilationState()
+		typedef std::vector<CompositorInstance::RenderSystemOperation*> RenderSystemOperations;
+		RenderSystemOperations mRenderSystemOperations;
+
+        
+		/** Clear compiled state */
+		void clearCompiledState();
+        
+        /** Prepare a viewport, the camera and the scene for a rendering operation
+         */
+        void preTargetOperation(CompositorInstance::TargetOperation &op, Viewport *vp, Camera *cam);
+        
+        /** Restore a viewport, the camera and the scene after a rendering operation
+         */
+        void postTargetOperation(CompositorInstance::TargetOperation &op, Viewport *vp, Camera *cam);
+
+		/// destroy internal resources
+		void destroyResources(void);
+
+		/** Render queue listener used to set up rendering events. */
+		class RQListener: public RenderQueueListener
+		{
+		public:
+			/** @copydoc RenderQueueListener::renderQueueStarted
+			*/
+			virtual void renderQueueStarted(uint8 id, const String& invocation, bool& skipThisQueue);
+			/** @copydoc RenderQueueListener::renderQueueEnded
+			*/
+			virtual void renderQueueEnded(uint8 id, const String& invocation, bool& repeatThisQueue);
+
+			/** Set current operation and target */
+			void setOperation(CompositorInstance::TargetOperation *op,SceneManager *sm,RenderSystem *rs);
+
+			/** Notify current destination viewport  */
+			void notifyViewport(Viewport* vp) { mViewport = vp; }
+
+			/** Flush remaining render system operations */
+			void flushUpTo(uint8 id);
+		private:
+			CompositorInstance::TargetOperation *mOperation;
+			SceneManager *mSceneManager;
+			RenderSystem *mRenderSystem;
+			Viewport* mViewport;
+			CompositorInstance::RenderSystemOpPairs::iterator currentOp, lastOp;
+		};
+		RQListener mOurListener;
+		/// Old viewport settings
+		unsigned int mOldClearEveryFrameBuffers;
+		/// Store old scene visibility mask
+		uint32 mOldVisibilityMask;
+		/// Store old find visible objects
+		bool mOldFindVisibleObjects;
+        /// Store old camera LOD bias      
+        float mOldLodBias;     
+		///	Store old viewport material scheme
+		String mOldMaterialScheme;
+    };
+}
+
+#endif

data/vendor/ogrerb/src_headers/OGRE/OgreCompositorInstance.h

@@ -0,0 +1,262 @@
+/*
+-----------------------------------------------------------------------------
+This source file is part of OGRE
+    (Object-oriented Graphics Rendering Engine)
+For the latest info, see http://www.ogre3d.org/
+
+Copyright (c) 2000-2006 Torus Knot Software Ltd
+Also see acknowledgements in Readme.html
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA 02111-1307, USA, or go to
+http://www.gnu.org/copyleft/lesser.txt.
+
+You may alternatively use this source under the terms of a specific version of
+the OGRE Unrestricted License provided you have obtained such a license from
+Torus Knot Software Ltd.
+-----------------------------------------------------------------------------
+*/
+#ifndef __CompositorInstance_H__
+#define __CompositorInstance_H__
+
+#include "OgrePrerequisites.h"
+#include "OgreMaterial.h"
+#include "OgreTexture.h"
+#include "OgreRenderQueue.h"
+namespace Ogre {
+    const size_t RENDER_QUEUE_COUNT = RENDER_QUEUE_OVERLAY+1;       
+            
+    /** An instance of a Compositor object for one Viewport. It is part of the CompositorChain
+		for a Viewport.
+     */
+    class _OgreExport CompositorInstance
+    {
+    public:
+        CompositorInstance(Compositor *filter, CompositionTechnique *technique, CompositorChain *chain);
+        virtual ~CompositorInstance();
+		/** Provides an interface to "listen in" to to render system operations executed by this 
+			CompositorInstance.
+		*/
+		class _OgreExport Listener
+		{
+		public:
+			virtual ~Listener();
+
+			/** Notification of when a render target operation involving a material (like
+				rendering a quad) is compiled, so that miscelleneous parameters that are different
+				per Compositor instance can be set up.
+				@param pass_id	Pass identifier within Compositor instance, this is speficied 
+								by the user by CompositionPass::setIdentifier().
+				@param mat		Material, this may be changed at will and will only affect
+								the current instance of the Compositor, not the global material
+								it was cloned from.
+			 */
+			virtual void notifyMaterialSetup(uint32 pass_id, MaterialPtr &mat);
+
+			/** Notification before a render target operation involving a material (like
+				rendering a quad), so that material parameters can be varied.
+				@param pass_id	Pass identifier within Compositor instance, this is speficied 
+								by the user by CompositionPass::setIdentifier().
+				@param mat		Material, this may be changed at will and will only affect
+								the current instance of the Compositor, not the global material
+								it was cloned from.
+			 */
+			virtual void notifyMaterialRender(uint32 pass_id, MaterialPtr &mat);
+		};
+        /** Specific render system operation. A render target operation does special operations
+		    between render queues like rendering a quad, clearing the frame buffer or 
+			setting stencil state.
+		*/
+		class RenderSystemOperation
+		{
+		public:
+			virtual ~RenderSystemOperation();
+			/// Set state to SceneManager and RenderSystem
+			virtual void execute(SceneManager *sm, RenderSystem *rs) = 0;
+		};
+		typedef std::map<int, MaterialPtr> QuadMaterialMap;
+		typedef std::pair<int, RenderSystemOperation*> RenderSystemOpPair;
+		typedef std::vector<RenderSystemOpPair> RenderSystemOpPairs;
+        /** Operation setup for a RenderTarget (collected).
+        */
+        class TargetOperation
+        {
+        public:
+            TargetOperation()
+            { 
+            }
+            TargetOperation(RenderTarget *target):
+                target(target), currentQueueGroupID(0), visibilityMask(0xFFFFFFFF),
+                lodBias(1.0f),
+                onlyInitial(false), hasBeenRendered(false), findVisibleObjects(false)
+            { 
+            }
+            /// Target
+            RenderTarget *target;
+
+			/// Current group ID
+			int currentQueueGroupID;
+
+			/// RenderSystem operations to queue into the scene manager, by
+			/// uint8
+			RenderSystemOpPairs renderSystemOperations;
+
+			/// Scene visibility mask
+            /// If this is 0, the scene is not rendered at all
+            uint32 visibilityMask;
+            
+            /// LOD offset. This is multiplied with the camera LOD offset
+            /// 1.0 is default, lower means lower detail, higher means higher detail
+            float lodBias;
+            
+            /** A set of render queues to either include or exclude certain render queues.
+	 		*/
+            typedef std::bitset<RENDER_QUEUE_COUNT> RenderQueueBitSet;
+
+			/// Which renderqueues to render from scene
+			RenderQueueBitSet renderQueues;
+            
+            /** @see CompositionTargetPass::mOnlyInitial
+            */
+            bool onlyInitial;
+            /** "Has been rendered" flag; used in combination with
+                onlyInitial to determine whether to skip this target operation.
+            */
+            bool hasBeenRendered;
+            /** Whether this op needs to find visible scene objects or not 
+            */
+            bool findVisibleObjects;
+			/** Which material scheme this op will use */
+			String materialScheme;
+        };
+        typedef std::vector<TargetOperation> CompiledState;
+        
+        /** Set enabled flag. The compositor instance will only render if it is
+            enabled, otherwise it is pass-through.
+        */
+        void setEnabled(bool value);
+        
+        /** Get enabled flag.
+        */
+        bool getEnabled();
+
+		/** Get the instance name for a local texture.
+		@note It is only valid to call this when local textures have been loaded, 
+			which in practice means that the compositor instance is active. Calling
+			it at other times will cause an exception. Note that since textures
+			are cleaned up aggressively, this name is not guaranteed to stay the
+			same if you disable and renable the compositor instance.
+		@param name The name of the texture in the original compositor definition
+		@returns The instance name for the texture, corresponds to a real texture
+		*/
+		const String& getTextureInstanceName(const String& name);
+
+       
+        /** Recursively collect target states (except for final Pass).
+            @param compiledState    This vector will contain a list of TargetOperation objects
+        */
+        virtual void _compileTargetOperations(CompiledState &compiledState);
+        
+        /** Compile the final (output) operation. This is done seperately because this
+            is combined with the input in chained filters.
+        */
+        virtual void _compileOutputOperation(TargetOperation &finalState);
+        
+        /** Get Compositor of which this is an instance
+        */
+        Compositor *getCompositor();
+        
+        /** Get CompositionTechnique used by this instance
+        */
+        CompositionTechnique *getTechnique();
+
+		/** Get Chain that this instance is part of
+        */
+        CompositorChain *getChain();
+
+		/** Add a listener. Listeners provide an interface to "listen in" to to render system 
+			operations executed by this CompositorInstance so that materials can be 
+			programmatically set up.
+			@see CompositorInstance::Listener
+		*/
+		void addListener(Listener *l);
+
+		/** Remove a listener.
+			@see CompositorInstance::Listener
+		*/
+		void removeListener(Listener *l);
+
+		/** Notify listeners of a material compilation.
+		*/
+		void _fireNotifyMaterialSetup(uint32 pass_id, MaterialPtr &mat);
+
+		/** Notify listeners of a material render.
+		*/
+		void _fireNotifyMaterialRender(uint32 pass_id, MaterialPtr &mat);
+	private:
+        /// Compositor of which this is an instance
+        Compositor *mCompositor;
+        /// Composition technique used by this instance
+        CompositionTechnique *mTechnique;
+        /// Composition chain of which this instance is part
+        CompositorChain *mChain;
+        /// Is this instance enabled?
+        bool mEnabled;
+        /// Map from name->local texture
+        typedef std::map<String,TexturePtr> LocalTextureMap;
+        LocalTextureMap mLocalTextures;
+
+		/// Vector of listeners
+		typedef std::vector<Listener*> Listeners;
+		Listeners mListeners;
+        
+        /// Previous instance (set by chain)
+        CompositorInstance *mPreviousInstance;
+		
+		/** Collect rendering passes. Here, passes are converted into render target operations
+			and queued with queueRenderSystemOp.
+        */
+        virtual void collectPasses(TargetOperation &finalState, CompositionTargetPass *target);
+        
+        /** Create a local dummy material with one technique but no passes.
+            The material is detached from the Material Manager to make sure it is destroyed
+			when going out of scope.
+        */
+        MaterialPtr createLocalMaterial();
+        
+        /** Create local rendertextures and other resources. Builds mLocalTextures.
+        */
+        void createResources();
+        
+        /** Destroy local rendertextures and other resources.
+        */
+        void freeResources();
+
+        /** Get RenderTarget for a named local texture.
+        */
+        RenderTarget *getTargetForTex(const String &name);
+        
+        /** Get source texture name for a named local texture.
+        */
+        const String &getSourceForTex(const String &name);
+
+		/** Queue a render system operation.
+			@returns destination pass
+		 */
+		void queueRenderSystemOp(TargetOperation &finalState, RenderSystemOperation *op);
+        
+        friend class CompositorChain;
+    };
+}
+
+#endif