Navigation
API > API/Runtime > API/Runtime/Chaos
A single frame of debug draw data
| Name | FChaosDDFrame |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/ChaosDebugDraw/ChaosDDFrame.h |
| Include Path | #include "ChaosDebugDraw/ChaosDDFrame.h" |
Syntax
class FChaosDDFrame : public TSharedFromThis< FChaosDDFrame >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FChaosDDFrame
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosDDFrame
(
const FChaosDDTimelineWeakPtr& InTimeline, |
ChaosDebugDraw/ChaosDDFrame.h | ||
FChaosDDFrame
(
FChaosDDFrame&& Other |
ChaosDebugDraw/ChaosDDFrame.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FChaosDDFrame() |
ChaosDebugDraw/ChaosDDFrame.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddToCost
(
int32 InCost |
ChaosDebugDraw/ChaosDDFrame.h | ||
virtual void BeginWrite() |
Used by the global frame to prevent render while queuing commands. | ChaosDebugDraw/ChaosDDFrame.h | |
virtual void EndWrite() |
Used by the global frame to prevent render while queuing commands. | ChaosDebugDraw/ChaosDDFrame.h | |
void EnqueueCommand
(
FChaosDDCommand&& InCommand |
ChaosDebugDraw/ChaosDDFrame.h | ||
void EnqueueLatentCommand
(
const Chaos::FLatentDrawCommand& InCommand |
ChaosDebugDraw/ChaosDDFrame.h | ||
virtual FChaosDDFramePtr ExtractFrame() |
Used by the global frame to extract all debug draw commands so far into a new frame for rendering. | ChaosDebugDraw/ChaosDDFrame.h | |
int32 GetCommandBudget() |
ChaosDebugDraw/ChaosDDFrame.h | ||
int32 GetCommandCost() |
ChaosDebugDraw/ChaosDDFrame.h | ||
const FSphere3d & GetDrawRegion() |
ChaosDebugDraw/ChaosDDFrame.h | ||
double GetDt() |
ChaosDebugDraw/ChaosDDFrame.h | ||
int64 GetFrameIndex() |
ChaosDebugDraw/ChaosDDFrame.h | ||
const FString & GetName() |
ChaosDebugDraw/ChaosDDFrame.h | ||
int32 GetNumCommands() |
ChaosDebugDraw/ChaosDDFrame.h | ||
int32 GetNumLatentCommands() |
ChaosDebugDraw/ChaosDDFrame.h | ||
double GetTime() |
ChaosDebugDraw/ChaosDDFrame.h | ||
FChaosDDTimelinePtr GetTimeline() |
ChaosDebugDraw/ChaosDDFrame.h | ||
bool IsInDrawRegion
(
const FSphere3d& InSphere |
ChaosDebugDraw/ChaosDDFrame.h | ||
bool IsInDrawRegion
(
const FVector& InPos |
ChaosDebugDraw/ChaosDDFrame.h | ||
bool IsInDrawRegion
(
const FBox3d& InBox |
ChaosDebugDraw/ChaosDDFrame.h | ||
void SetCommandBudget
(
int32 InCommandBudget |
ChaosDebugDraw/ChaosDDFrame.h | ||
void SetDrawRegion
(
const FSphere3d& InRegion |
ChaosDebugDraw/ChaosDDFrame.h | ||
void VisitCommands
(
const VisitorType& Visitor |
VisitorType = void(const FChaosDDCommand& Command) | ChaosDebugDraw/ChaosDDFrame.h | |
void VisitLatentCommands
(
const VisitorType& Visitor |
VisitorType = void(const Chaos::FLatentDrawCommand& Command) | ChaosDebugDraw/ChaosDDFrame.h | |
bool WasCommandBudgetExceeded() |
ChaosDebugDraw/ChaosDDFrame.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BuildName () |
Implemented in ChaosDDTimeline.h. | ChaosDebugDraw/ChaosDDFrame.h |