include/eq/client/window.h

Go to the documentation of this file.

/* Copyright (c) 2005-2012, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2010, Cedric Stalder <cedric.stalder@gmail.com> 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library 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 library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_WINDOW_H
#define EQ_WINDOW_H

#include <eq/client/gl.h>            // GLEWContext
#include <eq/client/types.h>
#include <eq/client/visitorResult.h> // enum

#include <eq/util/bitmapFont.h>      // member
#include <eq/fabric/renderContext.h> // member
#include <eq/fabric/window.h>        // base class



namespace eq
{
    class Window : public fabric::Window< Pipe, Window, Channel >
    {
    public:
        typedef eq::ObjectManager ObjectManager;

        typedef BitmapFont Font;

        EQ_API Window( Pipe* parent );

        EQ_API virtual ~Window();

        EQ_API co::CommandQueue* getPipeThreadQueue(); 
        EQ_API co::CommandQueue* getCommandThreadQueue(); 
        EQ_API uint32_t getCurrentFrame() const; 

        EQ_API const Node* getNode() const; 

        EQ_API Node*       getNode();

        EQ_API const Config* getConfig() const;

        EQ_API Config*       getConfig();

        EQ_API ClientPtr getClient();

        EQ_API ServerPtr getServer();

        bool isRunning() const { return (_state == STATE_RUNNING); }

        bool isStopped() const { return (_state == STATE_STOPPED); }

        EQ_API bool getRenderContext( const int32_t x, const int32_t y,
                                         RenderContext& context ) const;

        void setSharedContextWindow( Window* sharedContextWindow )
            { _sharedContextWindow = sharedContextWindow; }

        const Window* getSharedContextWindow() const
            { return _sharedContextWindow; }

        Window* getSharedContextWindow() { return _sharedContextWindow; }

        ObjectManager* getObjectManager() { return _objectManager; }

        const ObjectManager* getObjectManager() const { return _objectManager; }

        EQ_API const Font* getSmallFont();

        EQ_API const Font* getMediumFont();

        EQ_API const GLEWContext* glewGetContext() const;

        EQ_API const GLEWContext* getTransferGlewContext();

        EQ_API uint32_t getColorFormat() const;

        virtual void flush() const { glFlush(); }

        virtual void finish() const { glFinish(); }

        EQ_API virtual void swapBuffers();

        EQ_API virtual void drawFPS();

        float getFPS() const { return _avgFPS; }

        EQ_API virtual void makeCurrent( const bool cache = true ) const;

        void makeCurrentTransfer( const bool cache = true );

        EQ_API virtual void bindFrameBuffer() const;

        EQ_API virtual void notifyViewportChanged();

        EQ_API void setSystemWindow( SystemWindow* window );

        const SystemWindow* getSystemWindow() const { return _systemWindow; }

        SystemWindow* getSystemWindow() { return _systemWindow; }

        const SystemPipe* getSystemPipe() const;

        SystemPipe* getSystemPipe(); 

        const eq::SystemWindow* getTransferSystemWindow();

        void deleteTransferSystemWindow();

        EQ_API virtual bool processEvent( const Event& event );

    protected:
        friend class Pipe;

        EQ_API virtual void attach( const UUID& id, const uint32_t instanceID );

        EQ_API void startFrame( const uint32_t frameNumber );

        EQ_API void releaseFrame( const uint32_t frameNumber );

        EQ_API void releaseFrameLocal( const uint32_t frameNumber );

         EQ_API virtual bool configInit( const uint128_t& initID );

        EQ_API virtual bool configInitSystemWindow( const uint128_t& initID );

        EQ_API virtual bool configInitGL( const uint128_t& initID );

        EQ_API virtual bool configExit();

        EQ_API virtual bool configExitSystemWindow();

        virtual bool configExitGL() { return true; }

        EQ_API virtual void frameStart( const uint128_t& frameID, 
                                        const uint32_t frameNumber );

        EQ_API virtual void frameFinish( const uint128_t& frameID, 
                                         const uint32_t frameNumber );

        EQ_API virtual void frameDrawFinish( const uint128_t& frameID,
                                             const uint32_t frameNumber );

    private:
        enum State
        {
            STATE_STOPPED,
            STATE_INITIALIZING,
            STATE_RUNNING,
            STATE_FAILED
        };

        Window* _sharedContextWindow;

        SystemWindow* _transferWindow;

        SystemWindow* _systemWindow;

        State _state;

        ObjectManager* _objectManager;

        float _lastTime;

        float _avgFPS;

        std::vector< RenderContext > _renderContexts[2];
        enum 
        {
            FRONT = 0,
            BACK  = 1
        };

        int64_t _lastSwapTime;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes

        void _addRenderContext( const RenderContext& context );
        friend class Channel;
        
        void _setupObjectManager();
        void _releaseObjectManager();

        void _updateFPS();

        void _enterBarrier( co::ObjectVersion barrier );

        /* The command functions. */
        bool _cmdCreateChannel( co::Command& command );
        bool _cmdDestroyChannel(co::Command& command );
        bool _cmdConfigInit( co::Command& command );
        bool _cmdConfigExit( co::Command& command );
        bool _cmdFrameStart( co::Command& command );
        bool _cmdFrameFinish( co::Command& command );
        bool _cmdThrottleFramerate( co::Command& command );
        bool _cmdFlush( co::Command& command );
        bool _cmdFinish( co::Command& command );
        bool _cmdBarrier( co::Command& command );
        bool _cmdNVBarrier( co::Command& command );
        bool _cmdSwap( co::Command& command );
        bool _cmdFrameDrawFinish( co::Command& command );

        LB_TS_VAR( _pipeThread );
    };
}

#endif // EQ_WINDOW_H