TiltFive.SplitStereoCamera Class Reference

Inheritance diagram for TiltFive.SplitStereoCamera:

Public Member Functions
void	Initialize (GameObject headPoseRoot, GlassesSettings glassesSettings, SpectatorSettings spectatorSettings)

Public Attributes
GameObject	headPose = null
	The head pose GameObject property. More...
bool	showCameras = true
	In-editor toggle for displaying the eye cameras in the runtime Hierarchy. More...
Vector3	posUGBD_UWRLD = Vector3.zero
	The position of the game board reference frame w.r.t. the Unity world-space reference frame. More...
Quaternion	rotToUGBD_UWRLD = Quaternion.identity
	The rotation taking points from the Unity world-space reference frame to the game board reference frame. More...
float	scaleToUGBD_UWRLD = 1.0f
	The uniform scale factor that takes points from the Unity world-space to the game board reference frame. More...

Properties
Camera	spectatorCamera [get]
Camera	cameraTemplate [get]
	The Camera used as a template when creating the eye cameras. More...
Camera	leftEyeCamera [get]
	The left eye Camera property. More...
Camera	rightEyeCamera [get]
	The right eye Camera property. More...
GlassesMirrorMode	glassesMirrorMode [get]
float	fieldOfView [get, set]
	The Cameras' field of view property. More...
float	nearClipPlane [get, set]
	The Cameras' near clip plane property. More...
float	farClipPlane [get, set]
	The Cameras' far clip plane property. More...
float	aspectRatio [get, set]
	The Cameras' aspect ratio property. More...

Private Member Functions
void	Awake ()
	Awake this instance. More...
void	InstantiateEyeCameras (out GameObject leftEye, out GameObject rightEye)
void	GenerateEyeCameras (out GameObject leftEye, out GameObject rightEye)
void	ConfigureEyeCameras ()
void	SyncTransform ()
	EDITOR-ONLY: Syncs the eye Cameras' transform to the Head Pose when tracking is not available. More...
void	OnEnable ()
void	OnDisable ()
void	OnPreRender ()
	Configure rendering parameters for the upcoming frame. More...
void	OnRenderImage (RenderTexture src, RenderTexture dst)
	Apply post-processing effects to the final image before it is presented. More...
IEnumerator	PresentStereoImagesCoroutine ()
void	PresentStereoImages ()
void	SyncFields ()
	Syncs the Cameras' fields to the settings. More...
void	OnValidate ()
	EDITOR-ONLY More...
void	ShowHideCameras ()
	Show/hide to the eye camerasin the hierarchy. More...

Private Attributes
bool	useSpectatorCamera
bool	startedMirroringToOnscreenPreview = false
IEnumerator	presentStereoImagesCoroutine
GameObject	leftEye
	The left eye camera GameObject. More...
GameObject	rightEye
	The right eye camera GameObject. More...
Dictionary< AREyes, Camera >	eyeCameras
	The Camera objects. More...
Material	displayBlitShader
	The Material used to store/reference the shader. More...
GlassesMirrorMode	previousMirrorMode = GlassesMirrorMode.LeftEye
SplitStereoTextures	splitStereoTextures = new SplitStereoTextures()

Static Private Attributes
const string	LEFT_EYE_CAMERA_NAME = "Left Eye Camera"
	The name assigned to the dynamically created camera used for rendering the left eye. More...
const string	RIGHT_EYE_CAMERA_NAME = "Right Eye Camera"
	The name assigned to the dynamically created camera used for rendering the right eye. More...
const string	SHADER_DISPLAY_BLIT = "Tilt Five/Simple Blend Shader"
	The name of the custom shader that blits the rendertextures to the backbuffer. More...

Detailed Description

Definition at line 80 of file SplitStereoCamera.cs.

Member Function Documentation

Awake()

void TiltFive.SplitStereoCamera.Awake ( )

private

Awake this instance.

Definition at line 200 of file SplitStereoCamera.cs.

        {
            enabled = false;
            useSpectatorCamera = false;
            startedMirroringToOnscreenPreview = false;
        }

References TiltFive.SplitStereoCamera.startedMirroringToOnscreenPreview, and TiltFive.SplitStereoCamera.useSpectatorCamera.

ConfigureEyeCameras()

void TiltFive.SplitStereoCamera.ConfigureEyeCameras ( )

private

