OGRE: OgreRenderQueueInvocation.h Source File - OGRE Documentation

# OgreRenderQueueInvocation.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2005 The OGRE Team
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __RenderQueueInvocation_H__
    00029 #define __RenderQueueInvocation_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreRenderQueueSortingGrouping.h"
    00033 #include "OgreIteratorWrappers.h"
    00034
    00035 namespace Ogre {
    00036
    00066     class _OgreExport RenderQueueInvocation : public RenderQueueAlloc
    00067     {
    00068     protected:
    00070         uint8 mRenderQueueGroupID;
    00072         String mInvocationName;
    00074         QueuedRenderableCollection::OrganisationMode mSolidsOrganisation;
    00076         bool mSuppressShadows;
    00078         bool mSuppressRenderStateChanges;
    00079     public:
    00085         RenderQueueInvocation(uint8 renderQueueGroupID,
    00086             const String& invocationName = StringUtil::BLANK);
    00087         virtual ~RenderQueueInvocation();
    00088
    00090         virtual uint8 getRenderQueueGroupID(void) const { return mRenderQueueGroupID; }
    00091
    00093         virtual const String& getInvocationName(void) const { return mInvocationName; }
    00094
    00098         virtual void setSolidsOrganisation(
    00099             QueuedRenderableCollection::OrganisationMode org)
    00100         { mSolidsOrganisation = org; }
    00101
    00105         virtual QueuedRenderableCollection::OrganisationMode
    00106             getSolidsOrganisation(void) const { return mSolidsOrganisation; }
    00107
    00113         virtual void setSuppressShadows(bool suppress)
    00114         { mSuppressShadows =  suppress; }
    00115
    00118         virtual bool getSuppressShadows(void) const { return mSuppressShadows; }
    00119
    00140         virtual void setSuppressRenderStateChanges(bool suppress)
    00141         { mSuppressRenderStateChanges =  suppress; }
    00142
    00145         virtual bool getSuppressRenderStateChanges(void) const { return mSuppressRenderStateChanges; }
    00146
    00152         virtual void invoke(RenderQueueGroup* group, SceneManager* targetSceneManager);
    00153
    00155         static String RENDER_QUEUE_INVOCATION_SHADOWS;
    00156     };
    00157
    00158
    00160     typedef vector<RenderQueueInvocation*>::type RenderQueueInvocationList;
    00161     typedef VectorIterator<RenderQueueInvocationList> RenderQueueInvocationIterator;
    00162
    00173     class _OgreExport RenderQueueInvocationSequence : public RenderQueueAlloc
    00174     {
    00175     protected:
    00176         String mName;
    00177         RenderQueueInvocationList mInvocations;
    00178     public:
    00179         RenderQueueInvocationSequence(const String& name);
    00180         virtual ~RenderQueueInvocationSequence();
    00181
    00183         const String& getName(void) const { return mName; }
    00184
    00191         RenderQueueInvocation* add(uint8 renderQueueGroupID,
    00192             const String& invocationName);
    00193
    00200         void add(RenderQueueInvocation* i);
    00201
    00203         size_t size(void) const { return mInvocations.size(); }
    00204
    00206         void clear(void);
    00207
    00209         RenderQueueInvocation* get(size_t index);
    00210
    00212         void remove(size_t index);
    00213
    00215         RenderQueueInvocationIterator iterator(void);
    00216
    00217
    00218     };
    00222 }
    00223
    00224 #endif
    00225

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52