1. Epic GamesDeveloper
  3. FCameraDebugRenderer

FCameraDebugRenderer

Utility class for camera-related debug drawing.

API > API/Plugins > API/Plugins/GameplayCameras

Utility class for camera-related debug drawing.

   
Name FCameraDebugRenderer
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Debug/CameraDebugRenderer.h
Include Path #include "Debug/CameraDebugRenderer.h"

Syntax

class FCameraDebugRenderer

Constructors

Name Remarks Include Path Unreal Specifiers

FCameraDebugRenderer ( UWorld* InWorld,
const FSceneView* InSceneView,
FCanvas* InCanvas,
bool bInIsExternalRendering
)

 Creates a new debug renderer. Debug/CameraDebugRenderer.h  

FCameraDebugRenderer ( UWorld* InWorld,
UCanvas* InCanvasObject,
bool bInIsExternalRendering
)

 Creates a new debug renderer. Debug/CameraDebugRenderer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FCameraDebugRenderer()

 Destroys the debug renderer. Debug/CameraDebugRenderer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsExternalRendering bool Whether we are looking from the "outside" of the camera system. Debug/CameraDebugRenderer.h  
Canvas FCanvas * The canvas used to draw the text wall. Debug/CameraDebugRenderer.h  
CanvasSize FVector2D The size of the canvas. Debug/CameraDebugRenderer.h  
DrawColor FColor The draw color of the canvas. Debug/CameraDebugRenderer.h  
Formatter TStringBuilder< 512 > Temporary string formatter for variadic methods. Debug/CameraDebugRenderer.h  
IndentLevel int8 Current indent level. Debug/CameraDebugRenderer.h  
LineBuilder TStringBuilder< 512 > String formatter for building a line up until the point it needs to be rendered. Debug/CameraDebugRenderer.h  
MaxCharHeight int32 The height of one line of the text wall. Debug/CameraDebugRenderer.h  
NextCardColumn int8 The index of the column for displaying the next card item. Debug/CameraDebugRenderer.h  
NextCardPosition FVector2f The next available position for a card item. Debug/CameraDebugRenderer.h  
NextDrawPosition FVector2f The screenspace coordinates for the next block of text on the wall. Debug/CameraDebugRenderer.h  
RenderFont const UFont * The font used to render the text wall. Debug/CameraDebugRenderer.h  
RightMargin float The maximum horizontal extent of the text rendered so far. Debug/CameraDebugRenderer.h  
SceneView const FSceneView *   Debug/CameraDebugRenderer.h  
VisitFlags ECameraDebugDrawVisitFlags How to visit the next debug blocks. Debug/CameraDebugRenderer.h  
World UWorld * The world in which we might draw debug primitives. Debug/CameraDebugRenderer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddIndent()

 Increases the indent of the next text wall entry. This will make a new line. Debug/CameraDebugRenderer.h  

void AddText ( const TCHAR* Fmt,
...
)

   Debug/CameraDebugRenderer.h  

void AddText ( const FString& InString
)

 Adds text to the text wall. Debug/CameraDebugRenderer.h  

void BeginDrawing()

   Debug/CameraDebugRenderer.h  

