//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera (marko.pintera@gmail.com). All rights reserved. **********************//
using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using bs;
namespace bs.Editor
{
/** @addtogroup Inspector
* @{
*/
///
/// Displays GUI for a serializable property containing a list. List contents are displayed as rows of entries
/// that can be shown, hidden or manipulated.
///
public class InspectableList : InspectableField
{
private InspectableListGUI listGUIField;
///
/// Creates a new inspectable list GUI for the specified property.
///
/// Context shared by all inspectable fields created by the same parent.
/// Name of the property, or some other value to set as the title.
/// Full path to this property (includes name of this property and all parent properties).
/// 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.
/// Parent layout that all the field elements will be added to.
/// Serializable property referencing the list whose contents to display.
public InspectableList(InspectableContext context, string title, string path, int depth, InspectableFieldLayout layout,
SerializableProperty property)
: base(context, title, path, SerializableProperty.FieldType.List, depth, layout, property)
{
}
///
public override GUILayoutX GetTitleLayout()
{
return listGUIField.GetTitleLayout();
}
///
public override InspectableState Refresh(int layoutIndex)
{
return listGUIField.Refresh();
}
///
protected internal override void Initialize(int layoutIndex)
{
GUILayout arrayLayout = layout.AddLayoutY(layoutIndex);
listGUIField = InspectableListGUI.Create(context, title, path, property, arrayLayout, depth);
listGUIField.IsExpanded = context.Persistent.GetBool(path + "_Expanded");
listGUIField.OnExpand += x => context.Persistent.SetBool(path + "_Expanded", x);
}
///
public override InspectableField FindPath(string path)
{
string subPath = GetSubPath(path, depth + 1);
if (string.IsNullOrEmpty(subPath))
return null;
int lastLeftIdx = subPath.LastIndexOf('[');
int lastRightIdx = subPath.LastIndexOf(']', lastLeftIdx);
if (lastLeftIdx == -1 || lastRightIdx == -1)
return null;
int count = lastRightIdx - 1 - lastLeftIdx;
if (count <= 0)
return null;
string arrayIdxStr = subPath.Substring(lastLeftIdx, count);
if (!int.TryParse(arrayIdxStr, out int idx))
return null;
if (idx >= listGUIField.NumRows)
return null;
InspectableListGUIRow row = listGUIField.GetRow(idx);
InspectableField field = row?.Field;
if (field != null)
{
if (field.Path == path)
return field;
return field.FindPath(path);
}
return null;
}
///
/// Handles creation of GUI elements for a GUI list field that displays a object.
///
private class InspectableListGUI : GUIListFieldBase
{
private IList list;
private int numElements;
private InspectableContext context;
private SerializableProperty property;
private string path;
///
/// Context shared by all inspectable fields created by the same parent.
///
public InspectableContext Context
{
get { return context; }
}
///
/// Returns a property path to the array field (name of the array field and all parent object fields).
///
public string Path
{
get { return path; }
}
///
/// Returns the number of rows in the array.
///
public int NumRows
{
get { return GetNumRows(); }
}
///
/// Constructs a new empty inspectable list GUI.
///
/// Context shared by all inspectable fields created by the same parent.
/// Label to display on the list GUI title.
/// Full path to this property (includes name of this property and all parent properties).
///
/// Serializable property referencing a list.
/// Layout to which to append the list GUI elements to.
/// Determines at which depth to render the background. Useful when you have multiple
/// nested containers whose backgrounds are overlaping. Also determines background style,
/// depths divisible by two will use an alternate style.
public InspectableListGUI(InspectableContext context, LocString title, string path,
SerializableProperty property, GUILayout layout, int depth)
: base(title, layout, depth)
{
this.property = property;
this.context = context;
this.path = path;
list = property.GetValue();
if (list != null)
numElements = list.Count;
}
///
/// Creates a new inspectable list GUI object that displays the contents of the provided serializable property.
///
/// Context shared by all inspectable fields created by the same parent.
/// Label to display on the list GUI title.
/// Full path to this property (includes name of this property and all parent properties).
///
/// Serializable property referencing a list.
/// Layout to which to append the list GUI elements to.
/// Determines at which depth to render the background. Useful when you have multiple
/// nested containers whose backgrounds are overlaping. Also determines background style,
/// depths divisible by two will use an alternate style.
public static InspectableListGUI Create(InspectableContext context, LocString title, string path,
SerializableProperty property, GUILayout layout, int depth)
{
InspectableListGUI listGUI = new InspectableListGUI(context, title, path, property, layout, depth);
listGUI.BuildGUI();
return listGUI;
}
///
/// Returns a list row at the specified index.
///
/// Index of the row.
/// List row representation or null if index is out of range.
public InspectableListGUIRow GetRow(int idx)
{
if (idx < GetNumRows())
return (InspectableListGUIRow)rows[idx];
return null;
}
///
public override InspectableState Refresh()
{
// Check if any modifications to the array were made outside the inspector
IList newList = property.GetValue();
if (list == null && newList != null)
{
list = newList;
numElements = list.Count;
BuildGUI();
}
else if (newList == null && list != null)
{
list = null;
numElements = 0;
BuildGUI();
}
else
{
if (list != null)
{
if (numElements != list.Count)
{
numElements = list.Count;
BuildGUI();
}
}
}
return base.Refresh();
}
///
protected override GUIListFieldRow CreateRow()
{
return new InspectableListGUIRow();
}
///
protected override bool IsNull()
{
return list == null;
}
///
protected override int GetNumRows()
{
if (list != null)
return list.Count;
return 0;
}
///
protected internal override object GetValue(int seqIndex)
{
SerializableList list = property.GetList();
return list.GetProperty(seqIndex);
}
///
protected internal override void SetValue(int seqIndex, object value)
{
// Setting the value should be done through the property
throw new InvalidOperationException();
}
///
protected override void CreateList()
{
StartUndo();
list = property.CreateListInstance(0);
property.SetValue(list);
numElements = 0;
EndUndo();
}
///
protected override void ResizeList()
{
StartUndo();
int size = guiSizeField.Value;
IList newList = property.CreateListInstance(size);
int maxSize = MathEx.Min(size, list.Count);
for (int i = 0; i < maxSize; i++)
newList[i] = list[i];
property.SetValue(newList);
list = newList;
numElements = list.Count;
EndUndo();
}
///
protected override void ClearList()
{
StartUndo();
property.SetValue