Version: 2017.3

GridBrush

class in UnityEditor

/

继承自:GridBrushBase

切换到手册

描述

用于在网格上绘制或擦除瓦片和/或游戏对象的默认内置画笔。

默认画笔旨在完成两项操作:在网格上创作游戏对象和在网格上创作瓦片。必要时,它可同时用于这两种操作。基本上,默认画笔允许您在区域之间选择和粘贴瓦片和游戏对象。

如果带有 Tilemap 的游戏对象当前处于选中状态,则瓦片地图中的瓦片将被视为处于活动状态,可进行画笔编辑。 如果游戏对象的父项当前处于选中状态,则这些对象被视为处于活动状态,可进行画笔编辑。

例如:场景视图选取操作生成大小为 2x3 的新默认画笔。新实例包含六个单元格 (BrushCell),并且来自选取区域的瓦片和游戏对象将馈入这些单元格。

稍后,当此画笔用于绘制操作时,这些单元格中包含的所有瓦片和游戏对象都会设置/克隆到一个新的场景位置中。

创建自定义画笔时,建议默认继承 GridBrushBase。当需要类似功能时,可以继承 GridBrush,但是与基类相比,它在扩展方面具有局限性。

此外,也可以通过在其中一个自定义画笔上使用 GridDefaultBrush 属性来完全替换 Tile Palette 画笔列表中的默认 GridBrush,并将其提升为项目的新默认画笔。当较高级别的画笔可作为默认画笔运行并避免设计师意外使用内置画笔时,这十分有用。

变量

cellCount画笔中画笔单元格的数量。
cells画笔包含的所有画笔单元格。
pivot画笔的轴心。
size单元格中画笔的大小。

公共函数

BoxErase从所选层的给定边界内擦除瓦片和游戏对象。
BoxFill将瓦片和 GameObject 框填到所选图层的给定边界内。
Erase擦除所选层中给定位置内的瓦片和游戏对象。
Flip在给定的轴上翻转画笔。
FloodFill从所选层中的给定位置开始灌填瓦片和游戏对象。
GetCellIndex基于 BrushCell 的位置,获取到 GridBrush.BrushCell 的索引。
GetCellIndexWrapAround基于 BrushCell 的位置,获取到 GridBrush.BrushCell 的索引。如果每个坐标的大小大于 GridBrush,则对其进行封装。
Init初始化 GridBrush 的内容。
MoveEnd当用户已结束对之前使用选取框选择的区域进行移动时,将调用 MoveEnd。
MoveStart当用户开始对之前使用选取框选择的区域进行移动时,将调用 MoveEnd。
Paint将瓦片和游戏对象绘制到所选层中的给定位置。
Pick在给定单元格坐标的情况下,从所选的 tile maps 和子游戏对象中选取瓦片。
Reset清除画笔的所有数据。
Rotate按给定方向将画笔旋转 90 度。
SetColor设置画笔中相应位置的着色颜色。
SetMatrix在画笔中的相应位置设置变换矩阵。此矩阵专门用于 Tilemap 上的瓦片,而非画笔单元格的游戏对象。
SetTile在画笔中的相应位置设置瓦片。
UpdateSizeAndPivot更新画笔的大小、轴心和层数。

继承的成员

变量

hideFlags该对象应该隐藏、随场景一起保存还是由用户修改?
name对象的名称。

公共函数

Move当用户移动之前使用选取框选择的区域时,将调用 Move。
Select选择网格区域。
GetInstanceID返回对象的实例 ID。
ToString返回 GameObject 的名称。

静态函数

Destroy删除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad加载新场景时,不自动销毁对象 /target/。
FindObjectOfType返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType返回所有类型为 type 的已加载的激活对象的列表。
Instantiate克隆 original 对象并返回克隆对象。
CreateInstance创建脚本化对象的实例。

运算符

bool该对象是否存在?
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用,判断它们是否引用同一个对象。

消息

Awake当 ScriptableObject 脚本启动时调用此函数。
OnDestroy当脚本化对象将销毁时调用此函数。
OnDisable当脚本化对象超出范围时调用此函数。
OnEnable当对象加载时调用此函数。