Debugging

Editor debugging utilities for Unity.
All of these methods are accessed through DebugUtils..

vertx-debugging.mov

General

• DrawText
  Draws a label in the scene view at the provided position

3D

Shapes

• DrawSphere
• DrawBox
• DrawCapsule
• DrawBounds
• DrawSurfacePoint
  Draws a ray with a circle to indicate the surface
• DrawPoint
  Draws a point without specifying direction
• DrawAxis
  Draws an XYZ direction gizmo
• DrawArrow
  Draws an arrow gizmo for a vector. +Support for IList/IEnumerable.
• DrawLine
  +Support for IList/IEnumerable.

Casts

• DrawRaycast, (DrawRaycastHits)
• DrawSphereCast, (DrawSphereCastHits)
• DrawBoxCast, (DrawBoxCastHits)
• DrawCapsuleCast, (DrawCapsuleCastHits)

2D

Shapes

• DrawCircle2D
• DrawBox2D
• DrawArea2D
• DrawCapsule2D
• DrawRect
• DrawPoint2D
  Draws a point without specifying direction
• DrawAxis2D
  Draws an XY direction gizmo
• DrawArrow2D
  Draws an arrow gizmo for a vector

Casts

• DrawRaycast2D, (DrawRaycast2DHits)
• DrawCircleCast2D, (DrawCircleCast2DHits)
• DrawBoxCast2D, (DrawBoxCast2DHits)
• DrawCapsuleCast2D, (DrawCapsuleCast2DHits)

Gizmos

• GameViewGizmosEnabled
  bool: whether Gizmos are enabled in the Game view.
• DrawGizmosScope
  using (DebugUtils.DrawGizmosScope()): allows the use of other DebugUtils methods inside of OnDrawGizmos methods.

Components

• Debug Mesh Normals
  Draws normals for a (read/write) mesh.
• Debug Renderer Bounds
  Draws the bounds of a renderer.
• Debug Transform
  Draws up/right/forward axes of a transform.

Installation

Add from OpenUPM | via scoped registry, recommended

This package is available on OpenUPM: https://openupm.com/packages/com.vertx.debugging

To add it the package to your project:

• open Edit/Project Settings/Package Manager
• add a new Scoped Registry:

  Name: OpenUPM
  URL:  https://package.openupm.com/
  Scope(s): com.vertx
  

• click Save
• open Package Manager
• click +
• select Add from Git URL
• paste com.vertx.debugging
• click Add

Add from GitHub | not recommended, no updates through UPM

You can also add it directly from GitHub on Unity 2019.4+. Note that you won't be able to receive updates through Package Manager this way, you'll have to update manually.

• open Package Manager
• click +
• select Add from Git URL
• paste https://github.com/vertxxyz/Vertx.Debugging.git
• click Add
  or
• Edit your manifest.json file to contain "com.vertx.debugging": "https://github.com/vertxxyz/Vertx.Debugging.git",

To update the package with new changes, remove the lock from the packages-lock.json file.