Open 3D Engine OpenXRVk Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
OpenXRVk::Input Class Referencefinal

Inherits XR::Input.

Public Member Functions

 AZ_CLASS_ALLOCATOR (Input, AZ::SystemAllocator)
 
 AZ_RTTI (Input, "{97ADD1FE-27DF-4F36-9F61-683F881F9477}", XR::Input)
 
void PollActions ()
 
AZ::RHI::ResultCode InitializeActionSpace (XrSession xrSession)
 Create controller action spaces.
 
AZ::RHI::ResultCode InitializeActionSets (XrSession xrSession) const
 Attach action sets.
 
void LocateControllerSpace (XrTime predictedDisplayTime, XrSpace baseSpace, AZ::u32 handIndex)
 Update Controller space information.
 
void LocateVisualizedSpace (XrTime predictedDisplayTime, XrSpace space, XrSpace baseSpace, OpenXRVk::SpaceType visualizedSpaceType)
 Update information for a specific tracked space type (i.e visualizedSpaceType)
 
AZ::RHI::ResultCode GetControllerPose (AZ::u32 handIndex, AZ::RPI::PoseData &outPoseData) const
 Return Pose data for a controller attached to a hand index.
 
float GetControllerScale (AZ::u32 handIndex) const
 Return scale for a controller attached to a hand index.
 
AZ::RHI::ResultCode GetVisualizedSpacePose (OpenXRVk::SpaceType visualizedSpaceType, AZ::RPI::PoseData &outPoseData) const
 Return Pose data for a tracked space type (i.e visualizedSpaceType)
 
XrAction GetSqueezeAction (AZ::u32 handIndex) const
 Get the Squeeze action.
 
XrAction GetPoseAction (AZ::u32 handIndex) const
 Get the Pose action.
 
XrAction GetVibrationAction () const
 Get the Vibration action.
 
XrAction GetQuitAction () const
 Get the Quit action.
 
bool GetButtonState (const AzFramework::InputChannelId &channelId) const
 Get any button state.
 
bool GetXButtonState () const
 Get the X button state.
 
bool GetYButtonState () const
 Get the Y button state.
 
bool GetAButtonState () const
 Get the A button state.
 
bool GetBButtonState () const
 Get the B button state.
 
float GetXJoyStickState (AZ::u32 handIndex) const
 Get the joystick state for x-axis.
 
float GetYJoyStickState (AZ::u32 handIndex) const
 Get the joystick state for y-axis.
 
float GetSqueezeState (AZ::u32 handIndex) const
 Get the Squeeze action.
 
float GetTriggerState (AZ::u32 handIndex) const
 Get the Squeeze action.
 

Static Public Member Functions

static XR::Ptr< InputCreate ()
 

Member Function Documentation

◆ PollActions()

void OpenXRVk::Input::PollActions ( )

Sync all the actions and update controller as well as various tracked space poses


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