Class ImmersiveSurface

Inheritance

System.Object

ImmersiveSurface

SimulatorSurface

Namespace: Immersive.Surface

Assembly: cs.temp.dll.dll

Syntax

public class ImmersiveSurface : MonoBehaviour

Fields

assignedCamera

Declaration

protected UnityEngine.Camera assignedCamera

Field Value

Type	Description
UnityEngine.Camera

storedBottomOffset

Declaration

protected float storedBottomOffset

Field Value

Type	Description
System.Single

storedLeftOffset

Declaration

protected float storedLeftOffset

Field Value

Type	Description
System.Single

storedRightOffset

Declaration

protected float storedRightOffset

Field Value

Type	Description
System.Single

storedTopOffset

Declaration

protected float storedTopOffset

Field Value

Type	Description
System.Single

surfaceConfiguration

Declaration

protected SurfaceConfiguration surfaceConfiguration

Field Value

Type	Description
SurfaceConfiguration

Properties

SupportCullingOffsets

Control whether this surface type supports culling offsets. Currently only used in the SimulatorSurface to control whether we apply culling offsets to the camera.

Declaration

protected virtual bool SupportCullingOffsets { get; }

Property Value

Type	Description
System.Boolean

SurfaceCanvas

Declaration

public Canvas SurfaceCanvas { get; }

Property Value

Type	Description
Canvas

SurfaceDivisions

Declaration

public int SurfaceDivisions { get; }

Property Value

Type	Description
System.Int32

SurfaceInputProcessor

Declaration

public InputProcessor SurfaceInputProcessor { get; }

Property Value

Type	Description
InputProcessor

Methods

ConfigureSurface(SurfaceConfiguration)

Declaration

public virtual void ConfigureSurface(SurfaceConfiguration newConfiguration)

Parameters

Type	Name	Description
SurfaceConfiguration	newConfiguration

CreateSurface(SurfaceLocation)

Declaration

public virtual void CreateSurface(SurfaceLocation location)

Parameters

Type	Name	Description
SurfaceLocation	location

DestroySurface()

Declaration

public virtual void DestroySurface()

DisableCamera()

Disable the Camera for this surface. Used for optimisation purposes.

Declaration

protected void DisableCamera()

DisableSurface()

Declaration

public virtual void DisableSurface()

EnableCamera()

Enable the Camera for this surface. Used for optimisation purposes.

Declaration

protected void EnableCamera()

EnableDisableInteraction(Boolean)

Declaration

public void EnableDisableInteraction(bool isEnabled)

Parameters

Type	Name	Description
System.Boolean	isEnabled

GetCamera()

Declaration

public UnityEngine.Camera GetCamera()

Returns

Type	Description
UnityEngine.Camera

GetSurfaceConfiguration()

Declaration

public SurfaceConfiguration GetSurfaceConfiguration()

Returns

Type	Description
SurfaceConfiguration

GetSurfaceLocation()

Declaration

public SurfaceLocation GetSurfaceLocation()

Returns

Type	Description
SurfaceLocation

GetSurfaceRect()

Declaration

public Rect GetSurfaceRect()

Returns

Type	Description
Rect

GetUICamera()

Declaration

public UnityEngine.Camera GetUICamera()

Returns

Type	Description
UnityEngine.Camera

OnSurfaceReady(SurfaceReadyEventArgs)

Declaration

protected virtual void OnSurfaceReady(SurfaceReadyEventArgs e)

Parameters

Type	Name	Description
SurfaceReadyEventArgs	e

PrepareSurface()

Declaration

protected virtual void PrepareSurface()

Quit()

This is called when the program is closing by the Room Manager. It handles closing down of the input system components.

Declaration

public virtual void Quit()

RegisterGraphicRaycaster(GraphicRaycaster)

Declaration

public void RegisterGraphicRaycaster(GraphicRaycaster raycaster)

Parameters

Type	Name	Description
GraphicRaycaster	raycaster

SetCamera(UnityEngine.Camera)

Declaration

public virtual void SetCamera(UnityEngine.Camera camera)

Parameters

Type	Name	Description
UnityEngine.Camera	camera

SetCanvas(Canvas)

Sets the canvas that is rendered to this surface.

Declaration

public void SetCanvas(Canvas canvas)

Parameters

Type	Name	Description
Canvas	canvas

SetUICamera(UnityEngine.Camera)

Declaration

public virtual void SetUICamera(UnityEngine.Camera camera)

Parameters

Type	Name	Description
UnityEngine.Camera	camera

Update()

Declaration

protected virtual void Update()

Events

SurfaceReady

Declaration

public event EventHandler<SurfaceReadyEventArgs> SurfaceReady

Event Type

Type	Description
EventHandler<SurfaceReadyEventArgs>