using UnityEngine; using UnityEditor; using Cinemachine.Utility; using System.Collections.Generic; namespace Cinemachine.Editor { [CustomEditor(typeof(CinemachineFramingTransposer))] [CanEditMultipleObjects] internal class CinemachineFramingTransposerEditor : BaseEditor { CinemachineScreenComposerGuides m_ScreenGuideEditor; GameViewEventCatcher m_GameViewEventCatcher; /// Get the property names to exclude in the inspector. /// Add the names to this list protected override void GetExcludedPropertiesInInspector(List excluded) { base.GetExcludedPropertiesInInspector(excluded); if (Target.m_UnlimitedSoftZone) { excluded.Add(FieldPath(x => x.m_SoftZoneWidth)); excluded.Add(FieldPath(x => x.m_SoftZoneHeight)); excluded.Add(FieldPath(x => x.m_BiasX)); excluded.Add(FieldPath(x => x.m_BiasY)); } ICinemachineTargetGroup group = Target.AbstractFollowTargetGroup; if (group == null || Target.m_GroupFramingMode == CinemachineFramingTransposer.FramingMode.None) { excluded.Add(FieldPath(x => x.m_GroupFramingSize)); excluded.Add(FieldPath(x => x.m_AdjustmentMode)); excluded.Add(FieldPath(x => x.m_MaxDollyIn)); excluded.Add(FieldPath(x => x.m_MaxDollyOut)); excluded.Add(FieldPath(x => x.m_MinimumDistance)); excluded.Add(FieldPath(x => x.m_MaximumDistance)); excluded.Add(FieldPath(x => x.m_MinimumFOV)); excluded.Add(FieldPath(x => x.m_MaximumFOV)); excluded.Add(FieldPath(x => x.m_MinimumOrthoSize)); excluded.Add(FieldPath(x => x.m_MaximumOrthoSize)); if (group == null) excluded.Add(FieldPath(x => x.m_GroupFramingMode)); } else { CinemachineBrain brain = CinemachineCore.Instance.FindPotentialTargetBrain(Target.VirtualCamera); bool ortho = brain != null ? brain.OutputCamera.orthographic : false; if (ortho) { excluded.Add(FieldPath(x => x.m_AdjustmentMode)); excluded.Add(FieldPath(x => x.m_MaxDollyIn)); excluded.Add(FieldPath(x => x.m_MaxDollyOut)); excluded.Add(FieldPath(x => x.m_MinimumDistance)); excluded.Add(FieldPath(x => x.m_MaximumDistance)); excluded.Add(FieldPath(x => x.m_MinimumFOV)); excluded.Add(FieldPath(x => x.m_MaximumFOV)); } else { excluded.Add(FieldPath(x => x.m_MinimumOrthoSize)); excluded.Add(FieldPath(x => x.m_MaximumOrthoSize)); switch (Target.m_AdjustmentMode) { case CinemachineFramingTransposer.AdjustmentMode.DollyOnly: excluded.Add(FieldPath(x => x.m_MinimumFOV)); excluded.Add(FieldPath(x => x.m_MaximumFOV)); break; case CinemachineFramingTransposer.AdjustmentMode.ZoomOnly: excluded.Add(FieldPath(x => x.m_MaxDollyIn)); excluded.Add(FieldPath(x => x.m_MaxDollyOut)); excluded.Add(FieldPath(x => x.m_MinimumDistance)); excluded.Add(FieldPath(x => x.m_MaximumDistance)); break; default: break; } } } } protected virtual void OnEnable() { m_ScreenGuideEditor = new CinemachineScreenComposerGuides(); m_ScreenGuideEditor.GetHardGuide = () => { return Target.HardGuideRect; }; m_ScreenGuideEditor.GetSoftGuide = () => { return Target.SoftGuideRect; }; m_ScreenGuideEditor.SetHardGuide = (Rect r) => { Target.HardGuideRect = r; }; m_ScreenGuideEditor.SetSoftGuide = (Rect r) => { Target.SoftGuideRect = r; }; m_ScreenGuideEditor.Target = () => { return serializedObject; }; m_GameViewEventCatcher = new GameViewEventCatcher(); m_GameViewEventCatcher.OnEnable(); CinemachineDebug.OnGUIHandlers -= OnGUI; CinemachineDebug.OnGUIHandlers += OnGUI; if (CinemachineSettings.CinemachineCoreSettings.ShowInGameGuides) InspectorUtility.RepaintGameView(); #if UNITY_2021_2_OR_NEWER CinemachineSceneToolUtility.RegisterTool(typeof(FollowOffsetTool)); CinemachineSceneToolUtility.RegisterTool(typeof(TrackedObjectOffsetTool)); #endif } protected virtual void OnDisable() { m_GameViewEventCatcher.OnDisable(); CinemachineDebug.OnGUIHandlers -= OnGUI; if (CinemachineSettings.CinemachineCoreSettings.ShowInGameGuides) InspectorUtility.RepaintGameView(); #if UNITY_2021_2_OR_NEWER CinemachineSceneToolUtility.UnregisterTool(typeof(FollowOffsetTool)); CinemachineSceneToolUtility.UnregisterTool(typeof(TrackedObjectOffsetTool)); #endif } public override void OnInspectorGUI() { BeginInspector(); bool needWarning = false; for (int i = 0; !needWarning && i < targets.Length; ++i) needWarning = (targets[i] as CinemachineFramingTransposer).FollowTarget == null; if (needWarning) EditorGUILayout.HelpBox( "Framing Transposer requires a Follow target. " + "Change Body to Do Nothing if you don't want a Follow target.", MessageType.Warning); // First snapshot some settings Rect oldHard = Target.HardGuideRect; Rect oldSoft = Target.SoftGuideRect; // Draw the properties DrawRemainingPropertiesInInspector(); m_ScreenGuideEditor.SetNewBounds(oldHard, oldSoft, Target.HardGuideRect, Target.SoftGuideRect); } protected virtual void OnGUI() { // Draw the camera guides if (Target == null || !CinemachineSettings.CinemachineCoreSettings.ShowInGameGuides) return; // If inspector is collapsed in the vcam editor, don't draw the guides if (!VcamStageEditor.ActiveEditorRegistry.IsActiveEditor(this)) return; CinemachineBrain brain = CinemachineCore.Instance.FindPotentialTargetBrain(Target.VirtualCamera); if (brain == null || (brain.OutputCamera.activeTexture != null && CinemachineCore.Instance.BrainCount > 1)) return; bool isLive = targets.Length <= 1 && brain.IsLive(Target.VirtualCamera, true); // Screen guides m_ScreenGuideEditor.OnGUI_DrawGuides(isLive, brain.OutputCamera, Target.VcamState.Lens, !Target.m_UnlimitedSoftZone); // Draw an on-screen gizmo for the target if (Target.FollowTarget != null && isLive) { Vector3 targetScreenPosition = brain.OutputCamera.WorldToScreenPoint(Target.TrackedPoint); if (targetScreenPosition.z > 0) { targetScreenPosition.y = Screen.height - targetScreenPosition.y; GUI.color = CinemachineSettings.ComposerSettings.TargetColour; Rect r = new Rect(targetScreenPosition, Vector2.zero); float size = (CinemachineSettings.ComposerSettings.TargetSize + CinemachineScreenComposerGuides.kGuideBarWidthPx) / 2; GUI.DrawTexture(r.Inflated(new Vector2(size, size)), Texture2D.whiteTexture); size -= CinemachineScreenComposerGuides.kGuideBarWidthPx; if (size > 0) { Vector4 overlayOpacityScalar = new Vector4(1f, 1f, 1f, CinemachineSettings.ComposerSettings.OverlayOpacity); GUI.color = Color.black * overlayOpacityScalar; GUI.DrawTexture(r.Inflated(new Vector2(size, size)), Texture2D.whiteTexture); } } } } [DrawGizmo(GizmoType.Active | GizmoType.InSelectionHierarchy, typeof(CinemachineFramingTransposer))] private static void DrawGroupComposerGizmos(CinemachineFramingTransposer target, GizmoType selectionType) { // Show the group bounding box, as viewed from the camera position if (target.AbstractFollowTargetGroup != null && target.m_GroupFramingMode != CinemachineFramingTransposer.FramingMode.None) { Matrix4x4 m = Gizmos.matrix; Bounds b = target.LastBounds; Gizmos.matrix = target.LastBoundsMatrix; Gizmos.color = Color.yellow; if (target.VcamState.Lens.Orthographic) Gizmos.DrawWireCube(b.center, b.size); else { float z = b.center.z; Vector3 e = b.extents; Gizmos.DrawFrustum( Vector3.zero, Mathf.Atan2(e.y, z) * Mathf.Rad2Deg * 2, z + e.z, z - e.z, e.x / e.y); } Gizmos.matrix = m; } } #if UNITY_2021_2_OR_NEWER void OnSceneGUI() { DrawSceneTools(); } void DrawSceneTools() { var framingTransposer = Target; if (framingTransposer == null || !framingTransposer.IsValid) { return; } if (CinemachineSceneToolUtility.IsToolActive(typeof(TrackedObjectOffsetTool))) { CinemachineSceneToolHelpers.TrackedObjectOffsetTool(framingTransposer, new SerializedObject(framingTransposer).FindProperty(() => framingTransposer.m_TrackedObjectOffset)); } else if (CinemachineSceneToolUtility.IsToolActive(typeof(FollowOffsetTool))) { var originalColor = Handles.color; var camPos = framingTransposer.VcamState.RawPosition; var targetForward = framingTransposer.VirtualCamera.State.FinalOrientation * Vector3.forward; EditorGUI.BeginChangeCheck(); Handles.color = CinemachineSceneToolHelpers.HelperLineDefaultColor; var cdHandleId = GUIUtility.GetControlID(FocusType.Passive); var newHandlePosition = Handles.Slider(cdHandleId, camPos, targetForward, CinemachineSceneToolHelpers.CubeHandleCapSize(camPos), Handles.CubeHandleCap, 0.5f); if (EditorGUI.EndChangeCheck()) { // Modify via SerializedProperty for OnValidate to get called automatically, and scene repainting too var so = new SerializedObject(framingTransposer); var prop = so.FindProperty(() => framingTransposer.m_CameraDistance); prop.floatValue -= CinemachineSceneToolHelpers.SliderHandleDelta(newHandlePosition, camPos, targetForward); so.ApplyModifiedProperties(); } var cameraDistanceHandleIsDragged = GUIUtility.hotControl == cdHandleId; var cameraDistanceHandleIsUsedOrHovered = cameraDistanceHandleIsDragged || HandleUtility.nearestControl == cdHandleId; if (cameraDistanceHandleIsUsedOrHovered) { CinemachineSceneToolHelpers.DrawLabel(camPos, "Camera Distance (" + framingTransposer.m_CameraDistance.ToString("F1") + ")"); } Handles.color = cameraDistanceHandleIsUsedOrHovered ? Handles.selectedColor : CinemachineSceneToolHelpers.HelperLineDefaultColor; Handles.DrawLine(camPos, framingTransposer.FollowTarget.position + framingTransposer.m_TrackedObjectOffset); CinemachineSceneToolHelpers.SoloOnDrag(cameraDistanceHandleIsDragged, framingTransposer.VirtualCamera, cdHandleId); Handles.color = originalColor; } } #endif } }