Version 0.4.10

Author: smdol

CHANGELOG

@@ -47,3 +47,9 @@ v0.4.9 (3/27/2015):
 -  Demo scene now uses uGUI instead of OnGUI.
 -  Original demo scene using CardboardGUI moved to Legacy folder.
 
+v0.4.10 (4/16/2015):
+-  StereoController now caches the Eyes array.  Call InvalidateEyes() to reset the cache.
+-  Moved coroutine management in Cardboard and StereoController to OnEnable()/OnDisable().
+-  Fixed CardboardGUI's Head property in the Legacy demo scene.
+-  Fixed the neck model Z offset in the Editor.
+-  Fixed a bug in CardboardEditor which failed to save the Editor-only settings.

Cardboard/Editor/CardboardEditor.cs

@@ -102,10 +102,6 @@ public override void OnInspectorGUI() {
     cardboard.BackButtonExitsApp =
       EditorGUILayout.Toggle(backButtonExitsAppLabel, cardboard.BackButtonExitsApp);
 
-    if (GUI.changed) {
-      EditorUtility.SetDirty(cardboard);
-    }
-
     EditorGUILayout.Separator();
 
     EditorGUILayout.LabelField(editorSettingsLabel);
@@ -122,6 +118,10 @@ public override void OnInspectorGUI() {
     cardboard.deviceType = (CardboardProfile.DeviceTypes)
       EditorGUILayout.EnumPopup(deviceTypeLabel, cardboard.deviceType);
 
+    if (GUI.changed) {
+      EditorUtility.SetDirty(cardboard);
+    }
+
     if (EditorApplication.isPlaying) {
       bool newInCardboard = EditorGUILayout.Toggle("Is In Cardboard", cardboard.InCardboard);
       if (newInCardboard != cardboard.InCardboard) {

Cardboard/Legacy/DemoScene/DemoScene.unity

@@ -249,7 +249,7 @@ Prefab:
     - target: {fileID: 11400004, guid: dcd8898a5b8c54c59a1b18bcf72ebd37, type: 2}
       propertyPath: head
       value: 
-      objectReference: {fileID: 0}
+      objectReference: {fileID: 299255874}
     - target: {fileID: 11400004, guid: dcd8898a5b8c54c59a1b18bcf72ebd37, type: 2}
       propertyPath: pointerSize.x
       value: 8
@@ -340,6 +340,8 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: f1578549c7fcc4f6fa1b063992091672, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  trackRotation: 1
+  trackPosition: 1
   target: {fileID: 0}
   updateEarly: 0
 --- !u!1 &334714608
@@ -1952,7 +1954,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: f06724eec91fb4704a525c71a8e8deea, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  head: {fileID: 0}
+  head: {fileID: 299255874}
   pointerImage: {fileID: 2800000, guid: 53a9e781f887f46e1817489bff4b661d, type: 3}
   pointerSize: {x: 8, y: 8}
   pointerSpot: {x: 4, y: 4}

Cardboard/Scripts/Cardboard.cs

@@ -198,7 +198,7 @@ public void SetInCardboard(bool value) {
   public RenderTexture StereoScreen {
     get {
       // Don't need it except for distortion correction.
-      if (!nativeDistortionCorrection || !vrModeEnabled) {
+      if (!nativeDistortionCorrection || !vrModeEnabled || captureFramebuffer) {
         return null;
       }
       if (stereoScreen == null) {
@@ -209,6 +209,7 @@ public RenderTexture StereoScreen {
   }
 
   private RenderTexture stereoScreen;
+  private bool captureFramebuffer;
 
   // Describes the current device, including phone screen.
   public CardboardProfile Profile { get; private set; }
@@ -317,11 +318,6 @@ public void initialize() {
           supportsAndroidRenderEvent = isAtLeastUnity4_5 && isAndroid;
       }
 
-      public bool canApplyDistortionCorrection() {
-          return supportsRenderTextures && supportsAndroidRenderEvent
-              && canAccessActivity;
-      }
-
       public string getDistortionCorrectionDiagnostic() {
           List<string> causes = new List<string>();
           if (!isAndroid) {
@@ -373,8 +369,21 @@ void Awake() {
           SetInCardboard(true);
       }
 #endif
+  }
+
+  void OnEnable() {
+    StartCoroutine("EndOfFrame");
+  }
+
+  void OnDisable() {
+    StopCoroutine("EndOfFrame");
+  }
 
-      StartCoroutine("EndOfFrame");
+  void OnApplicationPause(bool paused) {
+    if (!paused) {
+      // Device configuration may have changed.
+      UpdateScreenData();
+    }
   }
 
   void Update() {
@@ -426,24 +435,27 @@ public void UpdateScreenData() {
   }
 
   public void CreateStereoScreen(int x, int y) {
-    if (config.canApplyDistortionCorrection()) {
-      Debug.Log("Creating new cardboard screen texture.");
-      if (stereoScreen != null) {
-        stereoScreen.Release();
-      }
-      stereoScreen = new RenderTexture(x, y, 16, RenderTextureFormat.RGB565);
-      stereoScreen.Create();
-    } else {
+    if (stereoScreen != null) {
+      stereoScreen.Release();
       stereoScreen = null;
-      if (!Application.isEditor) {
-        nativeDistortionCorrection = false;
-        Debug.LogWarning("Lens distortion-correction disabled. Causes: [" +
-                         config.getDistortionCorrectionDiagnostic() + "]");
+    }
+    captureFramebuffer = false;
+    if (config.canAccessActivity && config.supportsAndroidRenderEvent) {
+      if (config.supportsRenderTextures) {
+        Debug.Log("Creating new cardboard screen texture.");
+        stereoScreen = new RenderTexture(x, y, 16, RenderTextureFormat.RGB565);
+        stereoScreen.Create();
+      } else {
+        captureFramebuffer = true;
       }
+    } else if (!Application.isEditor) {
+      nativeDistortionCorrection = false;
+      Debug.LogWarning("Lens distortion-correction disabled. Causes: [" +
+                       config.getDistortionCorrectionDiagnostic() + "]");
     }
 #if ANDROID_DEVICE
-    if (stereoScreen != null) {
-      InitFromUnity(stereoScreen.GetNativeTextureID());
+    if (stereoScreen != null || captureFramebuffer) {
+      InitFromUnity(stereoScreen != null ? stereoScreen.GetNativeTextureID() : 0);
     }
 #endif
   }
@@ -486,7 +498,6 @@ void OnCardboardTriggerInternal() {
   }
 
   void OnDestroy() {
-      StopCoroutine("EndOfFrame");
       if (sdk == this) {
           sdk = null;
       }
@@ -501,7 +512,7 @@ IEnumerator EndOfFrame() {
           yield return new WaitForEndOfFrame();
           if (UpdateState() && vrModeEnabled && !Application.isEditor) {
               GL.InvalidateState();  // necessary for Windows, but not Mac.
-              if (stereoScreen != null && nativeDistortionCorrection) {
+              if (nativeDistortionCorrection) {
                 GL.IssuePluginEvent(kPerformDistortionCorrection);
               }
               if (enableSettingsButton || enableAlignmentMarker) {
@@ -783,7 +794,7 @@ IEnumerator DoAndroidScreenTap(int x, int y) {
   public bool simulateDistortionCorrection = true;
 
   // Simulated neck model.
-  private static readonly Vector3 neckOffset = new Vector3(0, 0.075f, -0.08f);
+  private static readonly Vector3 neckOffset = new Vector3(0, 0.075f, 0.08f);
 
   // Use mouse to emulate head in the editor.
   private float mouseX = 0;
@@ -849,39 +860,4 @@ private void SimulateInput() {
     }
   }
 #endif
-
-  private GUIStyle style;
-
-  // The amount of time (in seconds) to show error message on GUI.
-  private const float GUI_ERROR_MSG_DURATION = 10;
-
-  private const string warning =
-@"Distortion correction is disabled.
-Requires Unity Pro v4.5+.
-See log for additional details.";
-
-#if !UNITY_EDITOR
-  void OnGUI() {
-      if (Debug.isDebugBuild && !config.canApplyDistortionCorrection() &&
-              Time.realtimeSinceStartup <= GUI_ERROR_MSG_DURATION) {
-          DisplayDistortionCorrectionDisabledWarning();
-      }
-  }
-#endif
-
-  private void DisplayDistortionCorrectionDisabledWarning() {
-      if (style == null) {
-          style = new GUIStyle();
-          style.normal.textColor = Color.red;
-          style.alignment = TextAnchor.LowerCenter;
-      }
-      if (VRModeEnabled) {
-          style.fontSize = (int)(50 * Screen.width / 1920f / 2);
-          GUI.Label(new Rect(0, 0, Screen.width / 2, Screen.height), warning, style);
-          GUI.Label(new Rect(Screen.width / 2, 0, Screen.width / 2, Screen.height), warning, style);
-      } else {
-          style.fontSize = (int)(50 * Screen.width / 1920f);
-          GUI.Label(new Rect(0, 0, Screen.width, Screen.height), warning, style);
-      }
-  }
 }

Cardboard/Scripts/CardboardEye.cs

@@ -20,6 +20,9 @@
 // projection based on the head-tracking data from the Cardboard.SDK object.
 // To enable a stereo camera pair, enable the parent mono camera and set
 // Cardboard.SDK.VRModeEnabled = true.
+// NOTE: If you programmatically change the set of CardboardEyes belonging to a
+// StereoController, be sure to call InvalidateEyes() on it in order to reset its
+// cache.
 [RequireComponent(typeof(Camera))]
 public class CardboardEye : MonoBehaviour {
   // Whether this is the left eye or the right eye.
@@ -51,6 +54,16 @@ public CardboardHead Head {
     }
   }
 
+#if UNITY_5
+  // For backwards source code compatibility, since we refer to the camera component A LOT in
+  // this script.
+  new private Camera camera;
+
+  void Awake() {
+    camera = GetComponent<Camera>();
+  }
+#endif
+
   void Start() {
     var ctlr = Controller;
     if (ctlr == null) {
@@ -73,7 +86,6 @@ void Start() {
   private void FixProjection(ref Matrix4x4 proj, float near, float far, float ipdScale) {
     // Adjust for non-fullscreen camera.  Cardboard SDK assumes fullscreen,
     // so the aspect ratio might not match.
-    Camera camera = GetComponent<Camera>();
     float aspectFix = camera.rect.height / camera.rect.width / 2;
     proj[0, 0] *= aspectFix;
 
@@ -89,13 +101,12 @@ private void FixProjection(ref Matrix4x4 proj, float near, float far, float ipdS
     proj[2, 3] = 2 * near * far / (near - far);
   }
 
-  public void Render() {
+  private void Setup() {
     // Shouldn't happen because of the check in Start(), but just in case...
     if (controller == null) {
       return;
     }
 
-    var camera = GetComponent<Camera>();
     var monoCamera = controller.GetComponent<Camera>();
     Matrix4x4 proj = Cardboard.SDK.Projection(eye);
 
@@ -155,11 +166,7 @@ public void Render() {
                              new Vector4(p.device.distortion.k1, p.device.distortion.k2));
     }
 
-    RenderTexture stereoScreen = controller.StereoScreen;
-    int screenWidth = stereoScreen ? stereoScreen.width : Screen.width;
-    int screenHeight = stereoScreen ? stereoScreen.height : Screen.height;
-
-    if (stereoScreen == null) {
+    if (controller.StereoScreen == null) {
       Rect rect = camera.rect;
       if (!Cardboard.SDK.nativeDistortionCorrection || Application.isEditor) {
         // We are rendering straight to the screen.  Use the reported rect that is visible
@@ -175,7 +182,7 @@ public void Render() {
       }
       if (Application.isEditor) {
         // The Game window's aspect ratio may not match the fake device parameters.
-        float realAspect = (float)screenWidth / screenHeight;
+        float realAspect = (float)Screen.width / Screen.height;
         float fakeAspect = Cardboard.SDK.Profile.screen.width / Cardboard.SDK.Profile.screen.height;
         float aspectComparison = fakeAspect / realAspect;
         if (aspectComparison < 1) {
@@ -188,21 +195,30 @@ public void Render() {
       }
       camera.rect = rect;
     }
+  }
+
+  // Called by StereoController to run the whole render pipeline for this camera.
+  public void Render()
+  {
+    Setup();
 
     // Use the "fast" or "slow" method.  Fast means the camera draws right into one half of
     // the stereo screen.  Slow means it draws first to a side buffer, and then the buffer
     // is written to the screen. The slow method is provided because a lot of Image Effects
     // don't work if you draw to only part of the window.
     if (controller.directRender) {
       // Redirect to our stereo screen.
-      camera.targetTexture = stereoScreen;
+      camera.targetTexture = controller.StereoScreen;
       // Draw!
       camera.Render();
     } else {
       // Save the viewport rectangle and reset to "full screen".
       Rect pixRect = camera.pixelRect;
       camera.rect = new Rect (0, 0, 1, 1);
       // Redirect to a temporary texture.  The defaults are supposedly Android-friendly.
+      RenderTexture stereoScreen = controller.StereoScreen;
+      int screenWidth = stereoScreen ? stereoScreen.width : Screen.width;
+      int screenHeight = stereoScreen ? stereoScreen.height : Screen.height;
       int depth = stereoScreen ? stereoScreen.depth : 16;
       RenderTextureFormat format = stereoScreen ? stereoScreen.format : RenderTextureFormat.RGB565;
       camera.targetTexture = RenderTexture.GetTemporary((int)pixRect.width, (int)pixRect.height,
@@ -228,15 +244,26 @@ public void Render() {
     camera.targetTexture = null;
   }
 
+  // Alternate means of rendering stereo, when you don't plan to switch in and out of VR mode:
+  // In the editor, disable the MainCamera's camera component.  Enable the two stereo eye
+  // camera components.  Note: due to a quirk of Unity, there must be at least one camera
+  // not rendering to a texture, preferably last in order.  If necessary, add a dummy camera
+  // to the scene with a high depth value, it's clear flags set to "Don't Clear", and culling mask
+  // set to Nothing.
+  void OnPreCull() {
+    if (camera.enabled) {
+      Setup();
+      camera.targetTexture = controller.StereoScreen;
+    }
+  }
+
   // Helper to copy camera settings from the controller's mono camera.
   // Used in OnPreCull and the custom editor for StereoController.
   // The parameters parx and pary, if not left at default, should come from a
   // projection matrix returned by the SDK.
   // They affect the apparent depth of the camera's window.  See OnPreCull().
   public void CopyCameraAndMakeSideBySide(StereoController controller,
                                           float parx = 0, float pary = 0) {
-    var camera = GetComponent<Camera>();
-
     // Sync the camera properties.
     camera.CopyFrom(controller.GetComponent<Camera>());
     camera.cullingMask ^= toggleCullingMask.value;

Cardboard/Scripts/RadialUndistortionEffect.cs

@@ -22,7 +22,9 @@
 [RequireComponent(typeof(Camera))]
 public class RadialUndistortionEffect : MonoBehaviour {
 
+#if UNITY_EDITOR
   private StereoController controller;
+#endif
   private Material material;
 
   void Awake() {
@@ -38,12 +40,14 @@ void Awake() {
     material = new Material(shader);
   }
 
+#if UNITY_EDITOR
   void Start() {
     var eye = GetComponent<CardboardEye>();
     if (eye != null) {
       controller = eye.Controller;
     }
   }
+#endif
 
   void OnRenderImage(RenderTexture source, RenderTexture dest) {
     // Check if we found our shader, and that native distortion correction is OFF (except maybe in