docs.unity3d.com
    Show / Hide Table of Contents

    Namespace Unity.XR.CoreUtils

    Classes

    BoundsExtensions

    Extension methods for the Bounds type

    BoundsUtils

    Bounds related utilities

    CachedComponentFilter<TFilterType, TRootType>

    Class that allows for cached retrieval/filtering of multiple types of components into lists Proper usage of this class is:

    using (var componentFilter = new CachedComponentFilter<typeToFind,componentTypeThatContains>(instanceOfComponent))
    {
    
    }

    CameraExtensions

    Extension methods for Camera components

    CollectionExtensions

    Extension methods for ICollection objects

    CollectionPool<TCollection, TValue>

    A generic collection pool for avoiding allocations when new empty collections are needed frequently

    ComponentUtils

    Utility class for working with Components

    ComponentUtils<T>

    Special utility class for getting components in the editor without allocations

    DebugDraw

    Helpers for drawing shapes for debugging purposes.

    DictionaryExtensions

    Extension methods for Dictionary objects

    EnumValues<T>

    Helper class for caching enum values

    GameObjectExtensions

    Extensions methods for GameObjects

    GameObjectUtils

    Utility methods for creating GameObjects Allows systems to subscribe to GameObjectInstantiated

    GeometryUtils

    Utility methods for common geometric operations

    GuidExtensions

    Extensions to System.Guid

    GuidUtil

    Utility for dealing with Guids.

    HashSetExtensions

    Extension methods for HashSet<T> objects

    LayerMaskExtensions

    Extension methods for LayerMask structs

    ListExtensions

    Extension methods for List<T> objects

    MaterialUtils

    Runtime Material utilities

    MathUtility

    Math utilities

    MonoBehaviourExtensions

    Extension methods for MonoBehaviour objects

    NativeArrayUtils

    Utility methods for NativeArray<T>

    ObjectPool<T>

    Instance pool for objects

    OnDestroyNotifier

    Behavior that fires a callback when it is destroyed.

    PoseExtensions

    Extension methods for Pose structs

    QuaternionExtensions

    Extension methods for Quaternion structs

    ReadOnlyAttribute

    Serialized fields marked with the ReadOnly attribute will use a CustomPropertyDrawer to disable UI on the property

    ReflectionUtils

    Utility methods for common reflection-based operations

    ScriptableSettings<T>

    Based off of Unity's Internal ScriptableSingleton with UnityEditorInternal bits removed

    ScriptableSettingsBase

    Base for all scriptable settings that is easier to look up via-reflection. DO NOT USE THIS CLASS DIRECTLY - Use the generic version - ScriptableSettingsBase above

    ScriptableSettingsBase<T>

    Base class for ScriptableSettings

    ScriptableSettingsPathAttribute

    Allows a class inheriting from ScriptableSettings<T> to specify that its instance Asset should be saved under "Assets/[Path]/Resources/ScriptableSettings/".

    SerializableGuidUtil

    Utility for creating a Unity.XR.CoreUtils.SerializableGuid. A SerializableGuid can be serialized by Unity, while a System.Guid cannot.

    StopwatchExtensions

    Extension methods for Stopwatch objects

    StringExtensions

    Extension methods for strings

    TextureUtils

    Utilities for manipulating Textures

    TransformExtensions

    Extension methods for Transform components

    TypeExtensions

    Extension methods for Type objects

    UndoBlock

    Class that automatically groups a series of object actions together as a single undo-operation And works in both the editor and player (with player support simply turning off undo-operations) Mirrors the normal functions you find in the Undo class and collapses them into one operation when the block is complete Proper usage of this class is: using (var undoBlock = new UndoBlock("Desired Undo Message")) { undoBlock.yourCodeToUndo() }

    UnityObjectUtils

    Utility methods for working with UnityEngine.Object types

    Vector2Extensions

    Extension methods for the Vector2 type

    Vector3Extensions

    Extension methods for the Vector3 type

    XRLoggingUtils

    Utility methods for logging. These methods will not log anything if tests are being run via command line

    XROrigin

    The XR Origin component is typically attached to the base object of the XR Origin, and stores the GameObject that will be manipulated via locomotion. It is also used for offsetting the camera.

    Structs

    ARTrackablesParentTransformChangedEventArgs

    Event arguments for the TrackablesParentTransformChanged event.

    SerializableGuid

    A Guid that can be serialized by Unity. The 128-bit Guid is stored as two 64-bit ulongs. See also the creation utility at UnityEditor.XR.ARSubsystems.SerializableGuidUtil.

    Interfaces

    IComponentHost<THostType>

    Use this interface if you have a component that contains many instances of something you want discoverable by the cached component filter. Make sure the THostType matches up with the TFilterType in the CachedComponent filter

    Enums

    CachedSearchType

    Describes where the initial list of components should be built from

    XROrigin.TrackingOriginMode

    Sets which Tracking Origin Mode to use when initializing the input device.

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023