OpenXRInteractionProfileMetadata

Documentation

Overview

Package OpenXRInteractionProfileMetadata provides methods for working with OpenXRInteractionProfileMetadata object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsOpenXRInteractionProfileMetadata() Instance
  • func (self Instance) RegisterInteractionProfile(display_name string, openxr_path string, openxr_extension_name string)
  • func (self Instance) RegisterIoPath(interaction_profile string, display_name string, toplevel_path string, ...)
  • func (self Instance) RegisterProfileRename(old_name string, new_name string)
  • func (self Instance) RegisterTopLevelPath(display_name string, openxr_path string, openxr_extension_name string)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsOpenXRInteractionProfileMetadata() Instance
}

type Instance

type Instance [1]gdclass.OpenXRInteractionProfileMetadata

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.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsOpenXRInteractionProfileMetadata

func (self Instance) AsOpenXRInteractionProfileMetadata() Instance

func (Instance) RegisterInteractionProfile

func (self Instance) RegisterInteractionProfile(display_name string, openxr_path string, openxr_extension_name string)

Registers an interaction profile using its OpenXR designation (e.g. [code]/interaction_profiles/khr/simple_controller[/code] is the profile for OpenXR's simple controller profile). [param display_name] is the description shown to the user. [param openxr_path] is the interaction profile path being registered. [param openxr_extension_name] 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.

func (Instance) RegisterIoPath

func (self Instance) RegisterIoPath(interaction_profile string, display_name string, toplevel_path string, openxr_path string, openxr_extension_name string, action_type gdclass.OpenXRActionActionType)

Registers an input/output path for the given [param interaction_profile]. The profile should previously have been registered using [method register_interaction_profile]. [param display_name] is the description shown to the user. [param toplevel_path] specifies the bind path this input/output can be bound to (e.g. [code]/user/hand/left[/code] or [code]/user/hand/right[/code]). [param openxr_path] is the action input/output being registered (e.g. [code]/user/hand/left/input/aim/pose[/code]). [param openxr_extension_name] 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. [code]XR_EXT_palm_pose[/code] that introduces [code]…/input/palm_ext/pose[/code] input paths). [param action_type] defines the type of input or output provided by OpenXR.

func (Instance) RegisterProfileRename

func (self Instance) RegisterProfileRename(old_name string, new_name string)

Allows for renaming old interaction profile paths to new paths to maintain backwards compatibility with older action maps.

func (Instance) RegisterTopLevelPath

func (self Instance) RegisterTopLevelPath(display_name string, openxr_path string, openxr_extension_name string)

Registers a top level path to which profiles can be bound. For instance [code]/user/hand/left[/code] 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 [code]/user/body/vest[/code]. [param display_name] is the name shown to the user. [param openxr_path] is the top level path being registered. [param openxr_extension_name] 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, a [XRPositionalTracker] is instantiated to manage the state of the device.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value