1
0
Fork 0
flightgear/src/GUI/MouseCursor.cxx
Julian Smith f62e5b9ce3 CompositeViewer: Support for multiple view windows using osgViewer::CompositeViewer.
Overview:

    Previously Flightgear always used a single osgViewer::Viewer(), which
    inherits from both osgViewer::ViewerBase and osgViewer::View, giving a
    single view window.

    If CompositeViewer is enabled, we instead use a osgViewer::CompositeViewer
    which contains a list of osgViewer::View's. Each of these View's can have
    its own eye position, so we can have multiple different views of the same
    scene.

    Enable at runtime with: --composite-viewer=1

Changes to allow use of osgViewer::CompositeViewer:

    Previously FGRenderer had this method:

        osgViewer::Viewer* getViewer();

    This has been replaced by these two new methods:

        osgViewer::ViewerBase* getViewerBase();
        osgViewer::View* getView();

    If CompositeViewer is not enabled (the default), the actual runtime state
    is unchanged, and getViewerBase() and getView() both return a pointer to
    the singleton osgViewer::Viewer() object.

    If CompositeViewer is enabled, getViewerBase() returns a pointer to a
    singleton osgViewer::CompositeViewer object, and getView() returns a
    pointer to the first osgViewer::View in the osgViewer::CompositeViewer's
    list.

    The other significant change to FGRenderer() is the new method:

        osg::FrameStamp* getFrameStamp()

    If CompositeViewer is not enabled, this simply returns
    getView()->getFrameStamp(). If CompositeViewer is enabled it returns
    getViewerBase()->getFrameStamp(). It is important that code that previously
    called getView()->getFrameStamp() is changed to use the new method, because
    when CompositeViewer is enabled individual osgViewer::View's appear to
    return an osg::FrameStamp with zero frame number).

    All code that uses FGRenderer has been patched up to use the new methods so
    that things work as before regardless of whether CompositeViewer is enabled
    or not.

    We make FGRenderer::update() call SviewUpdate() which updates any extra
    views.

