ObjectPicker QML Type

The ObjectPicker class instantiates a component that can be used to interact with an Entity by a process known as picking. More...

Import Statement:	import Qt3D.Render 2.0
Instantiates:	QObjectPicker

• List of all members, including inherited members

Properties

• containsMouse : bool
• dragEnabled : bool
• hoverEnabled : bool
• pressed : bool
• priority : int

Signals

• clicked(PickEvent pick)
• clicked(PickEvent pick)
• entered()
• exited()
• moved(PickEvent pick)
• pressed(PickEvent pick)
• released(PickEvent pick)

Detailed Description

For every combination of viewport and camera, picking casts a ray through the scene to find entities who's bounding volume intersects the ray. The bounding volume is computed using the values in the attribute buffer specified by the boundingVolumePositionAttribute of the geometry.

The signals pressed(), released(), clicked(), moved(), entered(), and exited() are emitted when the bounding volume defined by the pickAttribute property intersects with a ray.

Most signals carry a PickEvent instance. If PickingSettings.pickMode is set to PickingSettings.TrianglePicking, the actual type of the pick parameter will be PickTriangleEvent.

Pick queries are performed on mouse press and mouse release. If drag is enabled, queries also happen on each mouse move while any button is pressed. If hover is enabled, queries happen on every mouse move even if no button is pressed.

Note: To receive hover events in QtQuick, the hoverEnabled property of Scene3D must also be set.

Note: Instances of this component shouldn't be shared, not respecting that condition will most likely result in undefined behavior.

Note: The camera far plane value affects picking and produces incorrect results due to floating-point precision if it is greater than ~100 000.

See also PickingSettings, Geometry, Attribute, PickEvent, PickTriangleEvent, and NoPicking.

Property Documentation

containsMouse : bool

Specifies if the object picker currently contains the mouse

dragEnabled : bool

hoverEnabled : bool

Specifies if hover is enabled

pressed : bool

Specifies if the object picker is currently pressed

priority : int

The priority to be used when filtering pick results by priority when PickingSettings.pickResultMode is set to PickingSettings.PriorityPick.

Signal Documentation

clicked(PickEvent pick)

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse click. Intersection information are accessible through the pick parameter.

Note: The corresponding handler is onClicked.

clicked(PickEvent pick)

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse click the PickEvent pick contains details of the event.

Note: The corresponding handler is onClicked.

entered()

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on the mouse entering the volume.

Note: The corresponding handler is onEntered.

exited()

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on the ray exiting the volume.

Note: The corresponding handler is onExited.

moved(PickEvent pick)

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse move with a button pressed. Intersection information are accessible through the pick parameter.

Note: The corresponding handler is onMoved.

pressed(PickEvent pick)

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse press. Intersection information are accessible through the pick parameter.

Note: The corresponding handler is onPressed.

released(PickEvent pick)

This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse release. Intersection information are accessible through the pick parameter.

Note: The corresponding handler is onReleased.