PySide6.Qt3DRender.Qt3DRender.QPickEvent

class QPickEvent

The QPickEvent class holds information when an object is picked. More…

Inherited by: QPickTriangleEvent, QPickPointEvent, QPickLineEvent

Synopsis

Properties

• acceptedᅟ

• buttonᅟ

• buttonsᅟ

• distanceᅟ

• entityᅟ

• localIntersectionᅟ

• modifiersᅟ

• positionᅟ

• viewportᅟ

• worldIntersectionᅟ

Methods

• def __init__()

• def button()

• def buttons()

• def distance()

• def entity()

• def isAccepted()

• def localIntersection()

• def modifiers()

• def position()

• def viewport()

• def worldIntersection()

Slots

• def setAccepted()

Signals

• def acceptedChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

This is received as a parameter in most of the QObjectPicker component signals when picking succeeds.

See also

QPickingSettings QPickTriangleEvent QObjectPicker

class Buttons

Constant	Description
Qt3DRender.QPickEvent.LeftButton
Qt3DRender.QPickEvent.RightButton
Qt3DRender.QPickEvent.MiddleButton
Qt3DRender.QPickEvent.BackButton
Qt3DRender.QPickEvent.NoButton

class Modifiers

Constant	Description
Qt3DRender.QPickEvent.NoModifier
Qt3DRender.QPickEvent.ShiftModifier
Qt3DRender.QPickEvent.ControlModifier
Qt3DRender.QPickEvent.AltModifier
Qt3DRender.QPickEvent.MetaModifier
Qt3DRender.QPickEvent.KeypadModifier

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property acceptedᅟ: bool

Specifies if event has been accepted

Access functions:

• isAccepted()

• setAccepted()

• Signal acceptedChanged()

property buttonᅟ: Qt3DRender.QPickEvent.Buttons

Specifies mouse button that caused the event

Access functions:

• button()

property buttonsᅟ: int

Specifies state of the mouse buttons for the event

Access functions:

• buttons()

property distanceᅟ: float

Specifies the distance of the hit to the camera

Access functions:

• distance()

property entityᅟ: QEntity

The entity that the picked geometry belongs to.

If the object picker is not attached to a leaf node in the scene graph, this is useful to find which child entity was actually picked.

Access functions:

• entity()

property localIntersectionᅟ: QVector3D

Specifies the coordinates of the hit in the local coordinate system of the picked entity

Access functions:

• localIntersection()

property modifiersᅟ: int

Specifies state of the mouse buttons for the event

Access functions:

• modifiers()

property positionᅟ: QPointF

Specifies the mouse position with respect to the render area (window or quick item)

Access functions:

• position()

property viewportᅟ: QViewport

The viewport in which this event originated. A null value means the event originated from a frame graph branch without a QViewport . If a frame graph branch has a Viewport inside a Viewport the property will contain the leaf viewport.

Access functions:

• viewport()

property worldIntersectionᅟ: QVector3D

Specifies the coordinates of the hit in world coordinate system

Access functions:

• worldIntersection()

__init__()

Constructs a new QPickEvent .

__init__(position, worldIntersection, localIntersection, distance)

Parameters:

• position – QPointF

• worldIntersection – QVector3D

• localIntersection – QVector3D

• distance – float

Constructs a new QPickEvent with the given parameters: position, intersection, localIntersection and distance

__init__(position, worldIntersection, localIntersection, distance, button, buttons, modifiers)

Parameters:

• position – QPointF

• worldIntersection – QVector3D

• localIntersection – QVector3D

• distance – float

• button – Buttons

• buttons – int

• modifiers – int

Constructs a new QPickEvent with the given parameters: position, worldIntersection, localIntersection, distance, button, buttons and modifiers

acceptedChanged(accepted)

Parameters:

accepted – bool

Notification signal of property acceptedᅟ .

button()

Return type:

Buttons

QPickEvent::button Returns mouse button that caused the event

Getter of property buttonᅟ .

buttons()

Return type:

int

QPickEvent::buttons Returns bitfield to be used to check for mouse buttons that may be accompanying the pick event.

Getter of property buttonsᅟ .

distance()

Return type:

float

QPickEvent::distance Returns distance from camera to pick point

Getter of property distanceᅟ .

entity()

Return type:

QEntity

Getter of property entityᅟ .

isAccepted()

Return type:

bool

QPickEvent::isAccepted Returns true if the event has been accepted

Getter of property acceptedᅟ .

localIntersection()

Return type:

QVector3D

QPickEvent::localIntersection Returns coordinates of the hit in the local coordinate system of the picked entity

Getter of property localIntersectionᅟ .

modifiers()

Return type:

int

QPickEvent::modifiers Returns bitfield to be used to check for keyboard modifiers that may be accompanying the pick event.

Getter of property modifiersᅟ .

position()

Return type:

QPointF

QPickEvent::position Returns mouse pointer coordinate of the pick query

Getter of property positionᅟ .

setAccepted(accepted)

Parameters:

accepted – bool

QPickEvent::setAccepted set if the event has been accepted to accepted

See also

isAccepted()

Setter of property acceptedᅟ .

viewport()

Return type:

QViewport

Getter of property viewportᅟ .

worldIntersection()

Return type:

QVector3D

QPickEvent::worldIntersection Returns coordinates of the hit in world coordinate system

Getter of property worldIntersectionᅟ .