Definition at line 320 of file SplitStereoCamera.cs.

        {
            // Use the head pose camera's preferred texture format, rather than forcing it to render in LDR
            splitStereoTextures.Initialize();
 
            // Configure the left eye camera's render target
            RenderTexture leftTex = splitStereoTextures.LeftTexture_GLS;
            if (leftEyeCamera.allowMSAA && QualitySettings.antiAliasing > 1)
            {
                leftTex.antiAliasing = QualitySettings.antiAliasing;
 
                // Ensure that the preview textures' antiAliasing settings match.
                // Otherwise, Unity 2020.3 complains during Graphics.CopyTexture about the mismatch,
                // resulting in a broken onscreen preview (manifesting as a black screen).
                splitStereoTextures.MonoPreviewTex.antiAliasing = QualitySettings.antiAliasing;
                splitStereoTextures.StereoPreviewTex.antiAliasing = QualitySettings.antiAliasing;
            }
 
            leftEyeCamera.targetTexture = leftTex;
            leftEyeCamera.depth = spectatorCamera.depth - 1;
 
            // Configure the right eye camera's render target
            RenderTexture rightTex = splitStereoTextures.RightTexture_GLS;
            if (rightEyeCamera.allowMSAA && QualitySettings.antiAliasing > 1)
            {
                rightTex.antiAliasing = QualitySettings.antiAliasing;
            }
 
            rightEyeCamera.targetTexture = rightTex;
            rightEyeCamera.depth = spectatorCamera.depth - 1;
        }

References TiltFive.SplitStereoTextures.Initialize(), TiltFive.SplitStereoCamera.leftEyeCamera, TiltFive.SplitStereoTextures.LeftTexture_GLS, TiltFive.SplitStereoTextures.MonoPreviewTex, TiltFive.SplitStereoCamera.rightEyeCamera, TiltFive.SplitStereoTextures.RightTexture_GLS, TiltFive.SplitStereoCamera.spectatorCamera, TiltFive.SplitStereoCamera.splitStereoTextures, and TiltFive.SplitStereoTextures.StereoPreviewTex.

Referenced by TiltFive.SplitStereoCamera.Initialize().

GenerateEyeCameras()

void TiltFive.SplitStereoCamera.GenerateEyeCameras ( out GameObject  leftEye, out GameObject  rightEye  )

private

Definition at line 305 of file SplitStereoCamera.cs.

        {
            leftEye = new GameObject(LEFT_EYE_CAMERA_NAME, typeof(Camera));
            rightEye = new GameObject(RIGHT_EYE_CAMERA_NAME, typeof(Camera));
 
            eyeCameras[AREyes.EYE_LEFT] = leftEye.GetComponent<Camera>();
            eyeCameras[AREyes.EYE_RIGHT] = rightEye.GetComponent<Camera>();
 
            leftEye.transform.parent = headPose.transform;
            rightEye.transform.parent = headPose.transform;
 
            leftEye.transform.SetPositionAndRotation(headPose.transform.position, headPose.transform.rotation);
            rightEye.transform.SetPositionAndRotation(headPose.transform.position, headPose.transform.rotation);
        }

References TiltFive.SplitStereoCamera.eyeCameras, TiltFive.SplitStereoCamera.headPose, TiltFive.SplitStereoCamera.LEFT_EYE_CAMERA_NAME, TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.RIGHT_EYE_CAMERA_NAME, and TiltFive.SplitStereoCamera.rightEye.

Referenced by TiltFive.SplitStereoCamera.Initialize().

Initialize()

void TiltFive.SplitStereoCamera.Initialize	(	GameObject	headPoseRoot,
		GlassesSettings	glassesSettings,
		SpectatorSettings	spectatorSettings
	)

Definition at line 207 of file SplitStereoCamera.cs.

        {
            if(headPoseRoot == null || spectatorSettings == null)
            {
                Log.Error("Arguments cannot be null");
                return;
            }
 
            headPose = headPoseRoot;
            this.glassesSettings = glassesSettings;
            this.spectatorSettings = spectatorSettings;
 
#if TILT_FIVE_SRP
            commandBuffer = new CommandBuffer() { name = "Onscreen Preview" };
#endif
 
            // For this mode, we need the headPose Camera to be enabled, as it is the
            // primary Camera for blitting to the backbuffer.
            if(spectatorCamera != null)
            {
                spectatorCamera.enabled = true;
            }
 
            if(cameraTemplate != null)
            {
                InstantiateEyeCameras(out leftEye, out rightEye);
            }
            else
            {
                GenerateEyeCameras(out leftEye, out rightEye);
            }
            ConfigureEyeCameras();
 
            // Load the blitting shader to copy the the left & right render textures
            // into the backbuffer
            displayBlitShader = new Material(Shader.Find(SHADER_DISPLAY_BLIT));
            // Did we find it?
            if (null == displayBlitShader)
            {
                Log.Error("Failed to load Shader '{0}'", SHADER_DISPLAY_BLIT);
            }
 
            SyncFields();
            SyncTransform();
            ShowHideCameras();
 
            enabled = true;
        }

References TiltFive.SplitStereoCamera.cameraTemplate, TiltFive.SplitStereoCamera.ConfigureEyeCameras(), TiltFive.SplitStereoCamera.displayBlitShader, TiltFive.Logging.Log.Error(), TiltFive.SplitStereoCamera.GenerateEyeCameras(), TiltFive.SplitStereoCamera.headPose, TiltFive.SplitStereoCamera.InstantiateEyeCameras(), TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.rightEye, TiltFive.SplitStereoCamera.SHADER_DISPLAY_BLIT, TiltFive.SplitStereoCamera.ShowHideCameras(), TiltFive.SplitStereoCamera.spectatorCamera, TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.SplitStereoCamera.SyncTransform().

