BansheeEngine/Source/Scripting/MBansheeEditor/Windows/Inspector/InspectableCurve.cs

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2018 Marko Pintera ([email protected]). All rights reserved. **********************//
using BansheeEngine;

namespace BansheeEditor
{
    /** @addtogroup Inspector
     *  @{
     */

    /// <summary>
    /// Displays GUI for a serializable property containing a curve. Curve is displayed as a GUI field that allows
    /// the user to manipulate the curve using a curve editor window.
    /// </summary>
    public class InspectableCurve : InspectableField
    {
        private GUICurvesField guiField;
        private InspectableState state;

        /// <summary>
        /// Creates a new inspectable curve GUI for the specified property.
        /// </summary>
        /// <param name="parent">Parent Inspector this field belongs to.</param>
        /// <param name="title">Name of the property, or some other value to set as the title.</param>
        /// <param name="path">Full path to this property (includes name of this property and all parent properties).</param>
        /// <param name="depth">Determines how deep within the inspector nesting hierarchy is this field. Some fields may
        ///                     contain other fields, in which case you should increase this value by one.</param>
        /// <param name="layout">Parent layout that all the field elements will be added to.</param>
        /// <param name="property">Serializable property referencing the field whose contents to display.</param>
        public InspectableCurve(Inspector parent, string title, string path, int depth,
            InspectableFieldLayout layout, SerializableProperty property)
            : base(parent, title, path, SerializableProperty.FieldType.Curve, depth, layout, property)
        { }

        /// <inheritoc/>
        protected internal override void Initialize(int layoutIndex)
        {
            if (property != null)
            {
                guiField = new GUICurvesField(new GUIContent(title));
                guiField.OnChanged += OnFieldValueChanged;

                layout.AddElement(layoutIndex, guiField);
            }
        }

        /// <inheritdoc/>
        public override InspectableState Refresh(int layoutIndex)
        {
            if (guiField != null)
                guiField.SetCurve(property.GetValue<AnimationCurve>());

            InspectableState oldState = state;
            if (state.HasFlag(InspectableState.Modified))
                state = InspectableState.NotModified;

            return oldState;
        }

        /// <summary>
        /// Triggered when the user updates the curve.
        /// </summary>
        /// <param name="newValue">New curve.</param>
        private void OnFieldValueChanged(AnimationCurve newValue)
        {
            property.SetValue(newValue);
            state = InspectableState.Modified;
        }
    }

    /** @} */
}