Extra view windows:

    If CompositeViewer is enabled, one can create top-level extra view windows
    by calling SviewCreate(). See src/Viewer/sview.hxx for details.

    Each extra view window has its own simgear::compositor::Compositor
    instance.

    Currently SviewCreate() can create extra view windows that clone the
    current view, or view from one point to another (e.g. from one multiplayer
    aircraft to the user's aircradt) or keep two aircraft in view, one at a
    fixed distance in the foreground.

    SviewCreate() can be called from nasal via new nasal commands "view-clone",
    "view-last-pair", "view-last-pair-double" and "view-push". Associated
    changes to fgdata gives access to these via the View menu. The "view-push"
    command tags the current view for later use by "view-last-pair" and
    "view-last-pair-double".

    Extra view windows created by SviewCreate() use a new view system called
    Sview, which allows views to be constructed at runtime instead of being
    hard-coded in *-set.xml files. This is work in progress and views aren't
    all fully implemented. For example Pilot view gets things slightly wrong
    with large roll values, Tower View AGL is not implemented, and we don't
    implement damping. See top of src/Viewer/sview.cxx for an overview.

OpenSceneGraph-3.4 issues:

    OSG-3.4's event handling seems to be incorrect with CompositeViewer -
    events get sent for the wrong window which causes issues with resize and
    closing. It doesn't seem to be possible to work around this, so closing
    extra view windows can end up closing the main window for example.

    OSG-3.6 seems to fix the problems.

    We warn if CompositeViewer is enabled and OpenSceneGraph is 3.4.
2020-11-21 13:27:02 +00:00

245 lines
6.8 KiB
C++

// MouseCursor.cxx - abstract inteface for mouse cursor control
// Copyright (C) 2013 James Turner <zakalawe@mac.com>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "MouseCursor.hxx"
#include <cstring>
#include <osgViewer/GraphicsWindow>
#include <osgViewer/Viewer>
#include <simgear/debug/logstream.hxx>
#include <simgear/simgear_config.h>
#include <simgear/structure/commands.hxx>
#ifdef SG_MAC
#include "CocoaMouseCursor.hxx"
#endif
#ifdef SG_WINDOWS
#include "WindowsMouseCursor.hxx"
#endif
#include <Main/fg_props.hxx>
#include <Main/globals.hxx>
#include <Viewer/renderer.hxx>
#include <Main/fg_os.hxx> // for fgWarpMouse
namespace
{
/**
* @brief when no native cursor implementation is available, use the osgViewer support. This
* has several limitations but is better than nothing
*/
class StockOSGCursor : public FGMouseCursor
{
public:
StockOSGCursor() :
mCursorObscured(false),
mCursorVisible(true),
mCursor(osgViewer::GraphicsWindow::InheritCursor)
{
mActualCursor = mCursor;
globals->get_renderer()->getViewerBase()->getWindows(mWindows);
}
virtual void setCursor(Cursor aCursor)
{
mCursor = translateCursor(aCursor);
updateCursor();
}
virtual void setCursorVisible(bool aVis)
{
if (mCursorObscured == aVis) {
return;
}
mCursorVisible = aVis;
updateCursor();
}
virtual void hideCursorUntilMouseMove()
{
if (mCursorObscured) {
return;
}
mCursorObscured = true;
updateCursor();
}
virtual void mouseMoved()
{
if (mCursorObscured) {
mCursorObscured = false;
updateCursor();
}
}
private:
osgViewer::GraphicsWindow::MouseCursor translateCursor(Cursor aCursor)
{
switch (aCursor) {
case CURSOR_ARROW: return osgViewer::GraphicsWindow::RightArrowCursor;
case CURSOR_HAND: return osgViewer::GraphicsWindow::HandCursor;
case CURSOR_CLOSED_HAND: return osgViewer::GraphicsWindow::HandCursor;
case CURSOR_CROSSHAIR: return osgViewer::GraphicsWindow::CrosshairCursor;
case CURSOR_IBEAM: return osgViewer::GraphicsWindow::TextCursor;
case CURSOR_LEFT_RIGHT: return osgViewer::GraphicsWindow::LeftRightCursor;
case CURSOR_UP_DOWN: return osgViewer::GraphicsWindow::UpDownCursor;
default:
return osgViewer::GraphicsWindow::RightArrowCursor;
}
}
void updateCursor()
{
osgViewer::GraphicsWindow::MouseCursor cur = osgViewer::GraphicsWindow::InheritCursor;
if (mCursorObscured || !mCursorVisible) {
cur = osgViewer::GraphicsWindow::NoCursor;
} else {
cur = mCursor;
}
if (cur == mActualCursor) {
return;
}
for (auto gw : mWindows) {
gw->setCursor(cur);
}
mActualCursor = cur;
}
bool mCursorObscured;
bool mCursorVisible;
osgViewer::GraphicsWindow::MouseCursor mCursor, mActualCursor;
std::vector<osgViewer::GraphicsWindow*> mWindows;
};
} // of anonymous namespace
static FGMouseCursor* static_instance = NULL;
FGMouseCursor::FGMouseCursor() :
mAutoHideTimeMsec(10000)
{
}
FGMouseCursor* FGMouseCursor::instance()
{
if (static_instance == NULL) {
#ifdef SG_MAC
if (true) {
static_instance = new CocoaMouseCursor;
}
#endif
#ifdef SG_WINDOWS
// set osgViewer cursor inherit, otherwise it will interefere
std::vector<osgViewer::GraphicsWindow*> gws;
globals->get_renderer()->getViewerBase()->getWindows(gws);
for (auto gw : gws) {
gw->setCursor(osgViewer::GraphicsWindow::InheritCursor);
}
// Windows native curosr disabled while interaction with OSG
// is resolved - right now NCHITs (non-client-area hits)
// overwire the InheritCursor value above, and hence our cursor
// get stuck.
// and create our real implementation
// static_instance = new WindowsMouseCursor;
#endif
// X11
if (static_instance == NULL) {
static_instance = new StockOSGCursor;
}
// initialise mouse-hide delay from global properties
globals->get_commands()->addCommand("set-cursor", static_instance, &FGMouseCursor::setCursorCommand);
}
return static_instance;
}
void FGMouseCursor::setAutoHideTimeMsec(unsigned int aMsec)
{
mAutoHideTimeMsec = aMsec;
}
bool FGMouseCursor::setCursorCommand(const SGPropertyNode* arg, SGPropertyNode*)
{
// JMT 2013 - I would prefer this was a seperate 'warp' command, but
// historically set-cursor has done both.
if (arg->hasValue("x") || arg->hasValue("y")) {
SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
int x = arg->getIntValue("x", mx->getIntValue());
int y = arg->getIntValue("y", my->getIntValue());
fgWarpMouse(x, y);
mx->setIntValue(x);
my->setIntValue(y);
}
Cursor c = cursorFromString(arg->getStringValue("cursor"));
setCursor(c);
return true;
}
typedef struct {
const char * name;
FGMouseCursor::Cursor cursor;
} MouseCursorMap;
const MouseCursorMap mouse_cursor_map[] = {
{ "inherit", FGMouseCursor::CURSOR_ARROW },
{ "crosshair", FGMouseCursor::CURSOR_CROSSHAIR },
{ "left-right", FGMouseCursor::CURSOR_LEFT_RIGHT },
{ "hand", FGMouseCursor::CURSOR_HAND },
{ "closed-hand", FGMouseCursor::CURSOR_CLOSED_HAND },
{ "text", FGMouseCursor::CURSOR_IBEAM },
// aliases
{ "drag-horizontal", FGMouseCursor::CURSOR_LEFT_RIGHT },
{ "drag-vertical", FGMouseCursor::CURSOR_UP_DOWN },
{ 0, FGMouseCursor::CURSOR_ARROW }
};
FGMouseCursor::Cursor FGMouseCursor::cursorFromString(const char* cursor_name)
{
for (unsigned int k = 0; mouse_cursor_map[k].name != 0; k++) {
if (!strcmp(mouse_cursor_map[k].name, cursor_name)) {
return mouse_cursor_map[k].cursor;
}
}
SG_LOG(SG_GENERAL, SG_WARN, "unknown cursor:" << cursor_name);
return CURSOR_ARROW;
}