The XrManageThumbStickActions class is responsible for managing thumb stick input from hand tracking devices in an OpenXR application. More...

#include <headers/evan/openxr/actions/XrManageThumbStickActions.hpp>

Inheritance diagram for evan::XrManageThumbStickActions:

[legend]

Collaboration diagram for evan::XrManageThumbStickActions:

[legend]

Public Member Functions
	XrManageThumbStickActions (XrActionSet actionSet, XrDeviceBackend &deviceBackend)
	Constructs an XrManageThumbStickActions instance with the specified action set and device backend.

	~XrManageThumbStickActions ()
	Destructor for the XrManageThumbStickActions class.

std::vector< std::shared_ptr< utility::event::Event > >	getEvents (evan::XrDeviceBackend &deviceBackend)
	Retrieves the current thumb stick events from the device backend.

Public Attributes
std::unique_ptr< XrHandThumbStickAction >	_leftHandThumbStickActions
	Unique pointer to the action associated with the left hand thumb stick.

std::unique_ptr< XrHandThumbStickAction >	_rightHandThumbStickActions
	Unique pointer to the action associated with the right hand thumb stick.

Detailed Description

The XrManageThumbStickActions class is responsible for managing thumb stick input from hand tracking devices in an OpenXR application.

This class encapsulates the functionality required to define and manage thumb stick input actions for hand tracking devices. It provides an interface for integrating thumb stick input capabilities into an OpenXR application, allowing developers to create immersive experiences that utilize thumb stick gestures and movements from hand tracking devices.

Definition at line 109 of file XrManageThumbStickActions.hpp.

Constructor & Destructor Documentation

◆ XrManageThumbStickActions()

evan::XrManageThumbStickActions::XrManageThumbStickActions	(	XrActionSet	actionSet,
		XrDeviceBackend &	deviceBackend
	)

Constructs an XrManageThumbStickActions instance with the specified action set and device backend.

This constructor initializes the thumb stick actions by creating the necessary OpenXR actions for thumb stick input based on the provided action set and device backend. It sets up the required action handles and spaces for thumb stick tracking.

Parameters

actionSet	The OpenXR action set to which the thumb stick actions will belong.
deviceBackend	The device backend used for interacting with the OpenXR runtime and managing resources.

Definition at line 57 of file XrManageThumbStickActions.cpp.

◆ ~XrManageThumbStickActions()

evan::XrManageThumbStickActions::~XrManageThumbStickActions ( )

Destructor for the XrManageThumbStickActions class.

This destructor is responsible for cleaning up any resources associated with the thumb stick actions, such as destroying action spaces and releasing OpenXR handles. It ensures that all resources are properly released when an instance of XrManageThumbStickActions is destroyed.

Definition at line 93 of file XrManageThumbStickActions.cpp.

Member Function Documentation

◆ getEvents()

std::vector< std::shared_ptr< utility::event::Event > > evan::XrManageThumbStickActions::getEvents ( evan::XrDeviceBackend & deviceBackend )

Retrieves the current thumb stick events from the device backend.

This method queries the device backend for the current state of thumb stick input and generates a list of events based on the thumb stick movements and gestures detected. It returns a vector of unique pointers to Event objects representing the thumb stick events that have occurred since the last query.

Parameters

deviceBackend The device backend used for interacting with the OpenXR runtime and managing resources.

Returns: A vector of shared pointers to Event objects representing the thumb stick events.

Definition at line 103 of file XrManageThumbStickActions.cpp.

Member Data Documentation

◆ _leftHandThumbStickActions

std::unique_ptr<XrHandThumbStickAction> evan::XrManageThumbStickActions::_leftHandThumbStickActions

Unique pointer to the action associated with the left hand thumb stick.

This member holds the action object responsible for handling input events related to the left hand thumb stick. It is initialized during the construction of the XrManageThumbStickActions class.

Definition at line 165 of file XrManageThumbStickActions.hpp.

◆ _rightHandThumbStickActions

std::unique_ptr<XrHandThumbStickAction> evan::XrManageThumbStickActions::_rightHandThumbStickActions

Unique pointer to the action associated with the right hand thumb stick.

This member holds the action object responsible for handling input events related to the right hand thumb stick. It is initialized during the construction of the XrManageThumbStickActions class.

Definition at line 175 of file XrManageThumbStickActions.hpp.

The documentation for this class was generated from the following files:

headers/evan/openxr/actions/XrManageThumbStickActions.hpp
sources/openxr/actions/XrManageThumbStickActions.cpp

Public Member Functions

Public Attributes