Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

OgreCompositionTargetPass.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-2006 Torus Knot Software Ltd
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 
00024 You may alternatively use this source under the terms of a specific version of
00025 the OGRE Unrestricted License provided you have obtained such a license from
00026 Torus Knot Software Ltd.
00027 -----------------------------------------------------------------------------
00028 */
00029 #ifndef __CompositionTargetPass_H__
00030 #define __CompositionTargetPass_H__
00031 
00032 #include "OgrePrerequisites.h"
00033 #include "OgreIteratorWrappers.h"
00034 
00035 namespace Ogre {
00039     class _OgreExport CompositionTargetPass
00040     {
00041     public:
00042         CompositionTargetPass(CompositionTechnique *parent);
00043         ~CompositionTargetPass();
00044         
00047         enum InputMode
00048         {
00049             IM_NONE,        // No input
00050             IM_PREVIOUS     // Output of previous Composition in chain
00051         };
00052         typedef std::vector<CompositionPass *> Passes;
00053         typedef VectorIterator<Passes> PassIterator;
00054         
00057         void setInputMode(InputMode mode);
00059         InputMode getInputMode() const;
00060         
00062         void setOutputName(const String &out);
00064         const String &getOutputName() const;
00065         
00069         void setOnlyInitial(bool value);
00072         bool getOnlyInitial();
00073         
00076         void setVisibilityMask(uint32 mask);
00079         uint32 getVisibilityMask();
00080 
00087         void setMaterialScheme(const String& schemeName);
00094         const String& getMaterialScheme(void) const;
00095         
00099         void setLodBias(float bias);
00102         float getLodBias();
00103         
00106         CompositionPass *createPass();
00109         void removePass(size_t idx);
00112         CompositionPass *getPass(size_t idx);
00115         size_t getNumPasses();
00116         
00119         void removeAllPasses();
00120     
00122         PassIterator getPassIterator(void);
00123         
00125         CompositionTechnique *getParent();
00126 
00129         bool _isSupported(void);
00130 
00131     private:
00133         CompositionTechnique *mParent;
00135         InputMode mInputMode;
00137         String mOutputName;
00139         Passes mPasses;
00142         bool mOnlyInitial;
00144         uint32 mVisibilityMask;
00146         float mLodBias;
00148         String mMaterialScheme;
00149     };
00150 
00151 }
00152 
00153 #endif

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 25 13:03:13 2007