kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Gui: Refactor navigation styles

Browse Source 
Derive SiemensNXStyle from NavigationStateChart
This commit is contained in:
wmayer
2025-04-23 13:49:23 +02:00
committed by Max Wilfinger
parent ba9c09fc61
commit 00e05045df
5 changed files with 71 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Gui/CMakeLists.txt
View File

@@ -958,6 +958,7 @@ SET(Navigation_SRCS
Navigation/GestureNavigationStyle.h
Navigation/NavigationAnimator.h
Navigation/NavigationAnimation.h
Navigation/SiemensNXStyle.h
)
SOURCE_GROUP("Navigation" FILES ${Navigation_SRCS})

30
src/Gui/Navigation/NavigationStyle.h
View File

@@ -490,36 +490,6 @@ protected:
SbBool processSoEvent(const SoEvent * const ev) override;
};
class GuiExport SiemensNXStyle : public UserNavigationStyle {
using inherited = UserNavigationStyle;
TYPESYSTEM_HEADER_WITH_OVERRIDE();
public:
SiemensNXStyle();
~SiemensNXStyle() override;
const char* mouseButtons(ViewerMode mode) override;
std::string userFriendlyName() const override;
protected:
SbBool processSoEvent(const SoEvent * const ev) override;
SbBool processKeyboardEvent(const SoKeyboardEvent * const event) override;
private:
struct Event;
struct NaviMachine;
struct IdleState;
struct AwaitingReleaseState;
struct AwaitingMoveState;
struct InteractState;
struct RotateState;
struct PanState;
struct ZoomState;
struct SelectionState;
std::unique_ptr<NaviMachine> naviMachine;
};
} // namespace Gui
// NOLINTEND(cppcoreguidelines-avoid*, readability-avoid-const-params-in-decls)

180
src/Gui/Navigation/SiemensNXStyle.cpp
View File

