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-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 __Viewport_H__
#define __Viewport_H__

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

namespace Ogre {
    class _OgreExport Viewport : public ViewportAlloc
    {
    public:
        class _OgreExport Listener
        {
        public:
            virtual ~Listener() {}

            virtual void viewportCameraChanged(Viewport* viewport) {}

            virtual void viewportDimensionsChanged(Viewport* viewport) {}

            virtual void viewportDestroyed(Viewport* viewport) {}
        };

        Viewport(
            Camera* camera,
            RenderTarget* target,
            Real left, Real top,
            Real width, Real height,
            int ZOrder);

        virtual ~Viewport();

        void _updateDimensions(void);

        void update(void);
        
        void clear(unsigned int buffers = FBT_COLOUR | FBT_DEPTH,
                   const ColourValue& colour = ColourValue::Black, 
                   Real depth = 1.0f, unsigned short stencil = 0);

        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 setOrientationMode(OrientationMode orientationMode, bool setDefault = true);

        OrientationMode getOrientationMode() const;

        static void setDefaultOrientationMode(OrientationMode orientationMode);

        static OrientationMode getDefaultOrientationMode();

        void setBackgroundColour(const ColourValue& colour);

        const ColourValue& getBackgroundColour(void) const;

        void setDepthClear( Real depth );

        Real getDepthClear(void) const;

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

        bool getClearEveryFrame(void) const;

        unsigned int getClearBuffers(void) const;

        void setAutoUpdated(bool autoupdate);
        bool isAutoUpdated() 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;

        unsigned int _getNumRenderedBatches(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;


        void setVisibilityMask(uint32 mask) { mVisibilityMask = mask; }

        uint getVisibilityMask(void) const { return mVisibilityMask; }

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

        void pointOrientedToScreen(const Vector2 &v, int orientationMode, Vector2 &outv);
        void pointOrientedToScreen(Real orientedX, Real orientedY, int orientationMode,
                                   Real &screenX, Real &screenY);

        void addListener(Listener* l);
        void removeListener(Listener* l);

    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;
        Real mDepthClearValue;
        bool mClearEveryFrame;
        unsigned int mClearBuffers;
        bool mUpdated;
        bool mShowOverlays;
        bool mShowSkies;
        bool mShowShadows;
        uint32 mVisibilityMask;
        // Render queue invocation sequence name
        String mRQSequenceName;
        RenderQueueInvocationSequence* mRQSequence;
        String mMaterialSchemeName;
        OrientationMode mOrientationMode;
        static OrientationMode mDefaultOrientationMode;

        bool mIsAutoUpdated;

        typedef vector<Listener*>::type ListenerList;
        ListenerList mListeners;
    };
}

#endif