void Draw2DBox ( const FVector2D& BoxPosition,
const FVector2D& BoxSize,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 2D box. Debug/CameraDebugRenderer.h  

void Draw2DBox ( const FBox2D& Box,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 2D box. Debug/CameraDebugRenderer.h  

void Draw2DCircle ( const FVector2D& Center,
float Radius,
const FLinearColor& LineColor,
float LineThickness,
int32 NumSides
)

 Draws a 2D circle. Debug/CameraDebugRenderer.h  

void Draw2DLine ( const FVector2D& Start,
const FVector2D& End,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 2D line. Debug/CameraDebugRenderer.h  

void Draw2DPointCross ( const FVector2D& Location,
float CrossSize,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 2D cross at a point. Debug/CameraDebugRenderer.h  

void DrawBox ( const FTransform3d& Transform,
const FVector3d& Size,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 3D box. Debug/CameraDebugRenderer.h  

void DrawBox ( const FVector3d& Center,
const FVector3d& Size,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 3D box. Debug/CameraDebugRenderer.h  

void DrawCamera ( const FTransform3d& Transform,
float HorizontalFieldOfView,
float AspectRatio,
float TargetDistance,
const FLinearColor& LineColor,
float CameraSize,
float LineThickness
)

 Draws a camera. Debug/CameraDebugRenderer.h  

void DrawCameraPose ( const FCameraPose& InCameraPose,
const FLinearColor& LineColor,
float CameraSize
)

 Draws the given camera pose using the DrawCamera method. Debug/CameraDebugRenderer.h  

void DrawClock ( FCameraDebugClock& InClock,
const FText& InClockName
)

 Draw a debug clock showing an angle or 2D vector at the next position available for a "card" debug item. Debug/CameraDebugRenderer.h  

void DrawCoordinateSystem ( const FVector3d& Location,
const FRotator3d& Rotation,
float AxesLength
)

 Draws a 3D coordinate system. Debug/CameraDebugRenderer.h  

void DrawCoordinateSystem ( const FTransform3d& Transform,
float AxesLength
)

 Draws a 3D coordinate system. Debug/CameraDebugRenderer.h  

void DrawDirectionalArrow ( const FVector3d& Start,
const FVector3d& End,
float ArrowSize,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 3D arrow. Debug/CameraDebugRenderer.h  

void DrawGraph ( TCameraDebugGraph< NumValues >& InGraph,
const FText& InGraphName
)

 Draw a debug graph showing one or more graph lines at the next position available for a "card" debug item. Debug/CameraDebugRenderer.h  

void DrawLine ( const FVector3d& Start,
const FVector3d& End,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 3D line. Debug/CameraDebugRenderer.h  

void DrawPoint ( const FVector3d& Location,
float PointSize,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 3D point. Debug/CameraDebugRenderer.h  

void DrawSphere ( const FVector3d& Center,
float Radius,
int32 Segments,
const FLinearColor& LineColor,
float LineThickness
)

 Draws a 3D sphere. Debug/CameraDebugRenderer.h  

void DrawText ( const FVector3d& WorldPosition,
const FVector2d& ScreenOffset,
const FString& Text,
const FLinearColor& TextColor,
UFont* TextFont,
float TextScale
)

 Draws text at a projected 3D position, with an added screen-space offset. Debug/CameraDebugRenderer.h  

void DrawText ( const FVector3d& WorldPosition,
const FString& Text,
const FLinearColor& TextColor,
UFont* TextFont,
float TextScale
)

 Draws text at a projected 3D position. Debug/CameraDebugRenderer.h  

void DrawTextBackgroundTile ( float Opacity
)

 Internal API. Debug/CameraDebugRenderer.h  

void DrawTextView ( const FVector3d& WorldPosition,
FStringView Text,
const FLinearColor& TextColor,
UFont* TextFont,
float TextScale
)

 Draws text at a projected 3D position. Debug/CameraDebugRenderer.h  

void DrawTextView ( const FVector3d& WorldPosition,
const FVector2d& ScreenOffset,
FStringView Text,
const FLinearColor& TextColor,
UFont* TextFont,
float TextScale
)

 Draws text at a projected 3D position, with an added screen-space offset. Debug/CameraDebugRenderer.h  

void EndDrawing()

   Debug/CameraDebugRenderer.h  

FCanvas * GetCanvas()

 Gets the drawing canvas. Debug/CameraDebugRenderer.h  

FVector2D GetCanvasSize()

 Gets the size of the canvas. Debug/CameraDebugRenderer.h  

FColor GetTextColor()

 Gets the current text color. Debug/CameraDebugRenderer.h  

ECameraDebugDrawVisitFlags GetVisitFlags()

 Gets block visiting flags. Debug/CameraDebugRenderer.h  

bool HasCanvas()

 Returns whether this renderer has a valid canvas to draw upon. Debug/CameraDebugRenderer.h  

bool IsExternalRendering()

 Whether we are looking at the camera system from the "outside". Debug/CameraDebugRenderer.h  

bool NewLine ( bool bSkipIfEmptyLine
)

 Move to a new line on the text wall. Debug/CameraDebugRenderer.h  

void RemoveIndent()

 Decreases the indent of the next text wall entry. This will make a new line. Debug/CameraDebugRenderer.h  

void ResetVisitFlags()

 Resets block visiting flags. Debug/CameraDebugRenderer.h  

FColor SetTextColor ( const FColor& Color
)

 Sets the text color for further calls. Returns the previous color. Debug/CameraDebugRenderer.h  

void SkipAllBlocks()

 Skip all related blocks (attached, children, etc.) Debug/CameraDebugRenderer.h  

void SkipAttachedBlocks()

 Request skipping drawing any blocks attached to the current block. Debug/CameraDebugRenderer.h  

void SkipChildrenBlocks()

 Request skipping drawing any children blocks of the current block. Debug/CameraDebugRenderer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page