Scene Class

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

Inheritance Hierarchy

Namespace: ImmerseSDK
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

public class Scene : UnityEngine.MonoBehaviour

The Scene type exposes the following members.

Constructors

	Name	Description
	Scene	Initializes a new instance of the Scene class

Properties

	Name	Description
	AllowAllWebUsersToSendBeacon	Whether to allow all web users to send a beacon message
	AvatarNameTooltipsEnabled	Returns the setting for avatar name tooltips in this scene
	AvatarTeleportTrailsEnabled	Returns the setting for avatar teleport trails in this scene
	Current	The currently loaded scene's Scene object
	CustomHandState	Gets a custom hand state that can be used in this scene
	DefaultCameraTarget	Camera target that should be defaulted to when the current camera target disappears
	HasCustomHandStates	Returns true if custom hand states are available and have been setup correctly
	Index	Build index of the scene, Warning: Set on Awake()
	Navigation	Returns the Navigation settings for this scene
	PointsHandMenuEnabled	Returns the setting for points hand menu in this scene

Methods

Events

	Name	Description
	OnSceneChange	Fired when a new scene is loaded

Fields

	Name	Description
	_allowAllWebUsersToSendBeacon	Set this to true to allow all web users to send a beacon message. By default only the space owner can.
	_avatarNameTooltipsEnabled	Enable/Disable avatar name tooltips
	_avatarTeleportTrailsEnabled	Enable/Disable avatar teleport trails
	_customHandState	A custom hand state used in this scene
	_defaultCameraTarget	Default camera target for this scene
	_navigation	The Navigation settings for this scene
	_pointsHandMenuEnabled	Enable/disable the gifting points page on the hand menu
	IndexedObjects	Index containing all IndexedMonoBehaviours in scene, indexed by their IDs

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)