Draw Debug Helpers

Base:

class

Type:

FNDrawDebugHelpers

Header File:

NexusCore/Public/NDrawDebugHelpers.h

A set of functionality made to extend DrawDebug commands. Adds string drawing via FNPrimitiveFont, plus swept-shape and collision-shape rendering not provided by the engine's built-in helpers.

Methods

Draw String

Draws a string using FNPrimitiveFont. Lines are emitted via the world's line-batch component.

/**
 * Draws a string using the FNPrimitiveFont.
 * @param InWorld Which world to operate in.
 * @param String The string to draw out.
 * @param Position The world position to start drawing the string at.
 * @param Rotation The world rotation to apply to the drawing, the base orientation is backwards facing. 
 * @param bPersistentLines Should the drawn lines be permanent?
 * @param LifeTime How long should the lines last if not permanent?
 * @param DepthPriority What priority should they be drawn at?
 * @param ForegroundColor The color to use when drawing the lines for the string.
 * @param Scale The multiplier to apply to glyph size.
 * @param LineHeight The height used to represent a line.
 * @param Thickness The thickness of the lines used to draw glyphs.
 * @param bInvertLineFeed Should new lines be stacked on top of older lines?
 * @param bDrawBelowPosition Should the top of the first line align with the position?
 */
static void DrawString(const UWorld* InWorld, FString& String, const FVector& Position,
  const FRotator& Rotation, bool bPersistentLines = false, float LifeTime = -1.f, uint8 DepthPriority = SDPG_World,
  FLinearColor ForegroundColor = FLinearColor::White, float Scale = 1, float LineHeight = 4.f,
  float Thickness = 8.f, const bool bInvertLineFeed = false, const bool bDrawBelowPosition = true);

Draw Sweep

Draws a swept FCollisionShape from a start to an end position, dispatching to the correct shape helper.

/**
 * Draws a swept FCollisionShape from a start to an end position, dispatching to the correct shape helper.
 * @param InWorld Which world to operate in.
 * @param StartPosition World position where the sweep begins.
 * @param EndPosition World position where the sweep ends.
 * @param Quat Rotation of the swept shape.
 * @param Shape The collision shape to sweep (Line, Box, Sphere or Capsule).
 * @param Color Color used for the drawn debug lines.
 * @param bPersistentLines Should the drawn lines be permanent?
 * @param LifeTime How long the lines should last if not permanent.
 * @param DepthPriority The scene depth priority group to draw into.
 * @param Thickness Line thickness in pixels.
 */
FORCEINLINE static void DrawSweep(const UWorld* InWorld, const FVector& StartPosition, const FVector& EndPosition,
  const FQuat& Quat, const FCollisionShape& Shape, const FColor& Color, const bool bPersistentLines = false,
  const float LifeTime = -1.f, const uint8 DepthPriority = SDPG_World, const float Thickness = 2.f);

Draw Box Sweep

Draws a swept box from a start to an end position, including the box at both endpoints and connecting edges.

static void DrawBoxSweep(const UWorld* InWorld, const FVector& StartPosition, const FVector& EndPosition,
  const FQuat& Quat, const FVector& HalfSize, const FColor& Color, bool bPersistentLines = false,
  float LifeTime = -1.f, uint8 DepthPriority = SDPG_World, float Thickness = 2.f);

Draw Sphere Sweep

Draws a swept sphere from a start to an end position with connecting capsule-style tangent lines.

static void DrawSphereSweep(const UWorld* InWorld, const FVector& StartPosition, const FVector& EndPosition,
  float Radius, const FColor& Color, bool bPersistentLines = false, float LifeTime = -1.f,
  uint8 DepthPriority = SDPG_World, float Thickness = 2.f);

Draw Capsule Sweep

Draws a swept capsule from a start to an end position, including the capsule at both endpoints.

static void DrawCapsuleSweep(const UWorld* InWorld, const FVector& StartPosition, const FVector& EndPosition,
  const FQuat& Quat, float HalfHeight, float Radius, const FColor& Color, bool bPersistentLines = false,
  float LifeTime = -1.f, uint8 DepthPriority = SDPG_World, float Thickness = 2.f);

Draw Collision Shape

Draws a static (non-swept) collision shape at a given position and orientation.

static void DrawCollisionShape(const UWorld* InWorld, const FVector& Position, const FQuat& Quat,
  const FCollisionShape& Shape, const FColor& Color, bool bPersistentLines = false, float LifeTime = -1.f,
  uint8 DepthPriority = SDPG_World, float Thickness = 2.f);