FComposableCameraViewportDebug

#include <ComposableCameraViewportDebug.h>

Runtime 3D viewport debug draw for the Composable Camera System.

CCS.Debug.Viewport 0|1 is the live viewport master switch. Per-node and per-transition CVars remain opt-in for live drawing, while Rewind trace capture can force all 3D gizmos through its draw sink so playback has complete historical debug primitives even when live CVars were disabled.

Adding a new per-node gizmo:

Override UComposableCameraCameraNodeBase::DrawNodeDebug(FComposableCameraDebugDrawSink&, bool) in the concrete node, guarded #if !UE_BUILD_SHIPPING.
Declare a static TAutoConsoleVariable<int32> under CCS.Debug.Viewport.<NodeName>, default 0.
Early-out when the per-node CVar, ShouldShowAllNodeGizmos(), and Draw.ShouldForceDrawAllNodeGizmos() are all false.
Emit primitives through FComposableCameraDebugDrawSink and use FComposableCameraViewportDebugColors for shared legend colors.

All cost is guarded #if !UE_BUILD_SHIPPING. The ticker's body compiles to nothing in shipping builds.

Public Static Methods¶

Return	Name	Description
`void`	`Initialize` `static`	Register the FTSTicker delegate. Idempotent.
`void`	`Shutdown` `static`	Unregister the FTSTicker delegate. Idempotent.
`bool`	`ShouldShowAllNodeGizmos` `static`	True when `CCS.Debug.Viewport.Nodes.All` is non-zero. Rewind capture may additionally force all node gizmos through its draw sink.
`bool`	`ShouldShowAllTransitionGizmos` `static`	True when `CCS.Debug.Viewport.Transitions.All` is non-zero. Rewind capture may additionally force all transition gizmos through its draw sink.
`TConstArrayView< FComposableCameraViewportDebugLegendEntry >`	`GetLegendEntries` `static`	Shared legend metadata. The panel filters this palette against enabled CVars plus the current running camera and active transitions before drawing rows.
`float`	`GetSphereLabelDurationSeconds` `static`	Lifetime used for per-frame sphere labels. Zero prevents stale HUD text.
`void`	`DrawSolidDebugSphere` `static`	Draw a translucent-wireframe debug sphere, optionally with a short per-frame label.

Initialize¶

static

static void Initialize()

Shutdown¶

static

static void Shutdown()

Unregister the FTSTicker delegate. Idempotent.

ShouldShowAllNodeGizmos¶

static

static bool ShouldShowAllNodeGizmos()

True when CCS.Debug.Viewport.Nodes.All is non-zero. Live draw callsites combine this with their per-node CVar. Rewind capture sinks can separately force all node gizmos.

ShouldShowAllTransitionGizmos¶

static

static bool ShouldShowAllTransitionGizmos()

True when CCS.Debug.Viewport.Transitions.All is non-zero. Live draw callsites combine this with their per-transition CVar. Rewind capture sinks can separately force all transition gizmos.

GetLegendEntries¶

static

static TConstArrayView< FComposableCameraViewportDebugLegendEntry > GetLegendEntries()

Shared legend metadata. Used by the panel and tests so swatches come from the same color constants as 3D gizmos. The returned array is a palette, not live draw state: the panel still filters entries by enabled CVar state, node classes on the current running camera, and active transition class names before drawing legend rows.

GetSphereLabelDurationSeconds¶

static

static float GetSphereLabelDurationSeconds()

Lifetime used for per-frame sphere labels. Zero prevents stale HUD text.

DrawSolidDebugSphere¶

static

static void DrawSolidDebugSphere(class UWorld * World, const FVector & Center, float Radius, const FColor & Color, uint8 Alpha, int32 Segments, uint8 DepthPriority, const TCHAR * Label)

Draw a translucent-wireframe debug sphere. The Alpha parameter overrides Color.A; Segments is clamped to [4, 32]; DepthPriority follows the SDPG group where 1 means foreground. Label is optional short world-space text drawn above the sphere with a one-frame lifetime.