DOCSEARCHbyAlgolia
Submit Docs

UltimateXR API Reference

website·Indexed 32 days ago

https://www.ultimatexr.io

API documentation for the UltimateXR framework, featuring classes and components for VR interaction, including UxrHandTracking, UxrLaserPointer, UxrFingerTip, and a Unity Input Module for UI interaction, 3D buttons, and virtual keyboards.

Tokens
711.3K
Snippets
4.6K
Records
7K
Agent score
55%

What's inside UltimateXR

  1. Overview of UxrWeaponManager

    UxrWeaponManager is a singleton manager that handles the lifecycle of projectiles and the calculation of hits and damage against UxrActor components. It is part of the UltimateXR.Mechanics.Weapons namespace.
    public class UxrWeaponManager : UxrSingleton<UxrWeaponManager>, IUxrLogger

  2. Overview of UltimateXR.Extensions.System Namespace

    The UltimateXR.Extensions.System namespace provides a set of extension classes designed to extend the functionality of standard .NET system types, including Enums, Objects, Strings, and Types.

  3. Overview of UxrMathUtils Class

    The UxrMathUtils class in the UltimateXR.Core.Math namespace provides static mathematical computations for elements that do not belong to a specific class. While most math functionality in UltimateXR is found in extension classes (e.g., UltimateXR.Extensions.System.Math, UltimateXR.Extensions.Unity.Math) or animation-specific namespaces (e.g., UltimateXR.Animation.IK), UxrMathUtils contains general-purpose math functionality that cannot be assigned to those extensions.
    public static class UxrMathUtils

  4. Overview of the UltimateXR Framework

    UltimateXR is a free, open-source framework and toolkit designed for Unity to simplify the development of virtual reality (VR) applications. It provides a scalable architecture focused on high-quality user experience, interactivity, immersion, and professional coding standards to help developers—ranging from indie creators to large companies and academic institutions—build VR applications more efficiently.

  5. Overview of the UltimateXR VR Framework

    UltimateXR is a free, open-source (MIT license) professional-grade framework and toolkit for Unity. It is designed to simplify the development of virtual reality applications, ranging from simple prototypes and simulators to full AAA-scale projects.

    Key capabilities include:

    • Cross-device compatibility: Support for all major VR headsets.
    • Interaction Mechanics: State-of-the-art grab and manipulation systems, and an integrated hand pose editor.
    • Avatars: Customizable full-body avatar representation with Inverse Kinematics (IK) and a library of inclusive, gender- and race-agnostic hands.
    • Locomotion & UI: Support for multiple locomotion mechanics and advanced UI components featuring interaction and tweening.
    • Developer Experience: Scalable architecture, clean code documented via standard XML, and a comprehensive set of tools and extensions to accelerate development.

  6. Overview of UltimateXR Manipulation Components

    UltimateXR uses three primary components to handle object interaction in VR:

    • UxrGrabber: Added to each hand of an avatar to enable the ability to grab objects.
    • UxrGrabbableObject: Added to an object to make it grabbable by an avatar.
    • UxrGrabbableObjectAnchor: Used to define a location where a UxrGrabbableObject can be placed/snapped.

  7. Overview of the UxrInterpolator class

    The UxrInterpolator class is a static utility class located in the UltimateXR.Animation.Interpolation namespace. It provides a wide range of interpolation modes to transition between values, including specialized functionality for creating a typewriter effect when interpolating between two strings.
    using UltimateXR.Animation.Interpolation;

// UxrInterpolator is a static class used for value interpolation

  8. Overview of UltimateXR.Extensions.Unity.IO Namespace

    The UltimateXR.Extensions.Unity.IO namespace provides a set of extension classes designed to simplify and extend the functionality of standard Unity I/O and asynchronous operations. It includes specialized extensions for AsyncOperation, Resources, and UnityWebRequest.

  9. Overview of UltimateXR VR/AR Framework for Unity

    UltimateXR is a free, open-source framework for Unity designed to simplify the development of Virtual Reality (VR) and Augmented Reality (AR) content. It provides a set of high-level features to ensure cross-device compatibility and a consistent user experience, including:

    • Grab and manipulation mechanics
    • Gender- and race-agnostic hand libraries for inclusivity
    • Customizable full-body avatar representations
    • Advanced UI components
    • Locomotion mechanics

  10. Overview of the UltimateXR Hand Pose Editor

    The Hand Pose Editor is used to create hand gestures and grab poses for avatars. These poses are stored as .asset files in the project and are utilized by several key components:

    • UxrStandardAvatarController: Manages which pose is active based on controller input. It supports specific pose types:
      • Grab: Typically assigned to the grip button; triggers grabbing functionality for UxrGrabbableObject components.
      • Pointing: Used for UI touch interaction. The hand adopts this pose when inside a UxrFingerPointingVolume.
      • Other: General poses assigned to button events without special functional behavior.
    • UxrGrabbableObject: Allows specifying a specific hand pose to use when snapping to a grabbable object.
    • UxrFirearmWeapon: Requires a UxrGrabbableObject and uses a Blend Pose to transition from a released trigger to a fully pulled trigger.

  11. Overview of UltimateXR.Extensions.Unity Namespace

    The UltimateXR.Extensions.Unity namespace provides utility extension classes designed to extend the functionality of standard Unity engine types. These extensions allow for more concise and efficient manipulation of Unity objects within the UltimateXR environment.

  12. Overview of UltimateXR.Extensions.Unity.Render namespace

    The UltimateXR.Extensions.Unity.Render namespace provides utility extension classes for various Unity rendering components and data types. These extensions allow for more streamlined manipulation of colors, meshes, textures, and renderers within the Unity engine.