mirror of
https://github.com/DCFApixels/Unity-DebugX.git
synced 2025-09-18 01:54:37 +08:00
132 lines
5.0 KiB
Markdown
132 lines
5.0 KiB
Markdown
# Unity-DebugX
|
||
|
||
v
|
||
|
||
Многофункциональная, расширяемая и производительная утилита рисования Gizmos для Unity. Работает как в редакторе так и в билде, а рисовать можно и в Update.
|
||
|
||
Синтаксис:
|
||
```c#
|
||
DebugX.Draw(duration, color).*Gizmo Function*(...);
|
||
```
|
||
|
||
|
||
|
||
|
||
# Установка
|
||
Семантика версионирования - [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
|
||
### Unity-пакет
|
||
Поддерживается установка в виде Unity-пакета через добавление [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json` этого git-URL:
|
||
```
|
||
https://github.com/DCFApixels/DragonECS.git
|
||
```
|
||
### В виде исходников
|
||
Пакет так же может быть добавлен в проект в виде исходников.
|
||
</br>
|
||
|
||
|
||
# API
|
||
|
||
Синтаксис рисования заготовленных Gizmo:
|
||
```c#
|
||
DebugX.Draw(duration, color).*Gizmo Function*(...);
|
||
```
|
||
|
||
Рисование кастомных меша и материала:
|
||
```c#
|
||
//Рисования любого меша lit материалом. Без GPU instancing.
|
||
DebugX.Draw(...).Mesh(mesh, pos, rot, sc);
|
||
//UnlitMesh - меш с unlit материалом
|
||
//WireMesh - меш с wireframe материалом
|
||
```
|
||
```c#
|
||
//Рисования статического меша lit материалом. В режиме GPU instancing.
|
||
DebugX.Draw(...).Mesh<IStaticMesh>(pos, rot, sc);
|
||
//UnlitMesh<IStaticMesh> - меш с unlit материалом
|
||
//WireMesh<IStaticMesh> - меш с wireframe материалом
|
||
```
|
||
```c#
|
||
//Рисования статического меша статическим материалом. В режиме GPU instancing.
|
||
DebugX.Draw(...).Mesh<IStaticMesh, IStaticMat>(pos, rot, sc);
|
||
```
|
||
|
||
Для оптимизации отрисовки используются статические данные:
|
||
```c#
|
||
// Статический меш. Обязателен для отрисовки с GPU instancing.
|
||
public struct SomeMesh : IStaticMesh
|
||
{
|
||
public Mesh GetMesh() => StaticStorage.SomeMesh;
|
||
}
|
||
```
|
||
```c#
|
||
// Статический материал.
|
||
public struct SomeMesh : IStaticMesh
|
||
{
|
||
// Контроль порядка выполнения рендереров.
|
||
public int GetExecuteOrder() => 100;
|
||
public Mesh GetMaterial() => StaticStorage.SomeMaterial;
|
||
}
|
||
```
|
||
|
||
> Утилита для загрузки статических ассетов: //TODO
|
||
|
||
# Настройки
|
||
Окно настроек "Tools -> DebugX -> Settings":
|
||
|
||
|
||
|
||
|
||
# Кастомный Gizmo
|
||
|
||
Кастомная реализация Gizmo:
|
||
```c#
|
||
public readonly struct SomeGizmo : IGizmo<SomeGizmo>
|
||
{
|
||
// Данные.
|
||
|
||
public SomeGizmo(/*...*/)
|
||
{
|
||
// Заполнение данных.
|
||
}
|
||
|
||
public IGizmoRenderer<SomeGizmo> RegisterNewRenderer() => new Renderer();
|
||
private class Renderer : IGizmoRenderer<SomeGizmo>
|
||
{
|
||
// Контроль порядка выполнения рендереров.
|
||
public int ExecuteOrder => 0; //можно использовать default(SomeMat).GetExecutuonOrder();
|
||
// Флаг системе о способе оптимизации.
|
||
// Если метод рисовки или подготовки зависят от текущей камеры, то false，иначе true.
|
||
// Если не уверены то выбирайте false.
|
||
public bool IsStaticRender => false;
|
||
|
||
// Подготовка данных перед рендером, тут можно выполнить дополнительные расчеты или запланировать Job.
|
||
public void Prepare(Camera camera, GizmosList<SomeGizmo> list)
|
||
{
|
||
foreach (var item in list)
|
||
{
|
||
//...
|
||
}
|
||
}
|
||
|
||
// Рендер, тут можно напрямую воспользоваться графическим API или добавить команду в CommandBuffer.
|
||
public void Render(Camera camera, GizmosList<SomeGizmo> list, CommandBuffer cb)
|
||
{
|
||
foreach (var item in list)
|
||
{
|
||
//...
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
```c#
|
||
// Создание метода расширения.
|
||
public static class SomeGizmoExtensions
|
||
{
|
||
public static DrawHandler SomeGizmo(this DrawHandler self, /*...*/)
|
||
{
|
||
self.Gizmo(new SomeGizmo(/*...*/);
|
||
return self;
|
||
}
|
||
}
|
||
```
|