1. Epic GamesDeveloper
  3. FOpenXRActionPoseManager

FOpenXRActionPoseManager

The ActionPoseManager has two primary jobs:

API > API/Plugins > API/Plugins/XRScribe

References

   
Module XRScribe
Header /Engine/Plugins/Runtime/XR/XRScribe/Source/XRScribe/Public/XRScribeEmulatedPoseManager.h
Include #include "XRScribeEmulatedPoseManager.h"

Syntax

class FOpenXRActionPoseManager

Remarks

The ActionPoseManager has two primary jobs:

  • ingest data from capture
  • generate estimated poses/actions based on captured state + timings

When using the ActionPoseManager, we'll interact with it similarly to xrLocateSpace: give it time and spaces, and return locations. On the Action side, give it an action and sync time, and we return an action state.

Internally, we'll plan to have all managed poses in tracker-space, and convert to the different spaces as needed. This does mean we'll need to know how to convert between different spaces, even if the original capture might not tell us how to

Variables

  Type Name Description
Protected variable TMap< FName, TArray< FOpenXRLocateSpacePacket > > ActionPoseHistories  
Protected variable TMap< FName, TArray< FOpenXRGetActionStateBooleanPacket > > BooleanActionStateHistories  
Protected variable TMap< FName, FBooleanActionStateHistory > BooleanProcessedHistories  
Protected variable TMap< FName, XrActionStateBoolean > CachedEmulatedBooleanStates  
Protected variable TMap< FName, XrActionStateFloat > CachedEmulatedFloatStates  
Protected variable TMap< FName, XrActionStateVector2f > CachedEmulatedVector2fStates  
Protected variable TMap< XrAction, FOpenXRCreateActionPacket > CapturedActions  
Protected variable TArray< FOpenXRCreateActionSpacePacket > CapturedActionSpaces  
Protected variable TMap< XrPath, FName > CapturedPaths  
Protected variable XrTime CapturedRangeEnd  
Protected variable XrTime CapturedRangeStart  
Protected variable TMap< XrAction, TArray< FOpenXRGetActionStateBooleanPacket > > CapturedRawBooleanActionStates TArray CapturedRawSyncActionsPackets;.
Protected variable TMap< XrAction, TArray< FOpenXRGetActionStateFloatPacket > > CapturedRawFloatActionStates  
Protected variable TMap< XrAction, TArray< FOpenXRGetActionStatePosePacket > > CapturedRawPoseActionStates  
Protected variable TMap< XrSpace, TArray< FOpenXRLocateSpacePacket > > CapturedRawSpaceHistories  
Protected variable TMap< XrAction, TArray< FOpenXRGetActionStateVector2fPacket > > CapturedRawVectorActionStates  
Protected variable TArray< FOpenXRCreateReferenceSpacePacket > CapturedReferenceSpaces Known spaces and relevant actions from capture.
Protected variable int64 CapturedSliceCount  
Protected variable TMap< XrAction, FName > EmulatedActionNames  
Protected variable TMap< XrSpace, FName > EmulatedActionSpaceNameMap  
Protected variable XrTime EmulatedBaseTime  
Protected variable TMap< XrPath, FName > EmulatedPaths  
Protected variable TMap< XrSpace, XrReferenceSpaceType > EmulatedReferenceSpaceTypeMap Map of emulated spaces to their underlying reference space type (if applicable)
Protected variable TMap< FName, TArray< FOpenXRGetActionStateFloatPacket > > FloatActionStateHistories  
Protected variable TMap< FName, FFloatActionStateHistory > FloatProcessedHistories  
Protected variable TStaticArray< FrameTimeHistoryEntry, PoseHistorySize > FrameTimeHistory History of frame times, in order for pose manager to look into to estimate the relative frame index for times.
Protected variable int32 LastInsertedFrameIndex  
Protected variable TMap< FName, TArray< FOpenXRGetActionStatePosePacket > > PoseActionStateHistories  
Protected variable TMap< XrReferenceSpaceType, TArray< FOpenXRLocateSpacePacket > > ReferencePoseHistories Processed pose histories for space types, which could be unified across different space handles with the same underlying reference space type.
Protected variable TMap< FName, FVector2fActionStateHistory > Vector2fProcessedHistories  
Protected variable TMap< FName, TArray< FOpenXRGetActionStateVector2fPacket > > VectorActionStateHistories  
Protected variable TArray< FOpenXRWaitFramePacket > WaitFrameHistory  

Functions

  Type Name Description
Public function void

AddEmulatedFrameTime ( XrTime Time,
int32 FrameNum
)

 Add time and frame number in order to generate interpolated poses We use the frame numbers to index into a relative history of the poses, and the time for frame matching + interpolation, because LocateSpace calls only provide a time argument
Protected function void Helper function to determine full time range of capture
Public function bool

DoesActionContainPoseHistory ( TStaticArray< ANSICHAR, XR_MAX_ACTION_NAME_SIZE >& ActionName
)

 If we have a pose history for the action, then xrGetActionStatePose can tell the client that the action is active, and poses are ready to fetch
Protected function bool

FilterSpaceHistory ( const TArray< FOpenXRLocateSpacePacket >& RawHistory,
TArray< FOpenXRLocateSpacePacket >& FilteredHistory
)

 Sort and remove duplicates in history for single space
Protected function int64