Referenced by TiltFive.Glasses.GlassesCore.Reset().

InstantiateEyeCameras()

void TiltFive.SplitStereoCamera.InstantiateEyeCameras ( out GameObject  leftEye, out GameObject  rightEye  )

private

Definition at line 256 of file SplitStereoCamera.cs.

        {
            var cloneCameraTemplateChildren = glassesSettings.cloneCameraTemplateChildren;
 
            // When we clone the head pose camera using Instantiate, we may not want to clone its children.
            // If this is the case, detach the children and reparent them under a placeholder/babysitter GameObject
            GameObject placeholder = cloneCameraTemplateChildren ? null : new GameObject("Placeholder");
            if (!cloneCameraTemplateChildren)
            {
                placeholder.transform.parent = headPose.transform.parent;
                while (cameraTemplate.transform.childCount > 0)
                {
                    cameraTemplate.transform.GetChild(0).parent = placeholder.transform;
                }
            }
 
            // Instantiate left and right eye cameras from the camera template.
            leftEye = Instantiate(cameraTemplate.gameObject, headPose.transform.position, headPose.transform.rotation, headPose.transform);
            leftEye.name = LEFT_EYE_CAMERA_NAME;
            eyeCameras[AREyes.EYE_LEFT] = leftEye.GetComponent<Camera>();
 
            rightEye = Instantiate(cameraTemplate.gameObject, headPose.transform.position, headPose.transform.rotation, headPose.transform);
            rightEye.name = RIGHT_EYE_CAMERA_NAME;
            eyeCameras[AREyes.EYE_RIGHT] = rightEye.GetComponent<Camera>();
 
            var splitStereoCamerasLeft = leftEye.GetComponents<SplitStereoCamera>();
            for (int i = 0; i < splitStereoCamerasLeft.Length; i++)
            {
                Destroy(splitStereoCamerasLeft[i]);
            }
 
            var splitStereoCamerasRight = rightEye.GetComponents<SplitStereoCamera>();
            for (int i = 0; i < splitStereoCamerasRight.Length; i++)
            {
                Destroy(splitStereoCamerasRight[i]);
            }
 
 
            if (!cloneCameraTemplateChildren)
            {
                // Reclaim the head pose camera's children from the placeholder/babysitter GameObject
                while (placeholder.transform.childCount > 0)
                {
                    placeholder.transform.GetChild(0).parent = cameraTemplate.transform;
                }
                Destroy(placeholder);
            }
        }

References TiltFive.SplitStereoCamera.cameraTemplate, TiltFive.GlassesSettings.cloneCameraTemplateChildren, TiltFive.SplitStereoCamera.eyeCameras, TiltFive.SplitStereoCamera.headPose, TiltFive.SplitStereoCamera.LEFT_EYE_CAMERA_NAME, TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.RIGHT_EYE_CAMERA_NAME, and TiltFive.SplitStereoCamera.rightEye.

Referenced by TiltFive.SplitStereoCamera.Initialize().

OnDisable()

void TiltFive.SplitStereoCamera.OnDisable ( )

private

Definition at line 406 of file SplitStereoCamera.cs.

        {
            if (startedMirroringToOnscreenPreview)
            {
                startedMirroringToOnscreenPreview = false;
                // If OnDisable() is being called from Destroy(), then the children may no longer
                // exist. Check before acting on them.
                if (leftEye)
                {
                    leftEye.SetActive(false);
                    leftEyeCamera.enabled = false;
                }
                if (rightEye)
                {
                    rightEye.SetActive(false);
                    rightEyeCamera.enabled = false;
                }
            }
 
            if(presentStereoImagesCoroutine != null)
            {
                StopCoroutine(presentStereoImagesCoroutine);
            }
#if TILT_FIVE_SRP
            RenderPipelineManager.beginFrameRendering -= OnBeginFrameRendering;
            RenderPipelineManager.endFrameRendering -= OnEndFrameRendering;
#endif
        }

References TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.leftEyeCamera, TiltFive.SplitStereoCamera.presentStereoImagesCoroutine, TiltFive.SplitStereoCamera.rightEye, TiltFive.SplitStereoCamera.rightEyeCamera, and TiltFive.SplitStereoCamera.startedMirroringToOnscreenPreview.

OnEnable()

void TiltFive.SplitStereoCamera.OnEnable ( )

private

Definition at line 388 of file SplitStereoCamera.cs.

        {
            leftEye.SetActive(true);
            rightEye.SetActive(true);
            leftEyeCamera.enabled = true;
            rightEyeCamera.enabled = true;
            presentStereoImagesCoroutine = PresentStereoImagesCoroutine();
            StartCoroutine(presentStereoImagesCoroutine);
 
#if TILT_FIVE_SRP
            if(Application.isPlaying)
            {
                RenderPipelineManager.beginFrameRendering += OnBeginFrameRendering;
                RenderPipelineManager.endFrameRendering += OnEndFrameRendering;
            }
#endif
        }

References TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.leftEyeCamera, TiltFive.SplitStereoCamera.presentStereoImagesCoroutine, TiltFive.SplitStereoCamera.PresentStereoImagesCoroutine(), TiltFive.SplitStereoCamera.rightEye, and TiltFive.SplitStereoCamera.rightEyeCamera.

OnPreRender()

void TiltFive.SplitStereoCamera.OnPreRender ( )

private

Configure rendering parameters for the upcoming frame.

Definition at line 456 of file SplitStereoCamera.cs.

        {
            splitStereoTextures.ValidateNativeTexturePointers();
 
            if(!UseSpectatorCamera)
            {
                return;
            }
 
            spectatorCamera.targetTexture = null;
 
            /* If the screen mirror mode changes, junk data will be displayed
            * in the black bars unless we clear the screen buffer.
            *
            * This has to be done before we adjust the headpose camera rect,
            * since GL.Clear's effect is limited by the active viewport.
            *
            * We also must ensure that we call GL.Clear once as soon as we begin mirroring to the screen.
            * See Gerrit #3013 for additional detail, but in short, there's an implicit mirror mode transition
            * at the moment we begin mirroring to the onscreen preview that isn't captured by comparing
            * glassesMirrorMode against previousMirrorMode, and if we don't check for it using the
            * startedMirroringToOnscreenPreview flag, junk data could fill the letterboxing/pillarboxing.*/
            if (glassesMirrorMode != previousMirrorMode || !startedMirroringToOnscreenPreview)
            {
                // Before calling GL.Clear(), we need to reset the viewport.
                // Otherwise, we may not clear the entire screen in some cases.
                GL.Viewport(spectatorCamera.pixelRect);
                GL.Clear(true, true, Color.black);
                previousMirrorMode = glassesMirrorMode;
                startedMirroringToOnscreenPreview = true;
            }
 
            if(glassesMirrorMode == GlassesMirrorMode.None)
            {
                return;
            }
 
            spectatorCamera.cullingMask = 0;    // Cull all layers, render nothing.
            spectatorCamera.fieldOfView = glassesSettings.fieldOfView;
            spectatorCamera.nearClipPlane = glassesSettings.nearClipPlane / scaleToUGBD_UWRLD;
            spectatorCamera.farClipPlane = glassesSettings.farClipPlane / scaleToUGBD_UWRLD;
 
            // Lock the aspect ratio and add pillarboxing/letterboxing as needed.
            float screenRatio = Screen.width / (float)Screen.height;
            float targetRatio = glassesMirrorMode == GlassesMirrorMode.Stereoscopic
                ? DisplaySettings.stereoWidthToHeightRatio
                : DisplaySettings.monoWidthToHeightRatio;
 
            if(screenRatio > targetRatio) {
                // Screen or window is wider than the target: pillarbox.
                float normalizedWidth = targetRatio / screenRatio;
                float barThickness = (1f - normalizedWidth) / 2f;
                spectatorCamera.rect = new Rect(barThickness, 0, normalizedWidth, 1);
            }
            else {
                // Screen or window is narrower than the target: letterbox.
                float normalizedHeight = screenRatio / targetRatio;
                float barThickness = (1f - normalizedHeight) / 2f;
                spectatorCamera.rect = new Rect(0, barThickness, 1, normalizedHeight);
            }
        }

References TiltFive.GlassesSettings.farClipPlane, TiltFive.GlassesSettings.fieldOfView, TiltFive.SplitStereoCamera.glassesMirrorMode, TiltFive.DisplaySettings.monoWidthToHeightRatio, TiltFive.GlassesSettings.nearClipPlane, TiltFive.SplitStereoCamera.previousMirrorMode, TiltFive.SplitStereoCamera.scaleToUGBD_UWRLD, TiltFive.SplitStereoCamera.spectatorCamera, TiltFive.SplitStereoCamera.splitStereoTextures, TiltFive.SplitStereoCamera.startedMirroringToOnscreenPreview, TiltFive.DisplaySettings.stereoWidthToHeightRatio, and TiltFive.SplitStereoTextures.ValidateNativeTexturePointers().

OnRenderImage()

void TiltFive.SplitStereoCamera.OnRenderImage ( RenderTexture  src, RenderTexture  dst  )

private

Apply post-processing effects to the final image before it is presented.

Parameters

src	The source render texture.
dst	The destination render texture.

