XCharts/Runtime/Component/Sub/AreaStyle.cs

/******************************************/
/*                                        */
/*     Copyright (c) 2018 monitor1394     */
/*     https://github.com/monitor1394     */
/*                                        */
/******************************************/


using UnityEngine;

namespace XCharts
{
    /// <summary>
    /// The style of area.
    /// 区域填充样式。
    /// </summary>
    [System.Serializable]
    public class AreaStyle : SubComponent
    {
        /// <summary>
        /// Origin position of area.
        /// 图形区域的起始位置。默认情况下，图形会从坐标轴轴线到数据间进行填充。如果需要填充的区域是坐标轴最大值到数据间，或者坐标轴最小值到数据间，则可以通过这个配置项进行设置。
        /// </summary>
        public enum AreaOrigin
        {
            /// <summary>
            /// to fill between axis line to data.
            /// 填充坐标轴轴线到数据间的区域。
            /// </summary>
            Auto,
            /// <summary>
            /// to fill between min axis value (when not inverse) to data.
            /// 填充坐标轴底部到数据间的区域。
            /// </summary>
            Start,
            /// <summary>
            /// to fill between max axis value (when not inverse) to data.
            /// 填充坐标轴顶部到数据间的区域。
            /// </summary>
            End
        }
        [SerializeField] private bool m_Show;
        [SerializeField] private AreaOrigin m_Origin;
        [SerializeField] private Color m_Color;
        [SerializeField] private Color m_ToColor;
        [SerializeField] [Range(0, 1)] private float m_Opacity;
        [SerializeField] private bool m_TooltipHighlight;
        [SerializeField] private Color m_HighlightColor;
        [SerializeField] private Color m_HighlightToColor;

        /// <summary>
        /// Set this to false to prevent the areafrom showing.
        /// 是否显示区域填充。
        /// </summary>
        public bool show
        {
            get { return m_Show; }
            set { if (PropertyUtility.SetStruct(ref m_Show, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// the origin of area.
        /// 区域填充的起始位置。
        /// </summary>
        public AreaOrigin origin
        {
            get { return m_Origin; }
            set { if (PropertyUtility.SetStruct(ref m_Origin, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// the color of area,default use serie color.
        /// 区域填充的颜色，如果toColor不是默认值，则表示渐变色的起点颜色。
        /// </summary>
        public Color color
        {
            get { return m_Color; }
            set { if (PropertyUtility.SetColor(ref m_Color, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// Gradient color, start color to toColor.
        /// 渐变色的终点颜色。
        /// </summary>
        public Color toColor
        {
            get { return m_ToColor; }
            set { if (PropertyUtility.SetColor(ref m_ToColor, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// Opacity of the component. Supports value from 0 to 1, and the component will not be drawn when set to 0.
        /// 图形透明度。支持从 0 到 1 的数字，为 0 时不绘制该图形。
        /// </summary>
        public float opacity
        {
            get { return m_Opacity; }
            set { if (PropertyUtility.SetStruct(ref m_Opacity, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// 鼠标悬浮时是否高亮之前的区域
        /// </summary>
        public bool tooltipHighlight
        {
            get { return m_TooltipHighlight; }
            set { if (PropertyUtility.SetStruct(ref m_TooltipHighlight, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// the color of area,default use serie color.
        /// 高亮时区域填充的颜色，如果highlightToColor不是默认值，则表示渐变色的起点颜色。
        /// </summary>
        public Color highlightColor
        {
            get { return m_HighlightColor; }
            set { if (PropertyUtility.SetColor(ref m_HighlightColor, value)) SetVerticesDirty(); }
        }
        /// <summary>
        /// Gradient color, start highlightColor to highlightToColor.
        /// 高亮时渐变色的终点颜色。
        /// </summary>
        public Color highlightToColor
        {
            get { return m_HighlightToColor; }
            set { if (PropertyUtility.SetColor(ref m_HighlightToColor, value)) SetVerticesDirty(); }
        }

        public static AreaStyle defaultAreaStyle
        {
            get
            {
                var area = new AreaStyle
                {
                    m_Show = false,
                    m_Color = Color.clear,
                    m_ToColor = Color.clear,
                    m_Opacity = 1
                };
                return area;
            }
        }
    }
}