Rocket::Debugger::Plugin Class Reference

#include <Plugin.h>

Inheritance diagram for Rocket::Debugger::Plugin:

Collaboration diagram for Rocket::Debugger::Plugin:


Public Member Functions
bool	Initialise (Core::Context *context)
bool	SetContext (Core::Context *context)
void	SetVisible (bool visibility)
bool	IsVisible ()
void	Render ()
	Renders any debug elements in the debug context.
virtual void	OnShutdown ()
	Called when Rocket shuts down.
virtual void	OnContextDestroy (Core::Context *context)
virtual void	OnElementCreate (Core::Element *element)
virtual void	OnElementDestroy (Core::Element *element)
virtual void	ProcessEvent (Core::Event &event)

Detailed Description

Rocket plugin interface for the debugger.

Author:: Robert Curry

Member Function Documentation

bool Rocket::Debugger::Plugin::Initialise ( Core::Context * context )

Initialises the debugging tools into the given context.

Parameters:

[in] context The context to load the tools into.

Returns:: True on success, false if an error occured.

bool Rocket::Debugger::Plugin::SetContext ( Core::Context * context )

Sets the context to be debugged.

Parameters:

[in] context The context to be debugged.

Returns:: True if the debugger is initialised and the context was switched, false otherwise..

void Rocket::Debugger::Plugin::SetVisible ( bool visibility )

Sets the visibility of the debugger.

Parameters:

[in] visibility True to show the debugger, false to hide it.

bool Rocket::Debugger::Plugin::IsVisible ( )

Returns the visibility of the debugger.

Returns:: True if the debugger is visible, false if not.

void Rocket::Debugger::Plugin::OnContextDestroy ( Core::Context * context ) [virtual]

Called whenever a Rocket context is destroyed.

Parameters:

[in] context The destroyed context.

Reimplemented from Rocket::Core::Plugin.

void Rocket::Debugger::Plugin::OnElementCreate ( Core::Element * element ) [virtual]

Called whenever an element is created.

Parameters:

[in] element The created element.

Reimplemented from Rocket::Core::Plugin.

void Rocket::Debugger::Plugin::OnElementDestroy ( Core::Element * element ) [virtual]

Called whenever an element is destroyed.

Parameters:

[in] element The destroyed element.

Reimplemented from Rocket::Core::Plugin.

void Rocket::Debugger::Plugin::ProcessEvent ( Core::Event & event ) [virtual]

Event handler for events from the debugger elements.

Parameters:

[in] event The event to process.

Implements Rocket::Core::EventListener.

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

Source/Debugger/Plugin.h
Source/Debugger/Plugin.cpp

Rocket::Debugger::Plugin Class Reference

Public Member Functions

Detailed Description

Member Function Documentation