Definition at line 587 of file SplitStereoCamera.cs.

        {
            // If we're not supposed to spectate due to the spectated player being set to None
            // or to a player that isn't connected, have the first SplitStereoCamera attached to
            // the SpectatorCamera perform a blit.
            // TODO: Consider adding a spectator setting to define fallback behavior when the specified player isn't connected.
            // The current behavior is indistinguishable from the PlayerIndex.None case, and perhaps it'd be desirable
            // to spectate the next available player instead, if there is one?
            if (spectatorSettings.spectatedPlayer == PlayerIndex.None || !Player.IsConnected(spectatorSettings.spectatedPlayer))
            {
                var splitStereoCameras = spectatorCamera.GetComponents<SplitStereoCamera>();
                if(splitStereoCameras != null && splitStereoCameras.Length > 0  // These two checks should be redundant
                    && splitStereoCameras[0].Equals(this))  // This is the important one
                {
                    Graphics.Blit(src, null as RenderTexture);
                    return;
                }
                // Any SplitStereoCameras that call OnRenderImage after the first one should return, otherwise they'll clear the screen
                return;
            }
 
            if(!UseSpectatorCamera)
            {
                return;
            }
 
            if (glassesMirrorMode != GlassesMirrorMode.None)
            {
                splitStereoTextures.SubmitPreviewTextures(glassesMirrorMode);
 
                var previewTex = glassesMirrorMode == GlassesMirrorMode.Stereoscopic
                    ? splitStereoTextures.StereoPreviewTex
                    : splitStereoTextures.MonoPreviewTex;
 
                // Blitting is required when overriding OnRenderImage().
                // Setting the blit destination to null is the same as blitting to the screen backbuffer.
                // This will effectively render previewTex to the screen.
                Graphics.Blit(previewTex,
                    null as RenderTexture,
                    Vector2.one,
                    Vector2.zero);
            }
            else Graphics.Blit(src, null as RenderTexture);
 
            // We're done with our letterboxing/pillarboxing now that we've blitted to the screen.
            // If the SplitStereoCamera gets disabled next frame, ensure that the original behavior returns.
            spectatorSettings.ResetSpectatorCamera();
        }

References TiltFive.SplitStereoCamera.glassesMirrorMode, TiltFive.Player.IsConnected(), TiltFive.SplitStereoTextures.MonoPreviewTex, TiltFive.SpectatorSettings.spectatedPlayer, TiltFive.SplitStereoCamera.spectatorCamera, TiltFive.SplitStereoCamera.splitStereoTextures, TiltFive.SplitStereoTextures.StereoPreviewTex, and TiltFive.SplitStereoTextures.SubmitPreviewTextures().

OnValidate()

void TiltFive.SplitStereoCamera.OnValidate ( )

private

EDITOR-ONLY

Definition at line 711 of file SplitStereoCamera.cs.

        {
 
#if UNITY_EDITOR
            if (false == UnityEditor.EditorApplication.isPlaying)
                return;
#endif
            if (null == spectatorCamera)
                return;
 
            if (null != leftEye && null != rightEye)
                ShowHideCameras();
 
            SyncFields();
            SyncTransform();
        }

References TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.rightEye, TiltFive.SplitStereoCamera.ShowHideCameras(), TiltFive.SplitStereoCamera.spectatorCamera, TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.SplitStereoCamera.SyncTransform().

PresentStereoImages()

void TiltFive.SplitStereoCamera.PresentStereoImages ( )

private

Definition at line 650 of file SplitStereoCamera.cs.

        {
            splitStereoTextures.GetNativeTexturePointers(out var leftTexHandle, out var rightTexHandle);
 
            var leftTargetTex = splitStereoTextures.LeftTexture_GLS;
            var rightTargetTex = splitStereoTextures.RightTexture_GLS;
 
            bool isSrgb = leftTargetTex.sRGB;
 
            Vector3 posOfULVC_UWRLD = leftEyeCamera.transform.position;
            Quaternion rotToUWRLD_ULVC = leftEyeCamera.transform.rotation;
            Vector3 posOfURVC_UWRLD = rightEyeCamera.transform.position;
            Quaternion rotToUWRLD_URVC = rightEyeCamera.transform.rotation;
 
            Vector3 posOfULVC_UGBD = rotToUGBD_UWRLD * (scaleToUGBD_UWRLD * (posOfULVC_UWRLD - posUGBD_UWRLD));
            Quaternion rotToUGBD_ULVC = rotToUGBD_UWRLD * rotToUWRLD_ULVC;
 
            Vector3 posOfURVC_UGBD = rotToUGBD_UWRLD * (scaleToUGBD_UWRLD * (posOfURVC_UWRLD - posUGBD_UWRLD));
            Quaternion rotToUGBD_URVC = rotToUGBD_UWRLD * rotToUWRLD_URVC;
 
 
            Display.PresentStereoImages(glassesHandle,
                                       leftTexHandle, rightTexHandle,
                                       leftTargetTex.width, rightTargetTex.height,
                                       isSrgb,
                                       glassesSettings.fieldOfView,
                                       DisplaySettings.monoWidthToHeightRatio,
                                       rotToUGBD_ULVC,
                                       posOfULVC_UGBD,
                                       rotToUGBD_URVC,
                                       posOfURVC_UGBD);
        }

References TiltFive.GlassesSettings.fieldOfView, TiltFive.SplitStereoTextures.GetNativeTexturePointers(), TiltFive.SplitStereoCamera.leftEyeCamera, TiltFive.SplitStereoTextures.LeftTexture_GLS, TiltFive.DisplaySettings.monoWidthToHeightRatio, TiltFive.SplitStereoCamera.posUGBD_UWRLD, TiltFive.Display.PresentStereoImages(), TiltFive.SplitStereoCamera.rightEyeCamera, TiltFive.SplitStereoTextures.RightTexture_GLS, TiltFive.SplitStereoCamera.rotToUGBD_UWRLD, TiltFive.SplitStereoCamera.scaleToUGBD_UWRLD, and TiltFive.SplitStereoCamera.splitStereoTextures.

