ImmerseSDK Namespace

This is a core component of Immerse SDK. An instance of this must be included in the scene at build index #0. This component will not be destroyed on scene load and will persist throughout the application, any additional instances will be automatically destroyed. The Inspector for the App component shows connection information and can be used to enable Offline Mode for quicker testing.

Represents the main and accent color values used to colorise the default avatar render that ships with the Immerse SDK.

A synchroniser to send avatar recordings to remote users

Payload data

A component for animating the alpha of a CanvasGroup, useful for UI fading

Helper methods for rotation calculations

An implementation of the SDK's abstract AvatarRendererHand class that defines the hand of the default avatar that ships with the Immerse SDK. This implementation uses a single skinned mesh and animator to display all of the hand's different poses.

An implementation of the SDK's abstract AvatarRendererHead class that defines the head of the default avatar that ships with the Immerse SDK.

An implementation of the SDK's abstract AvatarRenderer class that defines the default avatar that ships with the Immerse SDK. This implementation uses the same model for all avatars, but it differentiates them with colors selected from a list using an index based on the avatar's Visual Id.

Set the number of decimal places this float/double should display

Makes the object target not be destroyed automatically when loading a new scene.

Added to Gameobject with engageable Object on to override global setting for haptic feedback

A collection of enum utility methods

File helpers for copying, deleting, etc

Indices for message parts

A wrapped Dictionary, with a string key, for managing items so that they can be easily recovered when needed

A static class to encapsulates the ImmerseSDK layers in Unity

Loads a scene additively. You have to make sure you have this scene in your build settings when you build the packages.

Global Log class for writing output to the local log file (VR) or the console (WebGL)

Base class for components that exposes a way to enable verbose logging on individual instances at runtime

Helper methods for performing tasks on Materials

Some math helper methods

Native Methods that is platform specific

Outline for objects

Draws a snapping guide of an object. Note that this snapping guide does not update dynamically, so the hierarchy is assumed to stay constant.

Helper class for project setup tasks

importer for recording files loads the binary data in and converts it to scriptable object

Utility class that provides methods for testing if a point is within a rectangle within 3D space.

An common object index that can be used for adding indexed items at runtime

Handles indexing of IndexedMonoBehaviours, avatar spawning and scene settings. A Scene component is required for each scene in a ImmerseSDK project.

Indexes objects within a scene so they can be reliably referred to in a networked environment

Has reference to all currently active ImmerseSDK Scene objects

Global service for scene management

Version information of the currently installed Immerse SDK

Draws an Snapping Guide of an object

Unity-friendly Singleton class. Use this class together with SingletonManager.

Static class to manage Unity-friendly Singletons which should be derived from SingletonBehaviour.

Base class for Snapping Guide that show a ghost image of an object

Spawn point for avatars

Spectator Camera

Spectator Camera render capture

A static class to encapsulates the ImmerseSDK tags in Unity

Draws an Snapping Guide of an object

Calculates velocity and angular velocity based on movement of the controller

A helper class for getting information about the VR hardware that is currently attached

A yield instruction that uses unscaled time

Helper class for waiting singletons

Common web tools

Orientation of the controller (pitch, yaw and roll)

Encapsulates a unique identifier for networked messages

Implemented on components that exposes a way to enable verbose logging on individual instances at runtime

Implement this interface to provide an upgrade chain extension of your own

Interface for restartable singletons/global services

Indexed components that implement this can set a ready state after they completed setup. Only when all these components in the scene has set this ready state, will we start processing persisted state messages.

Upgradable components implement this interface

Delegate signature for canvas visibility changed events

Signature for the OnSceneChange event

Signature for the OnSceneInitialized event

Axes enumeration

Pitch of the controller (right vector, X-axis)

Roll of the controller (forward vector, Z-axis)

Yaw of the controller (up vector, Y-axis)

Type identifier for the owner of an object in our networked system

Levels of logging supported

VR Hardware supported by the SDK

Type of VR Hardware Unity plugin to use. This is used to determine which prefabs to create at runtime for the avatar and controllers.