Open 3D Engine OpenXRVk Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Member Functions | Static Public Attributes | List of all members
OpenXRVk::ActionsManager Class Referencefinal

Inherits OpenXRActionsInterface::Registrar, and AZ::Data::AssetBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ActionsManager, AZ::SystemAllocator)
 
 AZ_RTTI (ActionsManager, "{79E2B285-073B-4042-93ED-B92E6C819CA6}", IOpenXRActions)
 
bool Init (XrInstance xrInstance, XrSession xrSession)
 
bool SyncActions (XrTime predictedDisplayTime)
 Called by the Session each tick.
 
void OnInteractionProfileChanged ()
 
AZStd::vector< AZStd::string > GetAllActionSets () const override
 OpenXRActionsInterface overrides.
 
AZ::Outcome< bool, AZStd::string > GetActionSetState (const AZStd::string &actionSetName) const override
 
AZ::Outcome< bool, AZStd::string > SetActionSetState (const AZStd::string &actionSetName, bool activate) override
 
IOpenXRActions::ActionHandle GetActionHandle (const AZStd::string &actionSetName, const AZStd::string &actionName) const override
 
AZ::Outcome< bool, AZStd::string > GetActionStateBoolean (ActionHandle actionHandle) const override
 
AZ::Outcome< float, AZStd::string > GetActionStateFloat (ActionHandle actionHandle) const override
 
AZ::Outcome< AZ::Vector2, AZStd::string > GetActionStateVector2 (ActionHandle actionHandle) const override
 
AZ::Outcome< bool, AZStd::string > SetBaseReferenceSpaceForPoseActions (const AZStd::string &visualizedSpaceName) override
 
const AZStd::string & GetBaseReferenceSpaceForPoseActions () const override
 
AZ::Outcome< AZ::Transform, AZStd::string > GetActionStatePose (ActionHandle actionHandle) const override
 
AZ::Outcome< PoseWithVelocities, AZStd::string > GetActionStatePoseWithVelocities (ActionHandle actionHandle) const override
 
AZ::Outcome< bool, AZStd::string > ApplyHapticVibrationAction (ActionHandle actionHandle, uint64_t durationNanos, float frequencyHz, float amplitude) override
 
AZ::Outcome< bool, AZStd::string > StopHapticVibrationAction (ActionHandle actionHandle) override
 

Static Public Attributes

static constexpr char LogName [] = "OpenXRVkActionsManager"
 

Member Function Documentation

◆ Init()

bool OpenXRVk::ActionsManager::Init ( XrInstance  xrInstance,
XrSession  xrSession 
)
Returns
True if it was able to start the initialization process by queueing asset loading of the Action Sets asset. This is a non-blocking call and the complete initialization will happend asynchronously but it will be transparent to the Session.

◆ OnInteractionProfileChanged()

void OpenXRVk::ActionsManager::OnInteractionProfileChanged ( )

Called by the Session when the event XR_TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED is received.

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