@@ -32,7 +32,7 @@
#include <boost/statechart/state.hpp>
#include "Camera.h"
#include "NavigationStyle.h"
#include "SiemensNXStyle.h"
#include "View3DInventorViewer.h"
// NOLINTBEGIN(cppcoreguidelines-pro-type-static-cast-downcast,
@@ -40,98 +40,9 @@
// readability-avoid-const-params-in-decls)
using namespace Gui;
namespace sc = boost::statechart;
using SC = NavigationStateChart;
using NS = SiemensNXStyle;
struct NS::Event: public sc::event<NS::Event>
{
Event() : flags(new Flags){}
using Button = SoMouseButtonEvent::Button;
using Key = SoKeyboardEvent::Key;
bool isMouseButtonEvent() const {
return this->inventor_event->isOfType(SoMouseButtonEvent::getClassTypeId());
}
const SoMouseButtonEvent* asMouseButtonEvent() const {
return static_cast<const SoMouseButtonEvent*>(this->inventor_event);
}
bool isPress(Button button) const {
return SoMouseButtonEvent::isButtonPressEvent(this->inventor_event, button);
}
bool isRelease(Button button) const {
return SoMouseButtonEvent::isButtonReleaseEvent(this->inventor_event, button);
}
bool isKeyPress(Key key) const {
return SoKeyboardEvent::isKeyPressEvent(this->inventor_event, key);
}
bool isKeyRelease(Key key) const {
return SoKeyboardEvent::isKeyReleaseEvent(this->inventor_event, key);
}
bool isKeyboardEvent() const {
return this->inventor_event->isOfType(SoKeyboardEvent::getClassTypeId());
}
const SoKeyboardEvent* asKeyboardEvent() const {
return static_cast<const SoKeyboardEvent*>(this->inventor_event);
}
bool isLocation2Event() const {
return this->inventor_event->isOfType(SoLocation2Event::getClassTypeId());
}
const SoLocation2Event* asLocation2Event() const {
return static_cast<const SoLocation2Event*>(this->inventor_event);
}
bool isMotion3Event() const {
return this->inventor_event->isOfType(SoMotion3Event::getClassTypeId());
}
const SoMotion3Event* asMotion3Event() const {
return static_cast<const SoMotion3Event*>(this->inventor_event);
}
bool isDownButton(unsigned int state) const {
return mbstate() == state;
}
bool isDownNoButton() const {
return mbstate() == 0;
}
bool isDownButton1() const {
return (mbstate() & BUTTON1DOWN) == BUTTON1DOWN;
}
bool isDownButton2() const {
return (mbstate() & BUTTON2DOWN) == BUTTON2DOWN;
}
bool isDownButton3() const {
return (mbstate() & BUTTON3DOWN) == BUTTON3DOWN;
}
bool isDownControl() const {
return (kbstate() & CTRLDOWN) == CTRLDOWN;
}
bool isDownShift() const {
return (kbstate() & SHIFTDOWN) == SHIFTDOWN;
}
bool isDownAlt() const {
return (kbstate() & ALTDOWN) == ALTDOWN;
}
enum {
// bits: 0-shift-ctrl-alt-0-lmb-mmb-rmb
BUTTON1DOWN = 0x00000100,
BUTTON2DOWN = 0x00000001,
BUTTON3DOWN = 0x00000010,
CTRLDOWN = 0x00100000,
SHIFTDOWN = 0x01000000,
ALTDOWN = 0x00010000,
MASKBUTTONS = BUTTON1DOWN | BUTTON2DOWN | BUTTON3DOWN,
MASKMODIFIERS = CTRLDOWN | SHIFTDOWN | ALTDOWN
};
const SoEvent* inventor_event{nullptr};
unsigned int modifiers{0};
unsigned int mbstate() const {return modifiers & MASKBUTTONS;}
unsigned int kbstate() const {return modifiers & MASKMODIFIERS;}
struct Flags{
bool processed = false;
bool propagated = false;
};
std::shared_ptr<Flags> flags;
};
struct NS::NaviMachine: public sc::state_machine<NS::NaviMachine, NS::IdleState>
{
using superclass = sc::state_machine<NS::NaviMachine, NS::IdleState>;
@@ -141,13 +52,13 @@ struct NS::NaviMachine: public sc::state_machine<NS::NaviMachine, NS::IdleState>
struct NS::IdleState: public sc::state<NS::IdleState, NS::NaviMachine>
{
using reactions = sc::custom_reaction<NS::Event>;
using reactions = sc::custom_reaction<SC::Event>;
explicit IdleState(my_context ctx) : my_base(ctx)
{
auto &ns = this->outermost_context().ns;
ns.setViewingMode(NavigationStyle::IDLE);
}
sc::result react(const NS::Event& ev)
sc::result react(const SC::Event& ev)
{
auto &ns = this->outermost_context().ns;
switch (ns.getViewingMode()) {
@@ -194,7 +105,7 @@ struct NS::IdleState: public sc::state<NS::IdleState, NS::NaviMachine>
return transit<NS::PanState>();
}
if (ev.isDownButton(NS::Event::BUTTON3DOWN)) {
if (ev.isDownButton(SC::Event::BUTTON3DOWN)) {
ev.flags->processed = true;
return transit<NS::AwaitingMoveState>();
}
@@ -490,14 +401,12 @@ struct NS::SelectionState: public sc::state<NS::SelectionState, NS::NaviMachine>
TYPESYSTEM_SOURCE(Gui::SiemensNXStyle, Gui::UserNavigationStyle)
SiemensNXStyle::SiemensNXStyle()
: naviMachine(new NS::NaviMachine(*this))
{
naviMachine->initiate();
naviMachine->make_object(new NS::NaviMachine(*this));
}
SiemensNXStyle::~SiemensNXStyle()
{
naviMachine.reset();
}
const char* SiemensNXStyle::mouseButtons(ViewerMode mode)
@@ -557,83 +466,6 @@ SbBool SiemensNXStyle::processKeyboardEvent(const SoKeyboardEvent * const event)
return inherited::processKeyboardEvent(event);
}
SbBool SiemensNXStyle::processSoEvent(const SoEvent * const ev)
{
// Events when in "ready-to-seek" mode are ignored, except those
// which influence the seek mode itself -- these are handled further
// up the inheritance hierarchy.
if (this->isSeekMode()) {
return inherited::processSoEvent(ev);
}
// Switch off viewing mode (Bug #0000911)
if (!this->isSeekMode() && !this->isAnimating() && this->isViewing()) {
this->setViewing(false); // by default disable viewing mode to render the scene
}
// Mismatches in state of the modifier keys happens if the user
// presses or releases them outside the viewer window.
syncModifierKeys(ev);
// give the nodes in the foreground root the chance to handle events (e.g color bar)
if (!viewer->isEditing()) {
if (handleEventInForeground(ev)) {
return true;
}
}
NS::Event smev;
smev.inventor_event = ev;
// Spaceball/joystick handling
if (ev->isOfType(SoMotion3Event::getClassTypeId())){
smev.flags->processed = true;
this->processMotionEvent(static_cast<const SoMotion3Event*>(ev));
return true;
}
// Keyboard handling
if (ev->isOfType(SoKeyboardEvent::getClassTypeId())) {
const auto event = static_cast<const SoKeyboardEvent *>(ev);
smev.flags->processed = processKeyboardEvent(event);
}
if (smev.isMouseButtonEvent()) {
const auto button = smev.asMouseButtonEvent()->getButton();
const SbBool press = smev.asMouseButtonEvent()->getState() == SoButtonEvent::DOWN;
switch (button) {
case SoMouseButtonEvent::BUTTON1:
this->button1down = press;
break;
case SoMouseButtonEvent::BUTTON2:
this->button2down = press;
break;
case SoMouseButtonEvent::BUTTON3:
this->button3down = press;
break;
default:
break;
}
}
smev.modifiers =
(this->button1down ? NS::Event::BUTTON1DOWN : 0) |
(this->button2down ? NS::Event::BUTTON2DOWN : 0) |
(this->button3down ? NS::Event::BUTTON3DOWN : 0) |
(this->ctrldown ? NS::Event::CTRLDOWN : 0) |
(this->shiftdown ? NS::Event::SHIFTDOWN : 0) |
(this->altdown ? NS::Event::ALTDOWN : 0);
if (!smev.flags->processed) {
this->naviMachine->process_event(smev);
}
if (!smev.flags->propagated && !smev.flags->processed) {
return inherited::processSoEvent(ev);
}
return smev.flags->processed;
}
// NOLINTEND(cppcoreguidelines-pro-type-static-cast-downcast,
// cppcoreguidelines-avoid*,
// readability-avoid-const-params-in-decls)

63
src/Gui/Navigation/SiemensNXStyle.h Normal file
View File

@@ -0,0 +1,63 @@
// SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
* Copyright (c) 2025 Werner Mayer <wmayer[at]users.sourceforge.net> *
* *
* This file is part of FreeCAD. *
* *
* FreeCAD 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.1 of the *
* License, or (at your option) any later version. *
* *
* FreeCAD 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 FreeCAD. If not, see *
* <https://www.gnu.org/licenses/>. *
* *
**************************************************************************/
#ifndef GUI_SIEMENSNXSTYLE_H
#define GUI_SIEMENSNXSTYLE_H
#include <Gui/Navigation/NavigationStateChart.h>
// NOLINTBEGIN(cppcoreguidelines-avoid*, readability-avoid-const-params-in-decls)
namespace Gui
{
class GuiExport SiemensNXStyle : public NavigationStateChart {
using inherited = NavigationStateChart;
TYPESYSTEM_HEADER_WITH_OVERRIDE();
public:
SiemensNXStyle();
~SiemensNXStyle() override;
const char* mouseButtons(ViewerMode mode) override;
std::string userFriendlyName() const override;
protected:
SbBool processKeyboardEvent(const SoKeyboardEvent * const event) override;
private:
struct NaviMachine;
struct IdleState;
struct AwaitingReleaseState;
struct AwaitingMoveState;
struct InteractState;
struct RotateState;
struct PanState;
struct ZoomState;
struct SelectionState;
};
} // namespace Gui
// NOLINTEND(cppcoreguidelines-avoid*, readability-avoid-const-params-in-decls)
#endif // GUI_SIEMENSNXSTYLE_H

2
src/Gui/SoFCDB.cpp
View File

@@ -53,7 +53,7 @@
#include "Inventor/Draggers/SoTransformDragger.h"
#include "Navigation/GestureNavigationStyle.h"
#include "Navigation/NavigationStyle.h"
#include "Navigation/NavigationStateChart.h"
#include "Navigation/SiemensNXStyle.h"
#include "SelectionObject.h"
#include "SoDevicePixelRatioElement.h"
#include "SoFCColorBar.h"