1. Home
  2. Documentation
  3. API
  4. Tool Class Reference

Tool Class Referenceabstract

#include <Tool.h>

Inheritance diagram for Tool:
ListenerObject AnimationInspector Debug SoundTest StageEditor

# Public Member Functions

void constructor ()
 Class' constructor.
void setToolState (ToolState toolState)
virtual void processUserInput (uint16 pressedKey)=0
virtual void dimmGame ()
 Dimm down the game.
virtual void lightUpGame ()
 Light up the game.
virtual void update ()=0
 Update the tool's state.
virtual void show ()=0
 Show the tool.
virtual void hide ()=0
 Hide the tool.

# Protected Attributes

ToolState toolState

# Additional Inherited Members

- Private Member Functions inherited from ListenerObject
void constructor ()
 Class' constructor.
void destructor ()
 Class' destructor.
void addEventListener (ListenerObject listener, uint16 eventCode)
void removeEventListener (ListenerObject listener, uint16 eventCode)
void removeEventListeners (uint16 eventCode)
void removeAllEventListeners ()
 Remove all listener objects.
bool hasActiveEventListeners ()
void fireEvent (uint16 eventCode)
void sendMessageTo (ListenerObject receiver, uint32 message, uint32 delay, uint32 randomDelay)
void sendMessageToSelf (uint32 message, uint32 delay, uint32 randomDelay)
void discardAllMessages ()
 Discard all messages, both to be sent and to be received.
void discardMessages (uint32 message)
virtual bool onEvent (ListenerObject eventFirer, uint16 eventCode)
virtual bool handleMessage (Telegram telegram)
- Private Attributes inherited from ListenerObject
VirtualList events
 List of registered events.
int8 eventFirings
 Counter that keeps track of the number of fired events to prevent race conditions in nested firings.

# Detailed Description

Class Tool

Inherits from Object

Defines an interface for debugging tools.

Definition at line 35 of file Tool.h.

# Member Function Documentation

# constructor()

void Tool::constructor ( )

Class' constructor.

Definition at line 51 of file Tool.c.

# dimmGame()

void Tool::dimmGame ( )
virtual

Dimm down the game.

Definition at line 69 of file Tool.c.

# hide()

virtual void Tool::hide ( )
pure virtual

Hide the tool.

Implemented in AnimationInspector, Debug, SoundTest, and StageEditor.

# lightUpGame()

void Tool::lightUpGame ( )
virtual

Light up the game.

Definition at line 89 of file Tool.c.

# processUserInput()

virtual void Tool::processUserInput ( uint16 pressedKey)
pure virtual

Process the provided user pressed key.

Parameters
pressedKeyUser pressed key

Implemented in AnimationInspector, Debug, SoundTest, and StageEditor.

# setToolState()

void Tool::setToolState ( ToolState toolState)

Set the VUEngine's current game state.

Parameters
currentGameStateGame's current game state

Definition at line 99 of file Tool.c.

# show()

virtual void Tool::show ( )
pure virtual

Show the tool.

Implemented in AnimationInspector, Debug, SoundTest, and StageEditor.

# update()

virtual void Tool::update ( )
pure virtual

Update the tool's state.

Implemented in AnimationInspector, Debug, SoundTest, and StageEditor.

# Member Data Documentation

# toolState

ToolState Tool::toolState
protected

Definition at line 39 of file Tool.h.


The documentation for this class was generated from the following files:
  • VUEngine-Core/source/Debugging/Tool/Tool.h
  • VUEngine-Core/source/Debugging/Tool/Tool.c