GenerateReplaySliceIndexFromTime ( XrTime EmulatedTime
)

 Helper function to generate index into captured history from emulated time (offset from emulated session start)
Protected function const XrActionStateBoolean Helper function to managed 'cached' action states, because we're only supposed to update on state changes
Protected function const XrActionStateFloat  
Protected function const XrActionStateVector2f  
Protected function XrReferenceSpaceType

GetCapturedReferenceSpaceType ( XrSpace CapturedSpace
)

 Helper function to fetch underlying reference space type from opaque XrSpace handle
Protected function FName

GetEmulatedActionName ( XrAction Action
)

  
Public function XrActionStateBoolean

GetEmulatedActionStateBoolean ( const XrActionStateGetInfo* GetInfo,
XrTime LastSyncTime
)

 Fetch an action state generated from the captured history, by using XrActionStateGetInfo and most recent sync time The function itself is used to designate between different action state histories (bool, float, vector2f).
Public function XrActionStateFloat

GetEmulatedActionStateFloat ( const XrActionStateGetInfo* GetInfo,
XrTime LastSyncTime
)

  
Public function XrActionStateVector2f

GetEmulatedActionStateVector2f ( const XrActionStateGetInfo* GetInfo,
XrTime LastSyncTime
)

  
Public function XrSpaceLocation

GetEmulatedPoseForTime ( XrSpace LocatingSpace,
XrSpace BaseSpace,
XrTime Time
)

 Fetch a pose generated from the captured history, by using space handles and times generated by the emulated runtime
Public function void Reset internal emulation state based on session teardown.
Protected function void  
Public function void Process all captured pose and action state histories at once, in order to create a unified timeline
Protected function void  
Public function void

RegisterCapturedActions ( const TArray< FOpenXRCreateActionPacket >& CreateActionPackets
)

 Register information about actions from capture file, in order to fetch action name for mapping between capture and emulation
Public function void

RegisterCapturedActionSpaces ( const TArray< FOpenXRCreateActionSpacePacket >& CreateActionSpacePackets
)

 Register information about action spaces from capture file, which we need to build a history of space locations for XR devices
Public function void

RegisterCapturedActionStates ( const TArray< FOpenXRSyncActionsPacket >& SyncActionsPackets,
const TMap< XrAction, TArray< FOpenXRGetActionStateBooleanPacket > >& BooleanActionStates,
const TMap< XrAction, TArray< FOpenXRGetActionStateFloatPacket > >& FloatActionStates,
const TMap< XrAction, TArray< FOpenXRGetActionStateVector2fPacket > >& VectorActionStates,
const TMap< XrAction, TArray< FOpenXRGetActionStatePosePacket > >& PoseActionStates
)

 Register history of GetActionState + SyncActions calls
Public function void

RegisterCapturedPathStrings ( const TMap< XrPath, FName >& PathStringMap
)

 Register information about paths to path strings from the capture
Public function void Register information about reference spaces from a capture file, in order to build a history of space locations relative to those reference spaces.
Public function void

RegisterCapturedSpaceHistories ( const TMap< XrSpace, TArray< FOpenXRLocateSpacePacket > >& SpaceHistories
)

 Register history of LocateSpace calls
Public function void

RegisterCapturedWaitFrames ( const TArray< FOpenXRWaitFramePacket >& InWaitFrameHistory
)

 Register information about wait frames from a capture file, in order to build a history of display times
Public function void

RegisterEmulatedAction ( FName ActionName,
XrAction Action,
XrActionType ActionType
)

 Register emulated action.
Public function void

RegisterEmulatedActionSpace ( TStaticArray< ANSICHAR, XR_MAX_ACTION_NAME_SIZE >& ActionName,
const XrActionSpaceCreateInfo& SpaceCreateInfo,
XrSpace SpaceHandle
)

 Register emulated action space.
Public function void

RegisterEmulatedPath ( FName PathString,
XrPath Path
)

 Register emulated path. Manager needs this to match paths between capture and emulation.
Public function void

RegisterEmulatedReferenceSpace ( const XrReferenceSpaceCreateInfo& CreateInfo,
XrSpace SpaceHandle
)

 Register emulated reference space.
Protected function void

SetCachedEmulatedBooleanState ( FName ActionName,
const XrActionStateBoolean& EmulatedState
)

  
Protected function void

SetCachedEmulatedFloatState ( FName ActionName,
const XrActionStateFloat& EmulatedState
)

  
Protected function void

SetCachedEmulatedVector2fState ( FName ActionName,
const XrActionStateVector2f& EmulatedState
)

  
Protected function TArray< FOpenXRLocateSpacePacket > Resample the filtered history in order to ease reading poses back based on time offsets during emulation
Protected function bool

ValidateSubpath ( const TSet< FName >& ValidSubpaths,
XrPath ActionSubPath
)

  
Protected function bool

VerifyCapturedActionSpace ( XrSpace CapturedSpace
)

 Helper function to validate captured space is an action space

Classes

  Type Name Description
Protected struct FrameTimeHistoryEntry    
Protected struct TActionState    
Protected struct TActionStateHistory    

Typedefs

Name Description
FBooleanActionState  
FBooleanActionStateHistory  
FFloatActionState  
FFloatActionStateHistory  
FVector2fActionState  
FVector2fActionStateHistory  

Constants

Name Description
PoseHistorySize Number of poses the manager will keep available relative to 'current' pose, in order for multi-frame pose queries.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page