QAbstract3DInputHandler Class

The base class for implementations of input handlers. More...

Header: #include <QAbstract3DInputHandler>
CMake: find_package(Qt6 REQUIRED COMPONENTS DataVisualization)
target_link_libraries(mytarget PRIVATE Qt6::DataVisualization)
qmake: QT += datavisualization
Since: QtDataVisualization 1.0
In QML: AbstractInputHandler3D
Inherits: QObject
Inherited By:


Public Types

enum InputView { InputViewNone, InputViewOnPrimary, InputViewOnSecondary }


Public Functions

virtual ~QAbstract3DInputHandler()
QPoint inputPosition() const
QAbstract3DInputHandler::InputView inputView() const
virtual void mouseDoubleClickEvent(QMouseEvent *event)
virtual void mouseMoveEvent(QMouseEvent *event, const QPoint &mousePos)
virtual void mousePressEvent(QMouseEvent *event, const QPoint &mousePos)
virtual void mouseReleaseEvent(QMouseEvent *event, const QPoint &mousePos)
Q3DScene *scene() const
void setInputPosition(const QPoint &position)
void setInputView(QAbstract3DInputHandler::InputView inputView)
void setScene(Q3DScene *scene)
virtual void touchEvent(QTouchEvent *event)
virtual void wheelEvent(QWheelEvent *event)


void inputViewChanged(QAbstract3DInputHandler::InputView view)
void positionChanged(const QPoint &position)
void sceneChanged(Q3DScene *scene)

Protected Functions

QAbstract3DInputHandler(QObject *parent = nullptr)
int prevDistance() const
QPoint previousInputPos() const
void setPrevDistance(int distance)
void setPreviousInputPos(const QPoint &position)

Detailed Description

QAbstract3DInputHandler is the base class that is subclassed by different input handling implementations that take input events and translate those to camera and light movements. Input handlers also translate raw input events to slicing and selection events in the scene.

Member Type Documentation

enum QAbstract3DInputHandler::InputView

Predefined input views for mouse and touch based input handlers.

QAbstract3DInputHandler::InputViewNone0Mouse or touch not on a view.
QAbstract3DInputHandler::InputViewOnPrimary1Mouse or touch input received on the primary view area. If secondary view is displayed when inputView becomes InputViewOnPrimary, secondary view is closed.
QAbstract3DInputHandler::InputViewOnSecondary2Mouse or touch input received on the secondary view area.

Property Documentation

inputPosition : QPoint

This property holds the last input position based on the processed input events.

Access functions:

QPoint inputPosition() const
void setInputPosition(const QPoint &position)

Notifier signal:

void positionChanged(const QPoint &position)

inputView : InputView

This property holds the current enumerated input view based on the view of the processed input events.

One of the InputView enum values.

When the view changes, the inputViewChanged signal is emitted.

Access functions:

QAbstract3DInputHandler::InputView inputView() const
void setInputView(QAbstract3DInputHandler::InputView inputView)

Notifier signal:

void inputViewChanged(QAbstract3DInputHandler::InputView view)

See also InputView.

scene : Q3DScene*

This property holds the 3D scene this abstract input handler is controlling.

One input handler can control one scene. Setting a scene to an input handler does not transfer the ownership of the scene.

Access functions:

Q3DScene *scene() const
void setScene(Q3DScene *scene)

Notifier signal:

void sceneChanged(Q3DScene *scene)

Member Function Documentation

[explicit protected] QAbstract3DInputHandler::QAbstract3DInputHandler(QObject *parent = nullptr)

Constructs the base class. An optional parent parameter can be given and is then passed to QObject constructor.

[virtual noexcept] QAbstract3DInputHandler::~QAbstract3DInputHandler()

Destroys the base class.

[virtual] void QAbstract3DInputHandler::mouseDoubleClickEvent(QMouseEvent *event)

Override this to handle mouse double click events. Mouse double click event is given in the event.

[virtual] void QAbstract3DInputHandler::mouseMoveEvent(QMouseEvent *event, const QPoint &mousePos)

Override this to handle mouse move events. Mouse move event is given in the event and the mouse position in mousePos.

[virtual] void QAbstract3DInputHandler::mousePressEvent(QMouseEvent *event, const QPoint &mousePos)

Override this to handle mouse press events. Mouse press event is given in the event and the mouse position in mousePos.

[virtual] void QAbstract3DInputHandler::mouseReleaseEvent(QMouseEvent *event, const QPoint &mousePos)

Override this to handle mouse release events. Mouse release event is given in the event and the mouse position in mousePos.

[protected] int QAbstract3DInputHandler::prevDistance() const

Returns the manhattan length between last two input positions.

See also setPrevDistance().

[protected] QPoint QAbstract3DInputHandler::previousInputPos() const

Returns the previous input position.

See also setPreviousInputPos().

[protected] void QAbstract3DInputHandler::setPrevDistance(int distance)

Sets the distance (manhattan length) between last two input positions.

See also prevDistance().

[protected] void QAbstract3DInputHandler::setPreviousInputPos(const QPoint &position)

Sets the previous input position to the point given by position.

See also previousInputPos().

[virtual] void QAbstract3DInputHandler::touchEvent(QTouchEvent *event)

Override this to handle touch input events. Touch event is given in the event.

[virtual] void QAbstract3DInputHandler::wheelEvent(QWheelEvent *event)

Override this to handle wheel events. Wheel event is given in the event.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.