Unity Debug Sheet

To implement a custom cell, you must create two components: a Cell<TModel> component for the UI and a CellModel class for the data.

Implementation Steps:

1. Define the Model: Create a class inheriting from CellModel containing the data properties.
2. Define the Cell: Create a class inheriting from Cell<CustomCellModel>. Implement the SetModel(model) method to apply model data to your UI elements.
3. UI Setup: Create a Prefab with your UI.
   • Crucial: Attach a Layout Element to the root GameObject and set a Preferred Height.
   • Crucial: Set a fixed width for the cell.
4. Registration: Add your new cell prefab to the Cell Prefabs list in the Debug Sheet configuration.
5. Usage: Call your custom Add[CellName] method from your debug page.

using UnityDebugSheet.Runtime.Core.Scripts;
using UnityEngine;
using UnityEngine.UI;

public sealed class CustomTextCell : Cell<CustomTextCellModel>
{
    [SerializeField] private Text _text;
    [SerializeField] private LayoutElement _layoutElement;

    private const int Padding = 36;

    protected override void SetModel(CustomTextCellModel model)
    {
        _text.text = model.Text;
        _text.color = model.Color;
        _layoutElement.preferredHeight = _text.preferredHeight + Padding;
    }
}

public sealed class CustomTextCellModel : CellModel
{
    public string Text { get; set; }
    public Color Color { get; set; } = Color.black;
}

The debug menu can be accessed via several methods:

• Flick Gesture: Flick up or down along the edge of the screen. The flickable area is approximately 6mm from the screen edge. This behavior can be configured on the Debug Sheet component via Flick To Open (enabling/disabling sides or disabling entirely).
• Click Gesture: Configure the Click To Open area and Click Count To Open on the Debug Sheet component to open the menu via taps.
• Keyboard Shortcut: The default shortcut is Control (Command on Mac) + Shift + D. This can be customized in the Keyboard Shortcut field of the Debug Sheet component.
• Scripting: You can programmatically toggle the menu by accessing the StatefulDrawerController on the DebugSheetCanvas > Drawer object.

// Programmatic toggle via script
// These scripts are attached on the GameObject "DebugSheetCanvas > Drawer".
StatefulDrawer drawer;
StatefulDrawerController drawerController;

// Toggle debug sheet.
var isClosed = Mathf.Approximately(drawer.Progress, drawer.MinProgress);
var targetState = isClosed ? DrawerState.Max : DrawerState.Min;
drawerController.SetStateWithAnimation(targetState);

To implement a custom cell, you must create two parts: a component inheriting from Cell<TModel> and a model inheriting from CellModel.

Implementation Steps:

1. Define the Model: Create a class inheriting from CellModel to hold the data.
2. Define the Cell: Create a component inheriting from Cell<CustomModel>. Override SetModel(model) to apply the model data to your UI elements.
3. Setup Prefab:
   • Attach a Layout Element to the root GameObject and set a Preferred Height.
   • Set the width to a fixed value.
   • Create a prefab from this GameObject.
4. Register: Add the new prefab to the Cell Prefabs list on the DebugSheet component.

Example Implementation:

using UnityDebugSheet.Runtime.Core.Scripts;
using UnityEngine;
using UnityEngine.UI;

public sealed class CustomTextCell : Cell<CustomTextCellModel>
{
    [SerializeField] private Text _text;
    [SerializeField] private LayoutElement _layoutElement;

    private const int Padding = 36;

    protected override void SetModel(CustomTextCellModel model)
    {
        _text.text = model.Text;
        _text.color = model.Color;
        _layoutElement.preferredHeight = _text.preferredHeight + Padding;
    }
}

public sealed class CustomTextCellModel : CellModel
{
    public string Text { get; set; }
    
    public Color Color { get; set; } = Color.black;
}

You can add debug pages to display information from various Unity classes using the UnityDebugSheet.Unity extension.

Available Debug Pages

Setup Steps

1. Assembly Reference: If you are using your own assembly, add UnityDebugSheet.Unity to your referenced assemblies.
2. Implementation: Use DefaultDebugPageBase.AddPageLinkButton<T> to add the page to your debug menu.

DefaultDebugPageBase.AddPageLinkButton<SystemInfoDebugPage>("System Info");