Referenced by TiltFive.SplitStereoCamera.PresentStereoImagesCoroutine().

PresentStereoImagesCoroutine()

IEnumerator TiltFive.SplitStereoCamera.PresentStereoImagesCoroutine ( )

private

Definition at line 636 of file SplitStereoCamera.cs.

        {
            // WaitForEndOfFrame() will let us wait until the last possible moment to send frames to the glasses.
            // This allows the results of rendering, postprocessing, and even GUI to be displayed.
            var cachedWaitForEndOfFrame = new WaitForEndOfFrame();
 
            while (enabled)
            {
                yield return cachedWaitForEndOfFrame;
 
                PresentStereoImages();
            }
        }

References TiltFive.SplitStereoCamera.PresentStereoImages().

Referenced by TiltFive.SplitStereoCamera.OnEnable().

ShowHideCameras()

void TiltFive.SplitStereoCamera.ShowHideCameras ( )

private

Show/hide to the eye camerasin the hierarchy.

Definition at line 731 of file SplitStereoCamera.cs.

        {
            if (showCameras)
            {
                leftEye.hideFlags = HideFlags.None;
                rightEye.hideFlags = HideFlags.None;
            }
            else
            {
                leftEye.hideFlags = HideFlags.HideInInspector | HideFlags.HideInHierarchy;
                rightEye.hideFlags = HideFlags.HideInInspector | HideFlags.HideInHierarchy;
            }
        }

References TiltFive.SplitStereoCamera.leftEye, TiltFive.SplitStereoCamera.rightEye, and TiltFive.SplitStereoCamera.showCameras.

Referenced by TiltFive.SplitStereoCamera.Initialize(), and TiltFive.SplitStereoCamera.OnValidate().

SyncFields()

void TiltFive.SplitStereoCamera.SyncFields ( )

private

Syncs the Cameras' fields to the settings.

Definition at line 686 of file SplitStereoCamera.cs.

        {
            if (glassesSettings == null)
            {
                return;
            }
            if (leftEyeCamera != null)
            {
                leftEyeCamera.fieldOfView = glassesSettings.fieldOfView;
                leftEyeCamera.nearClipPlane = glassesSettings.nearClipPlane;
                leftEyeCamera.farClipPlane = glassesSettings.farClipPlane;
                leftEyeCamera.aspect = DisplaySettings.monoWidthToHeightRatio;
            }
            if (rightEyeCamera != null)
            {
                rightEyeCamera.fieldOfView = glassesSettings.fieldOfView;
                rightEyeCamera.nearClipPlane = glassesSettings.nearClipPlane;
                rightEyeCamera.farClipPlane = glassesSettings.farClipPlane;
                rightEyeCamera.aspect = DisplaySettings.monoWidthToHeightRatio;
            }
        }

References TiltFive.GlassesSettings.farClipPlane, TiltFive.GlassesSettings.fieldOfView, TiltFive.SplitStereoCamera.leftEyeCamera, TiltFive.DisplaySettings.monoWidthToHeightRatio, TiltFive.GlassesSettings.nearClipPlane, and TiltFive.SplitStereoCamera.rightEyeCamera.

Referenced by TiltFive.SplitStereoCamera.Initialize(), and TiltFive.SplitStereoCamera.OnValidate().

SyncTransform()

void TiltFive.SplitStereoCamera.SyncTransform ( )

private

EDITOR-ONLY: Syncs the eye Cameras' transform to the Head Pose when tracking is not available.

Definition at line 356 of file SplitStereoCamera.cs.

        {
 
#if UNITY_EDITOR
            // We move the eye Cameras in the Editor to emulate head pose and eye movement.
            // In builds, we only set the camera transforms with Glasses tracking data.
 
            if (null == cameraTemplate || !Player.TryGetPlayerIndex(glassesHandle, out PlayerIndex playerIndex))
                return;
 
            if (!Glasses.IsTracked(playerIndex))
            {
                GameObject pose = headPose;
                // left eye copy and adjust
                leftEye.transform.position = pose.transform.position;
                leftEye.transform.localPosition = pose.transform.localPosition;
                leftEye.transform.rotation = pose.transform.rotation;
                leftEye.transform.localRotation = pose.transform.localRotation;
                leftEye.transform.localScale = pose.transform.localScale;
                leftEye.transform.Translate(-leftEye.transform.right.normalized * (cameraTemplate.stereoSeparation * 0.5f));
 
                //right eye copy and adjust
                rightEye.transform.position = pose.transform.position;
                rightEye.transform.localPosition = pose.transform.localPosition;
                rightEye.transform.rotation = pose.transform.rotation;
                rightEye.transform.localRotation = pose.transform.localRotation;
                rightEye.transform.localScale = headPose.transform.localScale;
                rightEye.transform.Translate(rightEye.transform.right.normalized * (cameraTemplate.stereoSeparation * 0.5f));
            }
#endif
        }

