ImmerseSDK Namespace

The top level namespace with all the core components in

Classes

	Class	Description
	App	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.
	AvatarRecordingSynchroniser	A synchroniser to send avatar recordings to remote users
	AvatarRecordingSynchroniserState	Payload data
	CanvasTween	A component for animating the alpha of a CanvasGroup, useful for UI fading
	ControllerHelpers	Helper methods for rotation calculations
	DisplayDecimalPlacesAttribute	Set the number of decimal places this float/double should display
	DontDestroyOnLoad	Makes the object target not be destroyed automatically when loading a new scene.
	FileHelpers	File helpers for copying, deleting, etc
	GUID	Encapsulates a unique identifier for networked messages
	GUIDMessageIndexes	Constant indices for message parts
	ImmerseProjectSettings	Class to Store the immerse settings that are used on a project wide bases This currently contains the Offline in editor and offline in Build Options
	ImmerseProjectSettingsManager	Class to save and load the immerse project wide settings
	IndexT1, T2	A wrapped Dictionary, with a string key, for managing items so that they can be easily recovered when needed
	InstantiationService	Manages instantiation services and spawning
	Layers	A static class to encapsulates the ImmerseSDK layers in Unity
	LoadSceneAdditively	Loads a scene additively. You have to make sure you have this scene in your build settings when you build the packages.
	Log	Global Log class for writing output to the local log file (VR) or the console (WebGL)
	LoggingBehaviour	Base class for components that exposes a way to enable verbose logging on individual instances at runtime
	MaterialHelper	Helper methods for performing tasks on Materials
	Math	Some math helper methods
	NavMeshUtils
	Outliner	Base class for outliners that show a ghost image of an object
	PermanentOutline	Draws an outline of an object. note that this outline does not update dynamically, so the hierarchy is assumed to stay constant.
	ProjectHelper	Helper class for project setup tasks
	ReadOnlyAttribute
	ReadOnlyWhenPlayingAttribute
	RectUtils	Utility class that provides methods for testing if a point is within a rectangle within 3D space.
	Scene	Handles indexing of IndexedMonoBehaviours, avatar spawning and scene settings. A Scene component is required for each scene in a ImmerseSDK project.
	SceneNavigationSettings	Class to encapsulate all Navigation settings
	SceneService	Global service for scene management
	ScriptOrderAttribute
	SdkVersion	Version information of the currently installed Immerse SDK
	SeparateOutline	Draws an outline of an object
	ShaderParameters
	SingletonT	Manages the single instance of a class. Note: Do NOT use this singleton with UnityEngine.MonoBehaviour. Take care with how Unity manages lifetime of objects. See SingletonBehaviour for a Unity-friendly singleton.
	SingletonBehaviour	Unity-friendly Singleton class. Use this class together with SingletonManager.
	SingletonException	Represents errors that occur while creating a singleton.
	SingletonManager	Static class to manage Unity-friendly Singletons which should be derived from SingletonBehaviour.
	SmoothQuaternion
	SmoothValueT
	SmoothVector2
	SmoothVector3
	SmoothVector4
	Spawn	Spawn point for avatars
	SpectatorCamera	Spectator Camera
	SpectatorCameraRender	Spectator Camera render capture
	SyncPropertiesHelper
	Tags	A static class to encapsulates the ImmerseSDK tags in Unity
	UnityXRStartupCheck
	UnityXRUpgradeChain
	UserAvatarRecording
	VelocityCalculator	Calculates velocity and angular velocity based on movement of the controller
	VRPlatformInfo	A helper class for getting information about the VR hardware that is currently attached
	WaitForUnscaledSeconds	A yield instreuction that uses unscaled time
	WaitingFor	Helper class for waiting singletons
	Web	Common web tools

Structures

	Structure	Description
	ControllerHelpersControllerOrientation	Orientation of the controller (pitch, yaw and roll)

Interfaces

	Interface	Description
	ILoggingBehaviour	Implemented on components that exposes a way to enable verbose logging on individual instances at runtime
	IProjectStartupCheck	Implement this interface to provide an upgrade chain extension of your own
	IRestartable	Interface for restartable singletons/global services
	ISupportDelayedStartup	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.
	IUpgradableComponent	Upgradable components implement this interface

Delegates

	Delegate	Description
	CanvasTweenVisibilityChangeHandler	Delegate signature for canvas visibility changed events
	SceneSceneChangeHandler	Signature for the OnSceneChange event
	SceneServiceSceneInitializeEventHandler	Signature for the OnSceneInitialized event

Enumerations

	Enumeration	Description
	Axes	Axes enumeration
	ControllerHelpersControllerPitch	Pitch of the controller (right vector, X-axis)
	ControllerHelpersControllerRoll	Roll of the controller (forward vector, Z-axis)
	ControllerHelpersControllerYaw	Yaw of the controller (up vector, Y-axis)
	GUIDOwnerTypes	Type identifier for the owner of an object in our networked system
	LogSeverity	Levels of logging supported
	SceneNavigationSettingsNavigationTypes	Types of Navigation we support in the Immerse SDK
	VRHardwareType	VR Hardware supported by the SDK
	VRHardwareUnityPlugin	Type of VR Hardware Unity plugin to use. This is used to determine which prefabs to create at runtime for the avatar and controllers.