OgreViewport.h

Go to the documentation of this file.

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

Copyright (c) 2000-2005 The OGRE Team
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.
-----------------------------------------------------------------------------
*/
#ifndef __Viewport_H__
#define __Viewport_H__

#include "OgrePrerequisites.h"
#include "OgreCommon.h"
#include "OgreColourValue.h"

namespace Ogre {
    class _OgreExport Viewport
    {
    public:
        Viewport(
            Camera* camera,
            RenderTarget* target,
            Real left, Real top,
            Real width, Real height,
            int ZOrder);

        virtual ~Viewport();

        void _updateDimensions(void);

        void update(void);

        RenderTarget* getTarget(void) const;

        Camera* getCamera(void) const;

        void setCamera(Camera* cam);

        int getZOrder(void) const;
        Real getLeft(void) const;

        Real getTop(void) const;

        Real getWidth(void) const;
        Real getHeight(void) const;
        int getActualLeft(void) const;
        int getActualTop(void) const;
        int getActualWidth(void) const;
        int getActualHeight(void) const;

        void setDimensions(Real left, Real top, Real width, Real height);

        void setBackgroundColour(const ColourValue& colour);

        const ColourValue& getBackgroundColour(void) const;

        void setClearEveryFrame(bool clear, unsigned int buffers = FBT_COLOUR | FBT_DEPTH);

        bool getClearEveryFrame(void) const;

        unsigned int getClearBuffers(void) const;

        void setMaterialScheme(const String& schemeName)
        { mMaterialSchemeName = schemeName; }
        
        const String& getMaterialScheme(void) const
        { return mMaterialSchemeName; }

        void getActualDimensions(
            int &left, int &top, int &width, int &height ) const;

        bool _isUpdated(void) const;
        void _clearUpdatedFlag(void);

        unsigned int _getNumRenderedFaces(void) const;

        void setOverlaysEnabled(bool enabled);

        bool getOverlaysEnabled(void) const;

        void setSkiesEnabled(bool enabled);

        bool getSkiesEnabled(void) const;

        void setShadowsEnabled(bool enabled);

        bool getShadowsEnabled(void) const;

        virtual void setRenderQueueInvocationSequenceName(const String& sequenceName);
        virtual const String& getRenderQueueInvocationSequenceName(void) const;
        RenderQueueInvocationSequence* _getRenderQueueInvocationSequence(void);

    protected:
        Camera* mCamera;
        RenderTarget* mTarget;
        // Relative dimensions, irrespective of target dimensions (0..1)
        float mRelLeft, mRelTop, mRelWidth, mRelHeight;
        // Actual dimensions, based on target dimensions
        int mActLeft, mActTop, mActWidth, mActHeight;
        int mZOrder;
        ColourValue mBackColour;
        bool mClearEveryFrame;
        unsigned int mClearBuffers;
        bool mUpdated;
        bool mShowOverlays;
        bool mShowSkies;
        bool mShowShadows;
        // Render queue invocation sequence name
        String mRQSequenceName;
        RenderQueueInvocationSequence* mRQSequence;
        String mMaterialSchemeName;
    };

}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:52 2006