Q3DMouseEvent Class

(Qt3D::Q3DMouseEvent)

The Qt3D::Q3DMouseEvent contains parameters that describe a mouse event. More...

Header: #include <Q3DMouseEvent>
Since: Qt 5.5
Inherits: QObject

Public Types

enum Buttons { LeftButton, RightButton, MiddleButton, BackButton, NoButton }
enum Modifiers { NoModifier, ShiftModifier, ControlModifier, AltModifier, MetaModifier, KeypadModifier }

Properties

  • wasHeld : const bool
  • x : const int
  • y : const int
  • 1 property inherited from QObject

Public Functions

Q3DMouseEvent(const QMouseEvent & e)
~Q3DMouseEvent()
Buttons button() const
int buttons() const
bool isAccepted() const
Modifiers modifier() const
void setAccepted(bool accepted)
QEvent::Type type() const
bool wasHeld() const
int x() const
int y() const
  • 31 public functions inherited from QObject

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 2 signals inherited from QObject
  • 11 static public members inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

The Qt3D::Q3DMouseEvent contains parameters that describe a mouse event.

Mouse events occur when a mouse button is pressed and the ray traversing the view, originating from the mouse position intersects with one or more elements of the scene.

See also Qt3D::Q3DKeyEvent, Qt3D::Q3DWheelEvent, and Qt3D::QMouseInput.

Member Type Documentation

enum Q3DMouseEvent::Buttons

enum Q3DMouseEvent::Modifiers

Property Documentation

accepted : bool

Access functions:

bool isAccepted() const
void setAccepted(bool accepted)

button : const Qt3D::Q3DMouseEvent::Buttons

Access functions:

Buttons button() const

buttons : const int

Access functions:

int buttons() const

modifier : const Qt3D::Q3DMouseEvent::Modifiers

Access functions:

Modifiers modifier() const

wasHeld : const bool

Access functions:

bool wasHeld() const

x : const int

Access functions:

int x() const

y : const int

Access functions:

int y() const

Member Function Documentation

Q3DMouseEvent::Q3DMouseEvent(const QMouseEvent & e)

Constructs a new Qt3D::Q3DMouseEvent instance for the QMouseEvent e.

Q3DMouseEvent::~Q3DMouseEvent()

Buttons Q3DMouseEvent::button() const

Returns the mouse button of the mouse event.

Note: Getter function for property button.

int Q3DMouseEvent::buttons() const

Returns a bitfield to be used to check for mouse buttons that may be accompanying the mouse event.

Note: Getter function for property buttons.

bool Q3DMouseEvent::isAccepted() const

Returns whether the event was accepted.

Note: Getter function for property accepted.

Modifiers Q3DMouseEvent::modifier() const

Returns the keyboard modifier that may be accompanying the mouse event.

Note: Getter function for property modifier.

void Q3DMouseEvent::setAccepted(bool accepted)

Sets the event as accepted if accepted is true.

Note: When an event is accepted, it will prevent further propagation to other listeners.

Note: Setter function for property accepted.

See also isAccepted().

QEvent::Type Q3DMouseEvent::type() const

Returns the QEvent::Type of the event.

int Q3DMouseEvent::x() const

Returns the x position of the mouse event.

Note: Getter function for property x.

int Q3DMouseEvent::y() const

Returns the y position of the mouse event.

Note: Getter function for property y.

© 2016 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.