Struct re_view_spatial::picking::PickingContext

pub struct PickingContext {
    pub pointer_in_ui: Vec2,
    pub pointer_in_pixel: Vec2,
    pub pointer_in_camera_plane: Vec2,
    pub camera_plane_from_ui: RectTransform,
    pub ray_in_world: Ray3,
}

Picking context in which picking is performed.

Fields

pointer_in_ui: Vec2

Cursor position in the UI coordinate system.

pointer_in_pixel: Vec2

Cursor position on the renderer canvas in pixels.

pointer_in_camera_plane: Vec2

Cursor position in the UI coordinates after panning & zooming.

As of writing, for 3D spaces this is equal to Self::pointer_in_ui, since we don’t allow panning & zooming after perspective projection.

camera_plane_from_ui: RectTransform

Transforms ui coordinates to “ui-camera-plane-coordinates” Ui camera plane coordinates are ui coordinates that have been panned and zoomed.

See also Self::pointer_in_camera_plane.

ray_in_world: Ray3

The picking ray used. Given in the coordinates of the space the picking is performed in.

Implementations

impl PickingContext

pub const UI_INTERACTION_RADIUS: f32 = 5f32

Radius in which cursor interactions may snap to the nearest object even if the cursor does not hover it directly.

Note that this needs to be scaled when zooming is applied by the virtual->visible ui rect transform.

pub fn new( pointer_in_ui: Pos2, camera_plane_from_ui: RectTransform, pixels_per_point: f32, eye: &Eye, ) -> Self

Creates a new PickingContext for executing picking operations and providing information about the picking ray & general circumstances.

pub fn pick<'a>( &self, render_ctx: &RenderContext, gpu_readback_identifier: GpuReadbackIdentifier, previous_picking_result: &Option<PickingResult>, images: impl Iterator<Item = &'a PickableTexturedRect>, ui_rects: &[PickableUiRect], ) -> PickingResult

Performs picking for a given scene.