Struct Pointer

#[repr(C)]
pub struct Pointer {
    pub source: InputSource,
    pub tracked: BtnState,
    pub state: BtnState,
    pub ray: Ray,
    pub orientation: Quat,
}

Pointer is an abstraction of a number of different input sources, and a way to surface input events! https://stereokit.net/Pages/StereoKit/Pointer.html

see also Input

Examples

use stereokit_rust::{system::{Input, InputSource, Pointer, BtnState, Handed, TrackState},
                     maths::{Vec3, Quat, Pose, Ray}};

// By default we only have the 2 hands.
assert_eq!(Input::pointer_count(None), 2);
let pointer = Input::pointer(0, None);

assert_eq!(pointer.source, InputSource::Hand | InputSource::HandLeft | InputSource::CanPress);
assert_eq!(pointer.state, BtnState::Inactive);
assert_eq!(pointer.tracked, BtnState::Inactive);
assert_eq!(pointer.orientation, Quat::ZERO);
assert_eq!(pointer.ray, Ray::ZERO);
assert_eq!(pointer.get_pose(), Pose::ZERO);

let hand_pointer = Input::pointer(1, Some(InputSource::Hand));
assert_eq!(hand_pointer.source, InputSource::Hand | InputSource::HandRight | InputSource::CanPress);
assert_eq!(pointer.state, BtnState::Inactive);
assert_eq!(pointer.tracked, BtnState::Inactive);
assert_eq!(pointer.orientation, Quat::ZERO);
assert_eq!(pointer.ray, Ray::ZERO);
assert_eq!(pointer.get_pose(), Pose::ZERO);

Fields

source: InputSource

What input source did this pointer come from? This is a bit-flag that contains input family and capability information.

tracked: BtnState

Is the pointer source being tracked right now?

state: BtnState

What is the state of the input source’s ‘button’, if it has one?

ray: Ray

A ray in the direction of the pointer.

orientation: Quat

Orientation of the pointer! Since a Ray has no concept of ‘up’, this can be used to retrieve more orientation information.

Implementations

impl Pointer

pub fn get_pose(&self) -> Pose

Convenience function that turns ray.position and orientation into a Pose. https://stereokit.net/Pages/StereoKit/Pointer/Pose.html

Trait Implementations

impl Clone for Pointer

fn clone(&self) -> Pointer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pointer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for Pointer