Runtime camera controller update and new clipping component.

CHANGELOG.md

@@ -7,6 +7,7 @@
 Built with [Unity 2020.2](https://github.com/freezy/VisualPinball.Engine/pull/255).
 
 ### Added
+- Automated camera clipping ([#304](https://github.com/freezy/VisualPinball.Engine/pull/304/files)).
 - DMD and segment display support ([Documentation](https://docs.visualpinball.org/creators-guide/manual/displays.html)).
 - Plugin: Mission Pinball Framework ([Documentation](https://docs.visualpinball.org/plugins/mpf/index.html))
 - Gamelogic Engine: Support for hardware rules ([#293](https://github.com/freezy/VisualPinball.Engine/pull/293)).

VisualPinball.Unity/VisualPinball.Unity.Editor/Game/CameraControllerInspector.cs

@@ -134,6 +134,67 @@ public override void OnInspectorGUI()
 			EditorGUILayout.Space();
 			EditorGUILayout.Separator();
 			EditorGUILayout.PropertyField(_cameraPresetsProp);
+
+			EditorGUILayout.Space();
+			EditorGUILayout.Separator();
+
+			//Editor Play Mode Camera Controls 
+			EditorGUILayout.LabelField("Runtime Motion Controls", EditorStyles.boldLabel);
+			EditorGUILayout.Space();
+
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("Horizontal Speed", EditorStyles.boldLabel);
+			_cameraController.mouseSpeedH = EditorGUILayout.Slider("", _cameraController.mouseSpeedH, 0f, 5f);
+			EditorGUILayout.EndHorizontal();
+
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("Vertical Speed", EditorStyles.boldLabel);
+			_cameraController.mouseSpeedV = EditorGUILayout.Slider("", _cameraController.mouseSpeedV, 0f, 5f);
+			EditorGUILayout.EndHorizontal();
+
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("Translation Speed", EditorStyles.boldLabel);
+			_cameraController.mouseSpeedT = EditorGUILayout.Slider("", _cameraController.mouseSpeedT, 0f, 5f);
+			EditorGUILayout.EndHorizontal();
+
+			EditorGUILayout.Space();
+			EditorGUILayout.Separator();
+
+			/*
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("Distance Change Multiplier", EditorStyles.boldLabel);
+			_cameraController.mouseSpeedD = EditorGUILayout.Slider("", _cameraController.mouseSpeedD, 0f, 2f);
+			EditorGUILayout.EndHorizontal();
+
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("FOV Change Multiplier", EditorStyles.boldLabel);
+			_cameraController.mouseSpeedZ = EditorGUILayout.Slider("", _cameraController.mouseSpeedZ, 0f, 2f);
+			EditorGUILayout.EndHorizontal();
+			*/
+
+			EditorGUILayout.Space();
+			EditorGUILayout.Separator();
+
+			EditorGUILayout.BeginHorizontal(); 
+			EditorGUILayout.LabelField("Invert Horizontal Axis", EditorStyles.boldLabel);
+			_cameraController.invertX = EditorGUILayout.Toggle(_cameraController.invertX);
+			EditorGUILayout.EndHorizontal();
+
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("Invert Vertical Axis", EditorStyles.boldLabel);
+			_cameraController.invertY = EditorGUILayout.Toggle(_cameraController.invertY);
+			EditorGUILayout.EndHorizontal();
+
+			EditorGUILayout.Space();
+			EditorGUILayout.Separator();
+
+			EditorGUILayout.BeginHorizontal();
+			EditorGUILayout.LabelField("Use Inertia", EditorStyles.boldLabel);
+			_cameraController.useInertia = EditorGUILayout.Toggle(_cameraController.useInertia);
+			EditorGUILayout.EndHorizontal();
+
+
+
 		}
 
 		private void ApplySetting()

VisualPinball.Unity/VisualPinball.Unity/Game/CameraClipPlane.cs

@@ -0,0 +1,141 @@
+// Visual Pinball Engine
+// Copyright (C) 2021 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+using System;
+using Unity.Mathematics;
+using UnityEngine;
+
+namespace VisualPinball.Unity
+{
+	[ExecuteAlways]
+	public class CameraClipPlane : MonoBehaviour
+	{
+
+		[NonSerialized]
+		private Camera _camera;
+
+		//Stores the table bounds.
+		private Bounds _tableBounds;
+		private Vector3 _previousCameraPosition = Vector3.zero;
+
+		private void OnEnable()
+		{
+			SetClipPlanes(0.001f, 9f);
+		}
+
+		private void Awake()
+		{
+			RetrieveCameraComponent();
+		}
+
+		private void Update()
+		{
+			if(_camera == null)
+			{
+				RetrieveCameraComponent();
+			}
+
+			if(_camera != null)
+			{
+				if(_previousCameraPosition != _camera.transform.position)
+				{
+					UpdateClipPlanes();
+					_previousCameraPosition = _camera.transform.position;
+				}
+			}
+		}
+
+		/// <summary>
+		/// Updates the camera clipping planes based on the table bounds.
+		/// </summary>
+		private void UpdateClipPlanes()
+		{
+
+			//Early out if no table is selected.
+			if(!TableSelector.Instance.HasSelectedTable)
+			{
+				return;
+			}
+
+			//Early out if we don't have a camera to work on.
+			if(_camera == null)
+			{
+				return;
+			}
+
+			//Get selected table reference.
+			var table = TableSelector.Instance.SelectedTable;
+
+			if(Application.isPlaying)
+			{
+				_tableBounds = table._tableBounds;  //When playing at runtime, get the stored table bounds value instead of calculating.
+			}
+			else
+			{
+				_tableBounds = table.GetTableBounds();  //When in editor, calculate the bounds in case things have changed.
+			}
+
+			var trans = _camera.transform;
+
+			var cameraPos = trans.position; // camera position.
+			var sphereExtent = _tableBounds.extents.magnitude; //sphere radius of the bounds.
+			float cameraToCenter = Vector3.Distance(cameraPos, _tableBounds.center);
+			var nearPlane = math.max(cameraPos.magnitude - sphereExtent, 0.001f); //Assign initial near plane used when camera is not in the sphere.
+			var farPlane = math.max(1f, nearPlane + sphereExtent * 2f); //initial far bounds
+
+			if(cameraToCenter < sphereExtent)
+			{
+				nearPlane = 0.01f; //camera is in the bounds so drop the near plane to very low.
+				farPlane = math.max(0.01f, sphereExtent + Vector3.Distance(cameraPos, _tableBounds.center)); //set far plane to delta between camera and furthest bound.
+
+			}
+
+			SetClipPlanes(nearPlane, farPlane);
+
+		}
+
+		/// <summary>
+		/// Gets the currently active or attached camera component.
+		/// </summary>
+		private void RetrieveCameraComponent()
+		{
+			_camera = GetComponent<Camera>(); //Get the camera component we are attached to if present.
+
+			if(_camera == null)
+			{
+				_camera = UnityEngine.Camera.current;  //Get the current active camera if not on the camera component.
+			}
+
+		}
+
+		/// <summary>
+		/// Sets the camera clipping planes based on manually derived values.
+		/// </summary>
+		/// <param name="near">The near clip plane value</param>
+		/// <param name="far">The far clip plane value</param>
+		/// <returns>False when no camera could be found.</returns>
+		private void SetClipPlanes(float near, float far)
+		{
+			if(_camera == null)
+			{
+				return;
+			}
+
+			_camera.nearClipPlane = math.max(0.001f, near);
+			_camera.farClipPlane = math.max(0.01f, far);
+		}
+	}
+}