References TiltFive.SplitStereoCamera.cameraTemplate, TiltFive.SplitStereoCamera.headPose, TiltFive.Glasses.IsTracked(), TiltFive.SplitStereoCamera.leftEye, and TiltFive.SplitStereoCamera.rightEye.

Referenced by TiltFive.SplitStereoCamera.Initialize(), and TiltFive.SplitStereoCamera.OnValidate().

Member Data Documentation

displayBlitShader

Material TiltFive.SplitStereoCamera.displayBlitShader

private

The Material used to store/reference the shader.

Definition at line 155 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.Initialize().

eyeCameras

Dictionary<AREyes, Camera> TiltFive.SplitStereoCamera.eyeCameras

private

Initial value:

= new Dictionary<AREyes, Camera>()
        {
            { AREyes.EYE_LEFT, null },
            { AREyes.EYE_RIGHT, null }
        }

The Camera objects.

Definition at line 128 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.GenerateEyeCameras(), and TiltFive.SplitStereoCamera.InstantiateEyeCameras().

headPose

GameObject TiltFive.SplitStereoCamera.headPose = null

The head pose GameObject property.

Definition at line 92 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.GenerateEyeCameras(), TiltFive.SplitStereoCamera.Initialize(), TiltFive.SplitStereoCamera.InstantiateEyeCameras(), and TiltFive.SplitStereoCamera.SyncTransform().

LEFT_EYE_CAMERA_NAME

const string TiltFive.SplitStereoCamera.LEFT_EYE_CAMERA_NAME = "Left Eye Camera"

staticprivate

The name assigned to the dynamically created camera used for rendering the left eye.

Definition at line 112 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.GenerateEyeCameras(), and TiltFive.SplitStereoCamera.InstantiateEyeCameras().

leftEye

GameObject TiltFive.SplitStereoCamera.leftEye

private

The left eye camera GameObject.

Definition at line 114 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.GenerateEyeCameras(), TiltFive.SplitStereoCamera.Initialize(), TiltFive.SplitStereoCamera.InstantiateEyeCameras(), TiltFive.SplitStereoCamera.OnDisable(), TiltFive.SplitStereoCamera.OnEnable(), TiltFive.SplitStereoCamera.OnValidate(), TiltFive.SplitStereoCamera.ShowHideCameras(), and TiltFive.SplitStereoCamera.SyncTransform().

posUGBD_UWRLD

Vector3 TiltFive.SplitStereoCamera.posUGBD_UWRLD = Vector3.zero

The position of the game board reference frame w.r.t. the Unity world-space reference frame.

Definition at line 138 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.PresentStereoImages(), and TiltFive.Glasses.GlassesCore.Update().

presentStereoImagesCoroutine

IEnumerator TiltFive.SplitStereoCamera.presentStereoImagesCoroutine

private

Definition at line 109 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.OnDisable(), and TiltFive.SplitStereoCamera.OnEnable().

previousMirrorMode

GlassesMirrorMode TiltFive.SplitStereoCamera.previousMirrorMode = GlassesMirrorMode.LeftEye

private

Definition at line 158 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.OnPreRender().

RIGHT_EYE_CAMERA_NAME

const string TiltFive.SplitStereoCamera.RIGHT_EYE_CAMERA_NAME = "Right Eye Camera"

staticprivate

The name assigned to the dynamically created camera used for rendering the right eye.

Definition at line 119 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.GenerateEyeCameras(), and TiltFive.SplitStereoCamera.InstantiateEyeCameras().

rightEye

GameObject TiltFive.SplitStereoCamera.rightEye

private

The right eye camera GameObject.

Definition at line 121 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.GenerateEyeCameras(), TiltFive.SplitStereoCamera.Initialize(), TiltFive.SplitStereoCamera.InstantiateEyeCameras(), TiltFive.SplitStereoCamera.OnDisable(), TiltFive.SplitStereoCamera.OnEnable(), TiltFive.SplitStereoCamera.OnValidate(), TiltFive.SplitStereoCamera.ShowHideCameras(), and TiltFive.SplitStereoCamera.SyncTransform().

rotToUGBD_UWRLD

Quaternion TiltFive.SplitStereoCamera.rotToUGBD_UWRLD = Quaternion.identity

The rotation taking points from the Unity world-space reference frame to the game board reference frame.

Definition at line 144 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.PresentStereoImages(), and TiltFive.Glasses.GlassesCore.Update().

scaleToUGBD_UWRLD

float TiltFive.SplitStereoCamera.scaleToUGBD_UWRLD = 1.0f

The uniform scale factor that takes points from the Unity world-space to the game board reference frame.

Definition at line 150 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.OnPreRender(), TiltFive.SplitStereoCamera.PresentStereoImages(), and TiltFive.Glasses.GlassesCore.Update().

SHADER_DISPLAY_BLIT

const string TiltFive.SplitStereoCamera.SHADER_DISPLAY_BLIT = "Tilt Five/Simple Blend Shader"

staticprivate

