reckfellENGINE

OpenXRInteractionProfileMetadata

Meta class registering supported devices in OpenXR.

On this page
class OpenXRInteractionProfileMetadataReckfellSharpInherits ReckfellObject

Meta class registering supported devices in OpenXR.

This class allows OpenXR core and extensions to register metadata relating to supported interaction devices such as controllers, trackers, haptic devices, etc. It is primarily used by the action map editor and to sanitize any action map by removing extension-dependent entries when applicable.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

OpenXRInteractionProfileMetadataConstructor
# OpenXRInteractionProfileMetadata
C#
public OpenXRInteractionProfileMetadata();

Methods5

RegisterIOPathvoid
# RegisterIOPath
C#
public void RegisterIOPath(string interactionProfile, string displayName, string toplevelPath, string openxrPath, string openxrExtensionNames, OpenXRAction.ActionTypeEnum actionType);

Registers an input/output path for the given interaction_profile. The profile should previously have been registered using OpenXRInteractionProfileMetadata.RegisterInteractionProfile. display_name is the description shown to the user. toplevel_path specifies the bind path this input/output can be bound to (e.g. /user/hand/left or /user/hand/right). openxr_path is the action input/output being registered (e.g. /user/hand/left/input/aim/pose). openxr_extension_names restricts this input/output to an enabled/available extension, this doesn't need to repeat the extension on the profile but relates to overlapping extension (e.g. XR_EXT_palm_pose that introduces …/input/palm_ext/pose input paths). action_type defines the type of input or output provided by OpenXR.

Parameters
NameTypeDefault
interactionProfilestring—
displayNamestring—
toplevelPathstring—
openxrPathstring—
openxrExtensionNamesstring—
actionTypeOpenXRAction.ActionTypeEnum—
RegisterInteractionProfilevoid
# RegisterInteractionProfile
C#
public void RegisterInteractionProfile(string displayName, string openxrPath, string openxrExtensionNames);

Registers an interaction profile using its OpenXR designation (e.g. /interaction_profiles/khr/simple_controller is the profile for OpenXR's simple controller profile). display_name is the description shown to the user. openxr_path is the interaction profile path being registered. openxr_extension_names optionally restricts this profile to the given extension being enabled/available. If the extension is not available, the profile and all related entries used in an action map are filtered out.

Parameters
NameTypeDefault
displayNamestring—
openxrPathstring—
openxrExtensionNamesstring—
RegisterPathRenamevoid
# RegisterPathRename
C#
public void RegisterPathRename(string oldName, string newName);

Allows for renaming old input/output paths to new paths in order to load and process older action maps.

Parameters
NameTypeDefault
oldNamestring—
newNamestring—
RegisterProfileRenamevoid
# RegisterProfileRename
C#
public void RegisterProfileRename(string oldName, string newName);

Allows for renaming old interaction profile paths to new paths in order to load and process older action maps.

Parameters
NameTypeDefault
oldNamestring—
newNamestring—
RegisterTopLevelPathvoid
# RegisterTopLevelPath
C#
public void RegisterTopLevelPath(string displayName, string openxrPath, string openxrExtensionNames);

Registers a top level path to which profiles can be bound. For instance /user/hand/left refers to the bind point for the player's left hand. Extensions can register additional top level paths, for instance a haptic vest extension might register /user/body/vest. display_name is the name shown to the user. openxr_path is the top level path being registered. openxr_extension_names is optional and ensures the top level path is only used if the specified extension is available/enabled. When a top level path ends up being bound by OpenXR, an XRPositionalTracker is instantiated to manage the state of the device.

Parameters
NameTypeDefault
displayNamestring—
openxrPathstring—
openxrExtensionNamesstring—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.