Game::ComponentInspection Class Reference

#include <componentinspection.h>

Detailed Description

Component inspection functions.

Implements various inspection functions for different types of components

Copyright

(C) 2020 Individual contributors, see AUTHORS file

Public Types
using	DrawFunc = void(*)(Game::ComponentId, void*, bool*)

Static Public Member Functions
static ComponentInspection *	Instance ()
	The registry's constructor is called by the Instance() method, and nobody else.
static void	Destroy ()
	This static method is used to destroy the registry object and should be called right before the main function exits.
static void	Register (ComponentId component, DrawFunc)
static void	DrawInspector (ComponentId component, void *data, bool *commit)

Public Attributes
bool	debug = false

Private Member Functions
	ComponentInspection ()
	~ComponentInspection ()

Private Attributes
Util::Array< DrawFunc >	inspectors

Static Private Attributes
static ComponentInspection *	Singleton = nullptr

Member Typedef Documentation

DrawFunc

using Game::ComponentInspection::DrawFunc = void(*)(Game::ComponentId, void*, bool*)

Constructor & Destructor Documentation

ComponentInspection()

Game::ComponentInspection::ComponentInspection ( )

private

~ComponentInspection()

Game::ComponentInspection::~ComponentInspection ( )

private

Member Function Documentation

Destroy()

void Game::ComponentInspection::Destroy ( )

static

This static method is used to destroy the registry object and should be called right before the main function exits.

It will make sure that no accidential memory leaks are reported by the debug heap.

DrawInspector()

void Game::ComponentInspection::DrawInspector ( ComponentId component, void * data, bool * commit )

static

Instance()

ComponentInspection * Game::ComponentInspection::Instance ( )

static

The registry's constructor is called by the Instance() method, and nobody else.

Register()

void Game::ComponentInspection::Register ( ComponentId component, DrawFunc func )

static

Member Data Documentation

debug

bool Game::ComponentInspection::debug = false

inspectors

Util::Array<DrawFunc> Game::ComponentInspection::inspectors

private

Singleton

ComponentInspection * Game::ComponentInspection::Singleton = nullptr

staticprivate

---

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

• /github/workspace/code/application/game/componentinspection.h
• /github/workspace/code/application/game/componentinspection.cc