Panel displaying debug information entries. More...
Public Member Functions | |
| void | addDebugInfo (DebugInformation debugInfo) |
| Add debug information. More... | |
| void | dispose () |
| Dispose of widget. More... | |
| void | forEach (Block ablock) |
| Visit debug information with block with parameter DebugInformation. More... | |
| DebugInformation | getDebugInfoAt (int index) |
| Debug information at position. More... | |
| int | getDebugInfoCount () |
| Number of debug information. More... | |
| bool | hasDebugInfo (DebugInformation debugInfo) |
| Debug information is present. More... | |
| PanelDebugInformation | new () |
| Create window. More... | |
| void | onFrameUpdate (float elapsed) |
| Do frame update. More... | |
| void | removeAllDebugInfo () |
| Remove all debug information. More... | |
| void | removeDebugInfo (DebugInformation debugInfo) |
| Remove debug information. More... | |
Public Attributes | |
| Array | pDebugInformation |
| Array | pSortedList |
Protected Member Functions | |
| void | captureDebugInfo () |
| Capture debug information. More... | |
Detailed Description
Panel displaying debug information entries.
Basically a FormLayout aligned list of debug information entries. Each entry shows a label and a detail text. The window is transparent to be overlayed on screen. The window is set invisible if no debug information are present. Every frame update the debug information are captured and stored in Label objects in the window. Then the debug information are reset for the next frame to collect data. The developer does not have to do anything else than adding debug information objects to the window.
Member Function Documentation
◆ addDebugInfo()
| void Dragengine.Debugging.PanelDebugInformation.addDebugInfo | ( | DebugInformation | debugInfo | ) |
Add debug information.
◆ captureDebugInfo()
|
protected |
Capture debug information.
◆ dispose()
| void Dragengine.Debugging.PanelDebugInformation.dispose | ( | ) |
Dispose of widget.
◆ forEach()
| void Dragengine.Debugging.PanelDebugInformation.forEach | ( | Block | ablock | ) |
Visit debug information with block with parameter DebugInformation.
◆ getDebugInfoAt()
| DebugInformation Dragengine.Debugging.PanelDebugInformation.getDebugInfoAt | ( | int | index | ) |
Debug information at position.
◆ getDebugInfoCount()
| int Dragengine.Debugging.PanelDebugInformation.getDebugInfoCount | ( | ) |
Number of debug information.
◆ hasDebugInfo()
| bool Dragengine.Debugging.PanelDebugInformation.hasDebugInfo | ( | DebugInformation | debugInfo | ) |
Debug information is present.
◆ new()
| PanelDebugInformation Dragengine.Debugging.PanelDebugInformation.new | ( | ) |
Create window.
◆ onFrameUpdate()
| void Dragengine.Debugging.PanelDebugInformation.onFrameUpdate | ( | float | elapsed | ) |
Do frame update.
Captures the debug information into Labels in the window then resets all debug information. Shows the window if debug information are present. Does nothing if there are no debug information present.
◆ removeAllDebugInfo()
| void Dragengine.Debugging.PanelDebugInformation.removeAllDebugInfo | ( | ) |
Remove all debug information.
◆ removeDebugInfo()
| void Dragengine.Debugging.PanelDebugInformation.removeDebugInfo | ( | DebugInformation | debugInfo | ) |
Remove debug information.
Member Data Documentation
◆ pDebugInformation
| Array Dragengine.Debugging.PanelDebugInformation.pDebugInformation |
◆ pSortedList
| Array Dragengine.Debugging.PanelDebugInformation.pSortedList |
The documentation for this class was generated from the following file:
