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 |
Properties
- containsMouse : bool
- dragEnabled : bool
- hoverEnabled : bool
- pressed : bool
Signals
- void clicked(PickEvent pick)
- void entered()
- void exited()
- void moved(PickEvent pick)
- void pressed(PickEvent pick)
- void 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: Instances of this component shouldn't be shared, not respecting that condition will most likely result in undefined behavior.
See also PickingSettings, Geometry, Attribute, PickEvent, and PickTriangleEvent.
Property Documentation
Signal Documentation
void clicked(PickEvent pick) |
This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse click.
This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on the mouse entering the volume.
This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on the ray exiting the volume.
void 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.
void pressed(PickEvent pick) |
This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse press.
void released(PickEvent pick) |
This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse release.