Olympe Engine 2.0
2D Game Engine with ECS Architecture
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Olympe::DebugPanel Class Reference

ImGui panel that exposes DebugController UI. More...

#include <DebugPanel.h>

Public Member Functions

 DebugPanel ()
 
 ~DebugPanel ()
 
void Initialize ()
 
void Shutdown ()
 
void Render ()
 Renders the debug panel window.
 
void SetVisible (bool v)
 Show / hide the panel.
 
bool IsVisible () const
 

Private Member Functions

void RenderToolbar ()
 
void RenderBreakpointsList ()
 
void RenderCallStack ()
 
void RenderWatchVariables ()
 
void RenderProfilerSummary ()
 

Private Attributes

bool m_visible = true
 

Detailed Description

ImGui panel that exposes DebugController UI.

Definition at line 24 of file DebugPanel.h.

Constructor & Destructor Documentation

◆ DebugPanel()

Olympe::DebugPanel::DebugPanel ( )

Definition at line 26 of file DebugPanel.cpp.

◆ ~DebugPanel()

Olympe::DebugPanel::~DebugPanel ( )

Definition at line 30 of file DebugPanel.cpp.

Member Function Documentation

◆ Initialize()

void Olympe::DebugPanel::Initialize ( )

Definition at line 34 of file DebugPanel.cpp.

Referenced by Olympe::BlueprintEditorGUI::Initialize().

+ Here is the caller graph for this function:

◆ IsVisible()

bool Olympe::DebugPanel::IsVisible ( ) const
inline

Definition at line 41 of file DebugPanel.h.

References m_visible.

◆ Render()

void Olympe::DebugPanel::Render ( )

Renders the debug panel window.

Includes toolbar, breakpoints list, call stack, and watch variables.

Definition at line 46 of file DebugPanel.cpp.

References GetComponentTypeID_Static(), m_visible, RenderBreakpointsList(), RenderCallStack(), RenderProfilerSummary(), RenderToolbar(), and RenderWatchVariables().

Referenced by Olympe::BlueprintEditorGUI::RenderFixedLayout().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RenderBreakpointsList()

void Olympe::DebugPanel::RenderBreakpointsList ( )
private

Definition at line 186 of file DebugPanel.cpp.

References Olympe::DebugController::Get(), and GetComponentTypeID_Static().

Referenced by Render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RenderCallStack()

void Olympe::DebugPanel::RenderCallStack ( )
private

Definition at line 231 of file DebugPanel.cpp.

References Olympe::DebugController::Get(), GetComponentTypeID_Static(), Olympe::SubGraphStackFrame::graphName, Olympe::SubGraphStackFrame::isCurrent, Olympe::SubGraphStackFrame::nodeID, and Olympe::SubGraphStackFrame::nodeName.

Referenced by Render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RenderProfilerSummary()

void Olympe::DebugPanel::RenderProfilerSummary ( )
private

Definition at line 339 of file DebugPanel.cpp.

References Olympe::NodeExecutionMetrics::avgTimeMs, Olympe::PerformanceProfiler::Get(), GetComponentTypeID_Static(), and Olympe::PerformanceProfiler::HOTSPOT_THRESHOLD_MS.

Referenced by Render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RenderToolbar()

void Olympe::DebugPanel::RenderToolbar ( )
private

Definition at line 75 of file DebugPanel.cpp.

References Olympe::DebugController::Get(), GetComponentTypeID_Static(), Olympe::NotDebugging, Olympe::Paused, Olympe::Running, Olympe::StepInto, Olympe::StepNext, and Olympe::StepOut.

Referenced by Render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RenderWatchVariables()

void Olympe::DebugPanel::RenderWatchVariables ( )
private

Definition at line 271 of file DebugPanel.cpp.

References Olympe::Bool, Olympe::EntityID, Olympe::Float, Olympe::DebugController::Get(), GetComponentTypeID_Static(), Olympe::LocalBlackboard::GetVariableNames(), Olympe::Int, Olympe::String, and Olympe::Vector.

Referenced by Render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetVisible()

void Olympe::DebugPanel::SetVisible ( bool  v)
inline

Show / hide the panel.

Definition at line 40 of file DebugPanel.h.

References GetComponentTypeID_Static(), and m_visible.

+ Here is the call graph for this function:

◆ Shutdown()

void Olympe::DebugPanel::Shutdown ( )

Definition at line 38 of file DebugPanel.cpp.

Referenced by Olympe::BlueprintEditorGUI::Shutdown().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_visible

bool Olympe::DebugPanel::m_visible = true
private

Definition at line 51 of file DebugPanel.h.

Referenced by IsVisible(), Render(), and SetVisible().


The documentation for this class was generated from the following files: