CameraService Class

An App level service that handles the Camera. This is mostly used for WebGL clients, where the camera is not controlled by the VR headset.

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDKSingletonBehaviour
              ImmerseSDK.CameraCameraService

Namespace: ImmerseSDK.Camera
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)

Syntax

public class CameraService : SingletonBehaviour

The CameraService type exposes the following members.

Constructors

	Name	Description
	CameraService
	CameraService	Initializes a new instance of the CameraService class

Properties

	Name	Description
	AvatarCamera	Returns the actively displayed Camera in VR. This is set as soon as a scene is loaded.
	CurrentFadeState	The current state of the screen fader
	DialogCamera	Returns the actively displayed main Camera (in VR this might not be the user's view camera though). This is set as soon as a scene is loaded.
	SceneCamera	Returns the actively displayed main Camera (in VR this might not be the user's view camera though). This is set as soon as a scene is loaded.
	Target	Current camera target

Methods

	Name	Description
	ClearFade	Clear the fade
	ClearOverrideTarget	Clears the current override target
	CoroutineInitialise	This method is used by our internal systems so do not call it directly. (Overrides SingletonBehaviourCoroutineInitialise.)
	Fade	Fade the camera
	OnAwake	Override this method to call code in the Awake() method (after singleton registration, but before coroutine) (Overrides SingletonBehaviourOnAwake.)
	OnDestroy	Unity component method (Overrides SingletonBehaviourOnDestroy.)
	SetOverrideTarget	Sets the current override target
	SetTarget	Sets the current target
	ToString	returns "Camera Service" (Overrides UnityEngine.Object.ToString.)

Events

	Name	Description
	OnCameraTargetChange

Fields

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.)