Class ScyllaUILayoutDebugDraw

Debug overlay for the Scylla UI Layout components. Walks the ScyllaUILayoutRoot's descendant hierarchy and draws a thin outline around every layout container and every wrapped child, using a distinct color per component type so designers can visually trace the layout structure.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
ScyllaUILayoutDebugDraw
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.destroyCancellationToken
MonoBehaviour.useGUILayout
MonoBehaviour.didStart
MonoBehaviour.didAwake
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.GetComponentIndex()
Component.CompareTag(TagHandle)
Component.transform
Component.transformHandle
Component.gameObject
Component.tag
Object.GetEntityId()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Scene)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.FindAnyObjectByType<T>()
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.FindObjectsByType<T>()
Object.FindObjectsByType<T>(FindObjectsInactive)
Object.ToString()
Object.name
Object.hideFlags
Namespace: Scylla.Core.Util.UI
Assembly: ScyllaCore.dll
Syntax
[AddComponentMenu("Scylla/UI/Layout/Layout Debug Draw")]
[DisallowMultipleComponent]
[RequireComponent(typeof(RectTransform))]
[DefaultExecutionOrder(100)]
[ExecuteAlways]
public sealed class ScyllaUILayoutDebugDraw : MonoBehaviour
Remarks

Outlines are rendered as canvas UI geometry through an internal Scylla.Core.Util.UI.ScyllaUILayoutDebugOverlay graphic that the component creates and keeps as the top-most sibling. Because the outlines live inside the canvas, they are pixel-accurate in the Game view and the Scene view alike, in every canvas render mode (Overlay, Camera, World Space), and they update live in edit mode as well as play mode (no DontDestroyOnLoad dependency).

Outlines stack additively when a single RectTransform hosts multiple Scylla components - for example a child stack that is also wrapped by a ScyllaUIFlexElement draws both a container outline and a wrapper outline at the same rect.

The component uses UnityEngine.DefaultExecutionOrder 100 to run after the ScyllaUILayoutRoot's solve flush in the same frame, so outlines track the latest solved layout.

Properties

Config

Per-component-type color palette and line thickness.

Declaration
public ScyllaUILayoutDebugDrawConfig Config { get; set; }
Property Value
Type Description
ScyllaUILayoutDebugDrawConfig

Enabled

Master on / off. When false the overlay is cleared and the component does no work each frame; toggle to true to start drawing outlines.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
bool

Methods

Draw()

Immediately walks the descendant hierarchy and rebuilds the outline overlay. Normally invoked automatically from LateUpdate when Enabled is true; exposed publicly so callers can drive the overlay manually.

Declaration
public void Draw()

Extension Methods

See Also