xrt_hand_tracker Struct Reference

A hand tracker that owns device/source selection policy. More...

#include <xrt/xrt_hand_tracker.h>

Collaboration diagram for xrt_hand_tracker:

Static Public Member Functions
static xrt_result_t	xrt_hand_tracker_locate (struct xrt_hand_tracker *xht, struct xrt_space_overseer *xso, struct xrt_space *base_space, const struct xrt_pose *base_offset, int64_t at_timestamp_ns, struct xrt_hand_tracker_location *out_location)
	Locate hand joints in the supplied base space.
static XRT_NONNULL_ALL xrt_result_t	xrt_hand_tracker_set_output (struct xrt_hand_tracker *xht, enum xrt_output_name name, const struct xrt_output_value *value)
	Apply output to the selected backing source device(s).
static XRT_NONNULL_ALL void	xrt_hand_tracker_destroy (struct xrt_hand_tracker **xht_ptr)
	Destroy an xrt_hand_tracker - helper function.

Data Fields
xrt_result_t(*	locate )(struct xrt_hand_tracker *xht, struct xrt_space_overseer *xso, struct xrt_space *base_space, const struct xrt_pose *base_offset, int64_t at_timestamp_ns, struct xrt_hand_tracker_location *out_location)
	Locate hand joints in the supplied base space.
xrt_result_t(*	set_output )(struct xrt_hand_tracker *xht, enum xrt_output_name name, const struct xrt_output_value *value)
	Apply output to the selected backing source device(s).
void(*	destroy )(struct xrt_hand_tracker *xht)
	Destroy this hand tracker.

Detailed Description

A hand tracker that owns device/source selection policy.

Member Function Documentation

xrt_hand_tracker_destroy()

static XRT_NONNULL_ALL void xrt_hand_tracker_destroy ( struct xrt_hand_tracker **  xht_ptr )

inlinestatic

Destroy an xrt_hand_tracker - helper function.

Parameters

[in,out]

xht_ptr

A pointer to the xrt_hand_tracker struct pointer.

Will destroy the tracker if *xht_ptr is not NULL. Will then set *xht_ptr to NULL.

References destroy.

Referenced by ipc_server_objects_destroy_xht().

xrt_hand_tracker_locate()

static xrt_result_t xrt_hand_tracker_locate ( struct xrt_hand_tracker *  xht, struct xrt_space_overseer *  xso, struct xrt_space *  base_space, const struct xrt_pose *  base_offset, int64_t  at_timestamp_ns, struct xrt_hand_tracker_location *  out_location  )

inlinestatic

Locate hand joints in the supplied base space.

Parameters

xht	Pointer to self.
xso	Space overseer used to resolve device spaces.
base_space	Space to locate joints in.
base_offset	Offset from base_space.

Note

The base_offset argument can be removed if this offset is folded into the OpenXR XrSpace, but we do not want to change that behavior just yet.

Parameters

at_timestamp_ns	Time to locate at.
out_location	Resulting hand-tracking location.

References locate.

xrt_hand_tracker_set_output()

static XRT_NONNULL_ALL xrt_result_t xrt_hand_tracker_set_output ( struct xrt_hand_tracker *  xht, enum xrt_output_name  name, const struct xrt_output_value *  value  )

inlinestatic

Apply output to the selected backing source device(s).

References set_output.

Field Documentation

destroy

void(* xrt_hand_tracker::destroy) (struct xrt_hand_tracker *xht)

Destroy this hand tracker.

Code consuming this interface should use xrt_hand_tracker_destroy.

Referenced by xrt_hand_tracker_destroy().

locate

xrt_result_t(* xrt_hand_tracker::locate) (struct xrt_hand_tracker *xht, struct xrt_space_overseer *xso, struct xrt_space *base_space, const struct xrt_pose *base_offset, int64_t at_timestamp_ns, struct xrt_hand_tracker_location *out_location)

Locate hand joints in the supplied base space.

Parameters

xht	Pointer to self.
xso	Space overseer used to resolve device spaces.
base_space	Space to locate joints in.
base_offset	Offset from base_space.

Note

The base_offset argument can be removed if this offset is folded into the OpenXR XrSpace, but we do not want to change that behavior just yet.

Parameters

at_timestamp_ns	Time to locate at.
out_location	Resulting hand-tracking location.

Referenced by xrt_hand_tracker_locate().

set_output

xrt_result_t(* xrt_hand_tracker::set_output) (struct xrt_hand_tracker *xht, enum xrt_output_name name, const struct xrt_output_value *value)

Apply output to the selected backing source device(s).

Referenced by xrt_hand_tracker_set_output().

---

The documentation for this struct was generated from the following file:

• xrt/xrt_hand_tracker.h