The name of the custom shader that blits the rendertextures to the backbuffer.

Definition at line 153 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.Initialize().

showCameras

bool TiltFive.SplitStereoCamera.showCameras = true

In-editor toggle for displaying the eye cameras in the runtime Hierarchy.

Definition at line 126 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.ShowHideCameras().

splitStereoTextures

SplitStereoTextures TiltFive.SplitStereoCamera.splitStereoTextures = new SplitStereoTextures()

private

Definition at line 159 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.ConfigureEyeCameras(), TiltFive.SplitStereoCamera.OnPreRender(), TiltFive.SplitStereoCamera.OnRenderImage(), and TiltFive.SplitStereoCamera.PresentStereoImages().

startedMirroringToOnscreenPreview

bool TiltFive.SplitStereoCamera.startedMirroringToOnscreenPreview = false

private

Definition at line 107 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.Awake(), TiltFive.SplitStereoCamera.OnDisable(), and TiltFive.SplitStereoCamera.OnPreRender().

useSpectatorCamera

bool TiltFive.SplitStereoCamera.useSpectatorCamera

private

Definition at line 93 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.Awake().

Property Documentation

aspectRatio

float TiltFive.SplitStereoCamera.aspectRatio

getset

The Cameras' aspect ratio property.

Definition at line 191 of file SplitStereoCamera.cs.

        {
            get { return spectatorCamera.aspect; }
            set { spectatorCamera.aspect = value; }
        }

cameraTemplate

Camera TiltFive.SplitStereoCamera.cameraTemplate

get

The Camera used as a template when creating the eye cameras.

Definition at line 90 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.Initialize(), TiltFive.SplitStereoCamera.InstantiateEyeCameras(), TiltFive.SplitStereoCamera.SyncTransform(), TiltFive.Glasses.GlassesCore.Update(), and TiltFive.Glasses.GlassesCore.Validate().

farClipPlane

float TiltFive.SplitStereoCamera.farClipPlane

getset

The Cameras' far clip plane property.

Definition at line 183 of file SplitStereoCamera.cs.

        {
            get { return spectatorCamera.farClipPlane; }
            set { rightEyeCamera.farClipPlane = leftEyeCamera.farClipPlane = spectatorCamera.farClipPlane = value; }
        }

fieldOfView

float TiltFive.SplitStereoCamera.fieldOfView

getset

The Cameras' field of view property.

Definition at line 167 of file SplitStereoCamera.cs.

        {
            get { return spectatorCamera.fieldOfView; }
            set { rightEyeCamera.fieldOfView = leftEyeCamera.fieldOfView = spectatorCamera.fieldOfView = value; }
        }

glassesMirrorMode

GlassesMirrorMode TiltFive.SplitStereoCamera.glassesMirrorMode

getprivate

Definition at line 157 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.OnPreRender(), and TiltFive.SplitStereoCamera.OnRenderImage().

leftEyeCamera

Camera TiltFive.SplitStereoCamera.leftEyeCamera

get

The left eye Camera property.

Definition at line 116 of file SplitStereoCamera.cs.

{ get { return eyeCameras[AREyes.EYE_LEFT]; } }

Referenced by TiltFive.SplitStereoCamera.ConfigureEyeCameras(), TiltFive.SplitStereoCamera.OnDisable(), TiltFive.SplitStereoCamera.OnEnable(), TiltFive.SplitStereoCamera.PresentStereoImages(), TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.Glasses.GlassesCore.Update().

nearClipPlane

float TiltFive.SplitStereoCamera.nearClipPlane

getset

The Cameras' near clip plane property.

Definition at line 175 of file SplitStereoCamera.cs.

        {
            get { return spectatorCamera.nearClipPlane; }
            set { rightEyeCamera.nearClipPlane = leftEyeCamera.nearClipPlane = spectatorCamera.nearClipPlane = value; }
        }

rightEyeCamera

Camera TiltFive.SplitStereoCamera.rightEyeCamera

get

The right eye Camera property.

Definition at line 123 of file SplitStereoCamera.cs.

{ get { return eyeCameras[AREyes.EYE_RIGHT]; } }

Referenced by TiltFive.SplitStereoCamera.ConfigureEyeCameras(), TiltFive.SplitStereoCamera.OnDisable(), TiltFive.SplitStereoCamera.OnEnable(), TiltFive.SplitStereoCamera.PresentStereoImages(), TiltFive.SplitStereoCamera.SyncFields(), and TiltFive.Glasses.GlassesCore.Update().

spectatorCamera

Camera TiltFive.SplitStereoCamera.spectatorCamera

getprivate

Definition at line 86 of file SplitStereoCamera.cs.

Referenced by TiltFive.SplitStereoCamera.ConfigureEyeCameras(), TiltFive.SplitStereoCamera.Initialize(), TiltFive.SplitStereoCamera.OnPreRender(), TiltFive.SplitStereoCamera.OnRenderImage(), and TiltFive.SplitStereoCamera.OnValidate().

---

The documentation for this class was generated from the following file:

• SplitStereoCamera.cs