libogre/include/sirikata/ogre/WebViewManager.hpp

Go to the documentation of this file.

/*  Sirikata
 *  WebViewManager.hpp
 *
 *  Copyright (c) 2009, Adam Jean Simmons
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SIRIKATA_GRAPHICS_WEBVIEWMANAGER_HPP_
#define _SIRIKATA_GRAPHICS_WEBVIEWMANAGER_HPP_

#include <sirikata/ogre/OgreHeaders.hpp>
#include "Ogre.h"
#include <sirikata/ogre/ViewportOverlay.hpp>
#include <sirikata/ogre/input/InputEvents.hpp>
#include <sirikata/ogre/input/InputManager.hpp>
#include <sirikata/ogre/WebView.hpp>

namespace Sirikata {


typedef Sirikata::DataReference<const char*> JSArgument;
typedef std::vector<JSArgument> JSArguments;
typedef JSArguments::const_iterator JSIter;


namespace Graphics {

enum MouseButtonID
{
    LeftMouseButton = 0,
    RightMouseButton = 1,
    MiddleMouseButton = 2,
        ScrollUpButton = 3,
        ScrollDownButton = 4,
        UnknownMouseButton = 0xFFFF
};

struct WebViewCoord {
    int x;
    int y;

    WebViewCoord(int _x, int _y)
     : x(_x), y(_y)
    {
    }
};


class SIRIKATA_OGRE_EXPORT WebViewManager : public Ogre::Singleton<WebViewManager>
{
public:
    WebViewManager(Ogre::Viewport* defaultViewport, Sirikata::Input::InputManager* inputMgr, const std::string& binDirectory, const std::string& baseDirectory);

    ~WebViewManager();

    static WebViewManager& getSingleton();

    static WebViewManager* getSingletonPtr();

    void Update();

    WebView* createWebView(
        Context* ctx,const std::string &webViewName,
        const std::string& webViewType,unsigned short width,
        unsigned short height,const OverlayPosition &webViewPosition,
        Network::IOStrandPtr postStrand,
        bool asyncRender = false, int maxAsyncRenderRate = 70,
        Tier tier = TIER_MIDDLE, Ogre::Viewport* viewport = 0,
        const WebView::WebViewBorderSize& border = WebView::mDefaultBorder);

#ifdef HAVE_BERKELIUM

    WebView* createWebViewPopup(
            Context* ctx,const std::string &webViewName,
            unsigned short width, unsigned short height,
            const OverlayPosition &webViewPosition,
            Berkelium::Window *newwin, Network::IOStrandPtr postingStrand,
            Tier tier = TIER_MIDDLE, Ogre::Viewport* viewport = 0);
#endif

    WebView* createWebViewMaterial(
            Context* ctx,const std::string &webViewName,
            unsigned short width, unsigned short height,
            Network::IOStrandPtr postingStrand,
            bool asyncRender = false, int maxAsyncRenderRate = 70,
            Ogre::FilterOptions texFiltering = Ogre::FO_ANISOTROPIC);

    WebView* getWebView(const std::string &webViewName);

    void destroyWebView(const std::string &webViewName);

    void destroyWebView(WebView* webViewToDestroy);

    void resetAllPositions();

    bool isAnyWebViewFocused();

    WebView* getFocusedWebView();

    bool injectMouseMove(const WebViewCoord& coord);

    bool injectMouseWheel(const WebViewCoord& relScroll);

    bool injectMouseDown(int buttonID);

    bool injectMouseUp(int buttonID);

    bool injectCut();
    bool injectCopy();
    bool injectPaste();

    bool injectKeyEvent(bool pressed, bool repeat, Sirikata::Input::Modifier mod, Sirikata::Input::KeyButton button);

    bool injectTextEvent(std::string utf8);

    void deFocusAllWebViews();

    bool focusWebView(WebView* selection);

    void setDefaultViewport(Ogre::Viewport* newViewport);


    const std::string &getBaseDir() const {
        return baseDirectory;
    }

protected:
    friend class WebView; // Our very close friend <3

    typedef std::map<std::string,WebView*> WebViewMap;
    WebViewMap activeWebViews;
    WebView* focusedWebView;
    WebView* tooltipWebView;
    WebView* tooltipParent;
    WebView* chromeWebView;
    WebView* focusedNonChromeWebView;

    Ogre::Viewport* defaultViewport;
    int mouseXPos, mouseYPos;
    bool isDragging;
    bool isResizing;
    unsigned short zOrderCounter;
    Ogre::Timer tooltipTimer;
    double lastTooltip, tooltipShowTime;
    bool isDraggingFocusedWebView;
    std::string baseDirectory;

#ifdef HAVE_BERKELIUM
    Berkelium::Context *bkContext;
#endif

    WebView* getTopWebView(int x, int y);
    void onResizeTooltip(WebView* WebView, const JSArguments& args);
    void handleTooltip(WebView* tooltipParent, const std::wstring& tipText);
    void handleRequestDrag(WebView* caller);

    Sirikata::Input::InputManager* mInputManager;

    boost::any onRaiseWebViewEvent(WebView* webview, const JSArguments& args);
public:

    Input::EventResponse onMouseHover(Input::MouseHoverEventPtr evt);
    Input::EventResponse onMousePressed(Input::MousePressedEventPtr evt);
    Input::EventResponse onMouseDrag(Input::MouseDragEventPtr evt);
    Input::EventResponse onMouseReleased(Input::MouseReleasedEventPtr evt);
    Input::EventResponse onMouseClick(Input::MouseClickEventPtr evt);
    Input::EventResponse onButton(Input::ButtonEventPtr evt);
    Input::EventResponse onKeyTextInput(Input::TextInputEventPtr evt);
};

}
}

#endif