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

AnimationInspector Class Reference

#include <AnimationInspector.h>

Inheritance diagram for AnimationInspector:
Tool

# Public Member Functions

override void update ()
 Update the tool's state.
override void show ()
 Show the tool.
override void hide ()
 Hide the tool.
override void processUserInput (uint16 pressedKey)

# Private Attributes

Sprite sprite
 Currently inspected sprite.
const AnimationFunction ** animationFunctions
 Animations to apply to the animated sprite.
AnimationFunction animationFunction
 Currently applied animation.
OptionsSelector actorSelector
 Selector for the animated actors.
OptionsSelector spriteSelector
 Selector for the animated sprite sprite selector.
OptionsSelector animationsSelector
 Selector for the animations to play.
OptionsSelector animationEditionSelector
 Selector for the animation's properties.
OptionsSelector frameEditionSelector
 Selector for the animation's frames.
int32 state
 Inspector's state.
- Private Attributes inherited from Tool
ToolState toolState

# Additional Inherited Members

- Private Member Functions inherited from Tool
void constructor ()
 Class' constructor.
void setToolState (ToolState toolState)
virtual void dimmGame ()
 Dimm down the game.
virtual void lightUpGame ()
 Light up the game.

# Detailed Description

Class AnimationInspector

Inherits from Tool

Implements a tool that manipulates animations.

Definition at line 45 of file AnimationInspector.h.

# Member Function Documentation

# hide()

override void AnimationInspector::hide ( )
virtual

Hide the tool.

Implements Tool.

# processUserInput()

override void AnimationInspector::processUserInput ( uint16 pressedKey)
virtual

Process the provided user pressed key.

Parameters
pressedKeyUser pressed key

Implements Tool.

# show()

override void AnimationInspector::show ( )
virtual

Show the tool.

Implements Tool.

# update()

override void AnimationInspector::update ( )
virtual

Update the tool's state.

Implements Tool.

# Member Data Documentation

# actorSelector

OptionsSelector AnimationInspector::actorSelector
private

Selector for the animated actors.

Definition at line 57 of file AnimationInspector.h.

# animationEditionSelector

OptionsSelector AnimationInspector::animationEditionSelector
private

Selector for the animation's properties.

Definition at line 66 of file AnimationInspector.h.

# animationFunction

AnimationFunction AnimationInspector::animationFunction
private

Currently applied animation.

Definition at line 54 of file AnimationInspector.h.

# animationFunctions

const AnimationFunction** AnimationInspector::animationFunctions
private

Animations to apply to the animated sprite.

Definition at line 51 of file AnimationInspector.h.

# animationsSelector

OptionsSelector AnimationInspector::animationsSelector
private

Selector for the animations to play.

Definition at line 63 of file AnimationInspector.h.

# frameEditionSelector

OptionsSelector AnimationInspector::frameEditionSelector
private

Selector for the animation's frames.

Definition at line 69 of file AnimationInspector.h.

# sprite

Sprite AnimationInspector::sprite
private

Currently inspected sprite.

Definition at line 48 of file AnimationInspector.h.

# spriteSelector

OptionsSelector AnimationInspector::spriteSelector
private

Selector for the animated sprite sprite selector.

Definition at line 60 of file AnimationInspector.h.

# state

int32 AnimationInspector::state
private

Inspector's state.

Definition at line 72 of file AnimationInspector.h.


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