本文详细记录 SmartDataViewer 项目接口细节 并提供说明

为什么要使用 SmartDataViewer ？

SmartDataViewer 节约程序大量编辑器开发时间，在定义完成基础类型的时候，即可同步生成可视化编辑器。

特性

  1. 秒速生成编辑器
  2. 支持外联多个类
  3. 支持针对特定字段进行排序与查询
  4. 支持数据导出导入(内建UNITY3D Json支持)
  5. 支持开放式编辑器事件,几乎所有的事件与组件渲染 用户可自定义
  6. 通过标签定制编辑器字段显示方式,包括宽度，显示别名，显示排序，导出导入位置等

正确的打开姿势 / Tutorial

1.创建容器 / Create Container

Type 1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[Serializable]
public class DemoConfig : ConfigBase<Demo> { }

[Serializable]
public class Demo : IModel
{
	public Demo()
	{
		strList = new List<string>();
		list = new List<int>();
		supports = new List<int>();
		description = string.Empty;
	}

	public List<string> strList;

	public List<int> list;

	[ConfigEditorField(outLinkSubClass: "Supports")]
	public List<int> supports;

	public string description;

	[ConfigEditorField(outLinkSubClass: "Supports")]
	public int support;
}

Type 2

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[Serializable]
public class SupportsConfig : ConfigBase<Supports> { }

[Serializable]
public class Supports : IModel
{
	public Supports()
	{
		boolList = new List<bool>();
		description = string.Empty;
		colorList = new List<Color>();
		curveList = new List<AnimationCurve>();
		curve = new AnimationCurve();
		bounds = new Bounds();
		boundsList = new List<Bounds>();
	}
	public Vector2 testPoint;

	public List<bool> boolList;

	public int testID;

	public Bounds bounds;

	public Color PointColor;

	public AnimationCurve curve;

	public List<Color> colorList;

	public List<AnimationCurve> curveList;

	public List<Bounds> boundsList;

	public string description;
}

2.添加标签 / Add Attribute

ConfigEditorAttribute

容器标签 / Container Attribute

1
2
3
4
5
6
7
8
9
/// <summary>
/// Initializes a new instance of the <see cref="T:SmartDataViewer.ConfigEditorAttribute"/> class.
/// </summary>
/// <param name="editor_title">当前编辑器显示的名词</param>
/// <param name="load_path">当前编辑器数据文件的位置</param>
/// <param name="output_path">编辑文件导出路径</param>
/// <param name="disableSearch">是否禁用搜索栏</param>
/// <param name="disableSave">是否禁用保存按钮</param>
/// <param name="disableCreate">是否禁用添加按钮</param>

ConfigEditorFieldAttribute

字段标签 / Fields Attribute

1
2
3
4
5
6
7
8
9
10
11
12
13
/// <summary>
/// Initializes a new instance of the <see cref="T:SmartDataViewer.ConfigEditorFieldAttribute"/> class.
/// </summary>
/// <param name="order">编辑器字段显示顺序</param>
/// <param name="can_editor">If set to <c>true</c> can editor.</param>
/// <param name="display">编辑器中显示别名 不填为字段名</param>
/// <param name="width">编辑器中显示的字段宽度</param>
/// <param name="outLinkEditor">外联到新的编辑器</param>
/// <param name="outLinkSubClass">外联到新的子类型,如果遵循编辑器默认命名规则 只需要填写此项即可</param>
/// <param name="outLinkClass">外联到新的类型</param>
/// <param name="visibility">是否在编辑器中隐藏此字段</param>
/// <param name="outLinkDisplay">将显示外联数据的别名 默认显示外联数据的NickName如果没有则显示ID</param>
/// <param name="outLinkFilePath">外联数据的文件位置</param>

3.生成代码 / Click Build Button

点击build按钮 则会在指定路径生成数据编辑器
通过SmartDataViewer生成的编辑器

完成 / Complete

通过SmartDataViewer生成的编辑器