#include <ToolState.h>

Inheritance diagram for ToolState:

# Public Member Functions
void	constructor ()
	Class' constructor.
override void	start (void *owner)
override void	update (void *owner)
override void	stop (void *owner)
override void	processUserInput (const UserInput *userInput)
void	configure (GameState currentGameState, Stage currentStage)
GameState	getCurrentGameState ()
Stage	getCurrentStage ()
ComponentManager	getComponentManager (uint32 componentType)
virtual bool	isKeyCombination (const UserInput *userInput)=0

# Static Public Member Functions
static ToolState	get (const UserInput *userInput)

# Private Attributes
Tool	tool
	The tool that the state uses.
GameState	currentGameState
	Game's current state.
Stage	currentStage
	Game's current stage.
Private Attributes inherited from GameState
UIContainer	uiContainer
	A container for actors that componse the UI.
Stage	stage
	A container for the game entites.
ComponentManager	componentManagers [kComponentTypes]
	Array of component managers.
Clock	logicsClock
	A clock for logics.
Clock	messagingClock
	A clock for messaging.
Clock	animationsClock
	A clock for animations.
Clock	physicsClock
	A clock for physics.
bool	stream
	Flags to enable or disable the streaming.
bool	transform
	Flags to enable or disable the transformations.
bool	processBehaviors
	Flags to enable or disable the behavior processing.
bool	processMutators
	Flags to enable or disable the mutator processing.
bool	updatePhysics
	Flags to enable or disable the physical simulations.
bool	processCollisions
	Flags to enable or disable the collision detection and processing.
uint8	framerate
bool	lockFrameRate
	If false, the game loop runs unlocked.

# Additional Inherited Members
Private Types inherited from GameState
enum	stopClocks
Private Member Functions inherited from GameState
void	constructor ()
	Class' constructor.
override bool	handleMessage (Telegram telegram)
override void	pause (void *owner)
override void	unpause (void *owner)
override bool	processMessage (void *owner, Telegram telegram)
void	configureStage (StageSpec *stageSpec, VirtualList positionedActorsToIgnore)
UIContainer	getUIContainer ()
void	purgeComponentManagers ()
	Force the purging of deleted components.
void	startClocks ()
	Start all the clocks.
void	pauseClocks ()
	Pause all the clocks.
void	unpauseClocks ()
	Unpause all the clocks.
void	stopClocks ()
	Stop all the clocks.
void	startClock (uint32 clockEnum)
void	pauseClock (uint32 clockEnum)
void	unpauseClock (uint32 clockEnum)
void	stopClock (uint32 clockEnum)
void	applyTransformationsUI ()
	Update the UI's children' global transformations.
bool	propagateMessage (int32 message)
bool	propagateString (const char *string)
Actor	getActorByName (const char *actorName)
void	showActorWithName (const char *actorName)
void	hideActorWithName (const char *actorName)
void	changeFramerate (int16 targetFPS, int32 duration)
void	streamAll ()
	Force to completely stream in and out actors and to initialize all.
bool	lockFrameRate ()
void	printClocks (int16 x, int16 y)
virtual void	enter (void *owner)
virtual void	execute (void *owner)
virtual void	exit (void *owner)
virtual void	suspend (void *owner)
virtual void	resume (void *owner)
virtual bool	isVersusMode ()

# Detailed Description

Class ToolState

Inherits from GameState

Defines an interface for game states that uses various debug tools.

Definition at line 35 of file ToolState.h.

# Member Function Documentation

# configure()

void ToolState::configure	(	GameState	currentGameState,
		Stage	currentStage )

Set the VUEngine's current game state and stage.

Parameters

currentGameState	Game's current game state
currentStage	Game's current stage

Definition at line 185 of file ToolState.c.

# constructor()

void ToolState::constructor ( )

Class' constructor.

Definition at line 83 of file ToolState.c.

# get()

static ToolState ToolState::get ( const UserInput * userInput )

static

Retrive the tool state that is unlocked by the provided user input.

Parameters

userInput User's keypad intpu

Returns: The ToolState that is unlocked if any

Definition at line 35 of file ToolState.c.

# getComponentManager()

ComponentManager ToolState::getComponentManager ( uint32 componentType )

Retrieve the manager for the provided component type.

Parameters

componentType Type of components of the desired manager

Returns: Component manager for the provided component type

Definition at line 207 of file ToolState.c.

# getCurrentGameState()

GameState ToolState::getCurrentGameState ( )

Retrieve the VUEngine's current game state.

Returns: Game's current game state

Definition at line 193 of file ToolState.c.

# getCurrentStage()

Stage ToolState::getCurrentStage ( )

Retrieve the VUEngine's current game state.

Returns: Game's current game state

Definition at line 200 of file ToolState.c.

# isKeyCombination()

virtual bool ToolState::isKeyCombination ( const UserInput * userInput )

pure virtual

Check if the provided user input unlocks the tool managed by this state.

Returns: True if the input matches the combination defined by the state

Implemented in AnimationInspectorState, DebugState, SoundTestState, and StageEditorState.

# processUserInput()

void ToolState::processUserInput ( const UserInput * userInput )

virtual

Process the provided user input.

Parameters

userInput Struct with the current user input information

Reimplemented from GameState.

Definition at line 175 of file ToolState.c.

# start()

void ToolState::start ( void * owner )

virtual

Prepares the object to enter this state.

Parameters

owner Object that is entering in this state

Reimplemented from GameState.

Definition at line 109 of file ToolState.c.

# stop()

void ToolState::stop ( void * owner )

virtual

Prepares the object to exit this state.

Parameters

owner Object that is exiting this state

Reimplemented from GameState.

Definition at line 156 of file ToolState.c.

# update()

void ToolState::update ( void * owner )

virtual

Updates the object in this state.

Parameters

owner Object that is in this state

Reimplemented from GameState.

Definition at line 130 of file ToolState.c.

# Member Data Documentation

# currentGameState

GameState ToolState::currentGameState

private

Game's current state.

Definition at line 41 of file ToolState.h.

# currentStage

Stage ToolState::currentStage

private

Game's current stage.

Definition at line 44 of file ToolState.h.

# tool

Tool ToolState::tool

private

The tool that the state uses.

Definition at line 38 of file ToolState.h.

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

VUEngine-Core/source/State/GameState/ToolState/ToolState.h
VUEngine-Core/source/State/GameState/ToolState/ToolState.c

Introduction

Setup

Basics

Language

User Guide

API

Tutorial

ToolState Class Referenceabstract

# Public Member Functions

# Static Public Member Functions

# Private Attributes

# Additional Inherited Members

# Detailed Description

# Member Function Documentation

# configure()

# constructor()

# get()

# getComponentManager()

# getCurrentGameState()

# getCurrentStage()

# isKeyCombination()

# processUserInput()

# start()

# stop()

# update()

# Member Data Documentation

# currentGameState

# currentStage

# tool