// ----------------------------------------------------------------------------
//
// PhotonNetwork Framework for Unity - Copyright (C) 2018 Exit Games GmbH
//
//
// This is a custom editor for the TransformView component.
//
// developer@exitgames.com
// ----------------------------------------------------------------------------
namespace Photon.Pun
{
using UnityEditor;
using UnityEngine;
[CustomEditor(typeof(PhotonTransformViewClassic))]
public class PhotonTransformViewClassicEditor : MonoBehaviourPunEditor
{
//private PhotonTransformViewClassic m_Target;
private SerializedProperty m_SynchronizePositionProperty;
private SerializedProperty m_SynchronizeRotationProperty;
private SerializedProperty m_SynchronizeScaleProperty;
private bool m_InterpolateHelpOpen;
private bool m_ExtrapolateHelpOpen;
private bool m_InterpolateRotationHelpOpen;
private bool m_InterpolateScaleHelpOpen;
private const int EDITOR_LINE_HEIGHT = 20;
private const string INTERPOLATE_TOOLTIP =
"Choose between synchronizing the value directly (by disabling interpolation) or smoothly move it towards the newest update.";
private const string INTERPOLATE_HELP =
"You can use interpolation to smoothly move your GameObject towards a new position that is received via the network. "
+ "This helps to reduce the stuttering movement that results because the network updates only arrive 10 times per second.\n"
+ "As a side effect, the GameObject is always lagging behind the actual position a little bit. This can be addressed with extrapolation.";
private const string EXTRAPOLATE_TOOLTIP = "Extrapolation is used to predict where the GameObject actually is";
private const string EXTRAPOLATE_HELP =
"Whenever you deal with network values, all values you receive will be a little bit out of date since that data needs "
+ "to reach you first. You can use extrapolation to try to predict where the player actually is, based on the movement data you have received.\n"
+
"This has to be tweaked carefully for each specific game in order to insure the optimal prediction. Sometimes it is very easy to extrapolate states, because "
+
"the GameObject behaves very predictable (for example for vehicles). Other times it can be very hard because the user input is translated directly to the game "
+ "and you cannot really predict what the user is going to do (for example in fighting games)";
private const string INTERPOLATE_HELP_URL = "https://doc.photonengine.com/en-us/pun/current/demos-and-tutorials/package-demos/rpg-movement#interpolate_options";
private const string EXTRAPOLATE_HELP_URL = "https://doc.photonengine.com/en-us/pun/current/demos-and-tutorials/package-demos/rpg-movement#extrapolate_options";
public void OnEnable()
{
SetupSerializedProperties();
}
public override void OnInspectorGUI()
{
serializedObject.Update();
base.OnInspectorGUI();
//this.m_Target = (PhotonTransformViewClassic) target;
DrawIsPlayingWarning();
GUI.enabled = !Application.isPlaying;
DrawSynchronizePositionHeader();
DrawSynchronizePositionData();
GUI.enabled = !Application.isPlaying;
DrawSynchronizeRotationHeader();
DrawSynchronizeRotationData();
GUI.enabled = !Application.isPlaying;
DrawSynchronizeScaleHeader();
DrawSynchronizeScaleData();
serializedObject.ApplyModifiedProperties();
GUI.enabled = true;
}
private void DrawIsPlayingWarning()
{
if (Application.isPlaying == false)
{
return;
}
GUILayout.BeginVertical(GUI.skin.box);
{
GUILayout.Label("Editing is disabled in play mode so the two objects don't go out of sync");
}
GUILayout.EndVertical();
}
private void SetupSerializedProperties()
{
this.m_SynchronizePositionProperty = serializedObject.FindProperty("m_PositionModel.SynchronizeEnabled");
this.m_SynchronizeRotationProperty = serializedObject.FindProperty("m_RotationModel.SynchronizeEnabled");
this.m_SynchronizeScaleProperty = serializedObject.FindProperty("m_ScaleModel.SynchronizeEnabled");
}
private void DrawSynchronizePositionHeader()
{
DrawHeader("Synchronize Position", this.m_SynchronizePositionProperty);
}
private void DrawSynchronizePositionData()
{
if (this.m_SynchronizePositionProperty == null || this.m_SynchronizePositionProperty.boolValue == false)
{
return;
}
SerializedProperty interpolatePositionProperty = serializedObject.FindProperty("m_PositionModel.InterpolateOption");
PhotonTransformViewPositionModel.InterpolateOptions interpolateOption = (PhotonTransformViewPositionModel.InterpolateOptions)interpolatePositionProperty.enumValueIndex;
SerializedProperty extrapolatePositionProperty = serializedObject.FindProperty("m_PositionModel.ExtrapolateOption");
PhotonTransformViewPositionModel.ExtrapolateOptions extrapolateOption = (PhotonTransformViewPositionModel.ExtrapolateOptions)extrapolatePositionProperty.enumValueIndex;
float containerHeight = 155;
switch (interpolateOption)
{
case PhotonTransformViewPositionModel.InterpolateOptions.FixedSpeed:
case PhotonTransformViewPositionModel.InterpolateOptions.Lerp:
containerHeight += EDITOR_LINE_HEIGHT;
break;
/*case PhotonTransformViewPositionModel.InterpolateOptions.MoveTowardsComplex:
containerHeight += EDITOR_LINE_HEIGHT*3;
break;*/
}
if (extrapolateOption != PhotonTransformViewPositionModel.ExtrapolateOptions.Disabled)
{
containerHeight += EDITOR_LINE_HEIGHT;
}
switch (extrapolateOption)
{
case PhotonTransformViewPositionModel.ExtrapolateOptions.FixedSpeed:
containerHeight += EDITOR_LINE_HEIGHT;
break;
}
if (this.m_InterpolateHelpOpen == true)
{
containerHeight += GetInterpolateHelpBoxHeight();
}
if (this.m_ExtrapolateHelpOpen == true)
{
containerHeight += GetExtrapolateHelpBoxHeight();
}
// removed Gizmo Options. -3 lines, -1 splitter
containerHeight -= EDITOR_LINE_HEIGHT * 3;
Rect rect = PhotonGUI.ContainerBody(containerHeight);
Rect propertyRect = new Rect(rect.xMin + 5, rect.yMin + 2, rect.width - 10, EditorGUIUtility.singleLineHeight);
DrawTeleport(ref propertyRect);
DrawSplitter(ref propertyRect);
DrawSynchronizePositionDataInterpolation(ref propertyRect, interpolatePositionProperty, interpolateOption);
DrawSplitter(ref propertyRect);
DrawSynchronizePositionDataExtrapolation(ref propertyRect, extrapolatePositionProperty, extrapolateOption);
}
private float GetInterpolateHelpBoxHeight()
{
return PhotonGUI.RichLabel.CalcHeight(new GUIContent(INTERPOLATE_HELP), Screen.width - 54) + 35;
}
private float GetExtrapolateHelpBoxHeight()
{
return PhotonGUI.RichLabel.CalcHeight(new GUIContent(EXTRAPOLATE_HELP), Screen.width - 54) + 35;
}
private void DrawSplitter(ref Rect propertyRect)
{
Rect splitterRect = new Rect(propertyRect.xMin - 3, propertyRect.yMin, propertyRect.width + 6, 1);
PhotonGUI.DrawSplitter(splitterRect);
propertyRect.y += 5;
}
private void DrawHelpBox(ref Rect propertyRect, bool isOpen, float height, string helpText, string url)
{
if (isOpen == true)
{
Rect helpRect = new Rect(propertyRect.xMin, propertyRect.yMin, propertyRect.width, height - 5);
GUI.BeginGroup(helpRect, GUI.skin.box);
GUI.Label(new Rect(5, 5, propertyRect.width - 10, height - 30), helpText, PhotonGUI.RichLabel);
if (GUI.Button(new Rect(5, height - 30, propertyRect.width - 10, 20), "Read more in our documentation"))
{
Application.OpenURL(url);
}
GUI.EndGroup();
propertyRect.y += height;
}
}
private void DrawPropertyWithHelpIcon(ref Rect propertyRect, ref bool isHelpOpen, SerializedProperty property, string tooltip)
{
Rect propertyFieldRect = new Rect(propertyRect.xMin, propertyRect.yMin, propertyRect.width - 20, propertyRect.height);
string propertyName = ObjectNames.NicifyVariableName(property.name);
EditorGUI.PropertyField(propertyFieldRect, property, new GUIContent(propertyName, tooltip));
Rect helpIconRect = new Rect(propertyFieldRect.xMax + 5, propertyFieldRect.yMin, 20, propertyFieldRect.height);
isHelpOpen = GUI.Toggle(helpIconRect, isHelpOpen, PhotonGUI.HelpIcon, GUIStyle.none);
propertyRect.y += EDITOR_LINE_HEIGHT;
}
private void DrawSynchronizePositionDataExtrapolation(ref Rect propertyRect, SerializedProperty extrapolatePositionProperty,
PhotonTransformViewPositionModel.ExtrapolateOptions extrapolateOption)
{
DrawPropertyWithHelpIcon(ref propertyRect, ref this.m_ExtrapolateHelpOpen, extrapolatePositionProperty, EXTRAPOLATE_TOOLTIP);
DrawHelpBox(ref propertyRect, this.m_ExtrapolateHelpOpen, GetExtrapolateHelpBoxHeight(), EXTRAPOLATE_HELP, EXTRAPOLATE_HELP_URL);
if (extrapolateOption != PhotonTransformViewPositionModel.ExtrapolateOptions.Disabled)
{
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.ExtrapolateIncludingRoundTripTime"));
propertyRect.y += EDITOR_LINE_HEIGHT;
}
switch (extrapolateOption)
{
case PhotonTransformViewPositionModel.ExtrapolateOptions.FixedSpeed:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.ExtrapolateSpeed"));
propertyRect.y += EDITOR_LINE_HEIGHT;
break;
}
}
private void DrawTeleport(ref Rect propertyRect)
{
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.TeleportEnabled"),
new GUIContent("Enable teleport for great distances"));
propertyRect.y += EDITOR_LINE_HEIGHT;
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.TeleportIfDistanceGreaterThan"),
new GUIContent("Teleport if distance greater than"));
propertyRect.y += EDITOR_LINE_HEIGHT;
}
private void DrawSynchronizePositionDataInterpolation(ref Rect propertyRect, SerializedProperty interpolatePositionProperty,
PhotonTransformViewPositionModel.InterpolateOptions interpolateOption)
{
DrawPropertyWithHelpIcon(ref propertyRect, ref this.m_InterpolateHelpOpen, interpolatePositionProperty, INTERPOLATE_TOOLTIP);
DrawHelpBox(ref propertyRect, this.m_InterpolateHelpOpen, GetInterpolateHelpBoxHeight(), INTERPOLATE_HELP, INTERPOLATE_HELP_URL);
switch (interpolateOption)
{
case PhotonTransformViewPositionModel.InterpolateOptions.FixedSpeed:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.InterpolateMoveTowardsSpeed"),
new GUIContent("MoveTowards Speed"));
propertyRect.y += EDITOR_LINE_HEIGHT;
break;
case PhotonTransformViewPositionModel.InterpolateOptions.Lerp:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.InterpolateLerpSpeed"), new GUIContent("Lerp Speed"));
propertyRect.y += EDITOR_LINE_HEIGHT;
break;
/*case PhotonTransformViewPositionModel.InterpolateOptions.MoveTowardsComplex:
Rect curveRect = new Rect(propertyRect.xMin, propertyRect.yMin, propertyRect.width - 100, propertyRect.height);
EditorGUI.PropertyField(curveRect, serializedObject.FindProperty("m_PositionModel.InterpolateSpeedCurve"), new GUIContent("MoveTowards Speed Curve"));
Rect labelRect = new Rect(propertyRect.xMax - 95, propertyRect.yMin, 10, propertyRect.height);
GUI.Label(labelRect, "x");
Rect multiplierRect = new Rect(propertyRect.xMax - 80, propertyRect.yMin, 80, propertyRect.height);
EditorGUI.PropertyField(multiplierRect, serializedObject.FindProperty("m_PositionModel.InterpolateMoveTowardsSpeed"), GUIContent.none);
propertyRect.y += EDITOR_LINE_HEIGHT;
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.InterpolateMoveTowardsAcceleration"),
new GUIContent("Acceleration"));
propertyRect.y += EDITOR_LINE_HEIGHT;
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_PositionModel.InterpolateMoveTowardsDeceleration"),
new GUIContent("Deceleration"));
propertyRect.y += EDITOR_LINE_HEIGHT;
break;*/
}
}
private void DrawSynchronizeRotationHeader()
{
DrawHeader("Synchronize Rotation", this.m_SynchronizeRotationProperty);
}
private void DrawSynchronizeRotationData()
{
if (this.m_SynchronizeRotationProperty == null || this.m_SynchronizeRotationProperty.boolValue == false)
{
return;
}
SerializedProperty interpolateRotationProperty = serializedObject.FindProperty("m_RotationModel.InterpolateOption");
PhotonTransformViewRotationModel.InterpolateOptions interpolateOption =
(PhotonTransformViewRotationModel.InterpolateOptions)interpolateRotationProperty.enumValueIndex;
float containerHeight = 20;
switch (interpolateOption)
{
case PhotonTransformViewRotationModel.InterpolateOptions.RotateTowards:
case PhotonTransformViewRotationModel.InterpolateOptions.Lerp:
containerHeight += EDITOR_LINE_HEIGHT;
break;
}
if (this.m_InterpolateRotationHelpOpen == true)
{
containerHeight += GetInterpolateHelpBoxHeight();
}
Rect rect = PhotonGUI.ContainerBody(containerHeight);
Rect propertyRect = new Rect(rect.xMin + 5, rect.yMin + 2, rect.width - 10, EditorGUIUtility.singleLineHeight);
DrawPropertyWithHelpIcon(ref propertyRect, ref this.m_InterpolateRotationHelpOpen, interpolateRotationProperty, INTERPOLATE_TOOLTIP);
DrawHelpBox(ref propertyRect, this.m_InterpolateRotationHelpOpen, GetInterpolateHelpBoxHeight(), INTERPOLATE_HELP, INTERPOLATE_HELP_URL);
switch (interpolateOption)
{
case PhotonTransformViewRotationModel.InterpolateOptions.RotateTowards:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_RotationModel.InterpolateRotateTowardsSpeed"),
new GUIContent("RotateTowards Speed"));
break;
case PhotonTransformViewRotationModel.InterpolateOptions.Lerp:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_RotationModel.InterpolateLerpSpeed"), new GUIContent("Lerp Speed"));
break;
}
}
private void DrawSynchronizeScaleHeader()
{
DrawHeader("Synchronize Scale", this.m_SynchronizeScaleProperty);
}
private void DrawSynchronizeScaleData()
{
if (this.m_SynchronizeScaleProperty == null || this.m_SynchronizeScaleProperty.boolValue == false)
{
return;
}
SerializedProperty interpolateScaleProperty = serializedObject.FindProperty("m_ScaleModel.InterpolateOption");
PhotonTransformViewScaleModel.InterpolateOptions interpolateOption = (PhotonTransformViewScaleModel.InterpolateOptions)interpolateScaleProperty.enumValueIndex;
float containerHeight = EDITOR_LINE_HEIGHT;
switch (interpolateOption)
{
case PhotonTransformViewScaleModel.InterpolateOptions.MoveTowards:
case PhotonTransformViewScaleModel.InterpolateOptions.Lerp:
containerHeight += EDITOR_LINE_HEIGHT;
break;
}
if (this.m_InterpolateScaleHelpOpen == true)
{
containerHeight += GetInterpolateHelpBoxHeight();
}
Rect rect = PhotonGUI.ContainerBody(containerHeight);
Rect propertyRect = new Rect(rect.xMin + 5, rect.yMin + 2, rect.width - 10, EditorGUIUtility.singleLineHeight);
DrawPropertyWithHelpIcon(ref propertyRect, ref this.m_InterpolateScaleHelpOpen, interpolateScaleProperty, INTERPOLATE_TOOLTIP);
DrawHelpBox(ref propertyRect, this.m_InterpolateScaleHelpOpen, GetInterpolateHelpBoxHeight(), INTERPOLATE_HELP, INTERPOLATE_HELP_URL);
switch (interpolateOption)
{
case PhotonTransformViewScaleModel.InterpolateOptions.MoveTowards:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_ScaleModel.InterpolateMoveTowardsSpeed"),
new GUIContent("MoveTowards Speed"));
break;
case PhotonTransformViewScaleModel.InterpolateOptions.Lerp:
EditorGUI.PropertyField(propertyRect, serializedObject.FindProperty("m_ScaleModel.InterpolateLerpSpeed"), new GUIContent("Lerp Speed"));
break;
}
}
private void DrawHeader(string label, SerializedProperty property)
{
if (property == null)
{
return;
}
bool newValue = PhotonGUI.ContainerHeaderToggle(label, property.boolValue);
if (newValue != property.boolValue)
{
property.boolValue = newValue;
property.serializedObject.ApplyModifiedProperties();
}
}
}
}