skizzle/docs/diagrammes/classes/classes.tex

227 lines
7.3 KiB
TeX
Raw Normal View History

2016-03-09 17:18:49 +00:00
\documentclass[tikz,border=30pt]{standalone}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{tikz}
\usepackage{tikz-uml}
\usepackage[french]{babel}
\begin{document}
\begin{tikzpicture}
2016-04-17 19:12:32 +00:00
%%%%%%%%%%%%%%%%%%%%%%%
%% CLASSES GÉNÉRALES %%
%%%%%%%%%%%%%%%%%%%%%%%
% Spécifications du gestionnaire de jeu
2016-03-28 17:33:12 +00:00
\umlclass{Manager}{
window : fenêtre\\
resource\_manager : \texttt{ResourceManager}\\
2016-04-17 19:12:32 +00:00
clock : horloge\\
states : pile de \texttt{State}
2016-03-09 17:18:49 +00:00
}{
2016-03-18 23:01:45 +00:00
start() : vide\\
2016-04-17 19:12:32 +00:00
pushState(state : \texttt{State}) : vide\\
popState() : vide
2016-03-09 17:18:49 +00:00
}
2016-04-17 19:12:32 +00:00
% Spécifications du gestionnaire de ressources
\umlclass[x=4,y=-4.5]{ResourceManager}{
textures : dictionnaire \texttt{string -> texture}\\
fonts : dictionnaire \texttt{string -> police}
music : musique
2016-04-03 19:59:47 +00:00
}{
2016-04-17 19:12:32 +00:00
getTexture(name : string) : texture\\
getFont(name : string) : texture\\
getLevelPath(name : string) : string\\
playMusic(name : string) : vide\\
stopMusic() : vide
2016-03-28 17:33:12 +00:00
}
2016-04-17 19:12:32 +00:00
\umluniassoc{Manager}{ResourceManager}
2016-03-09 17:18:49 +00:00
2016-04-17 19:12:32 +00:00
% Spécfications d'un état de jeu
\umlabstract[x=-4,y=-4.5]{State}{
manager : \texttt{Manager}
2016-03-28 17:33:12 +00:00
}{
2016-04-17 19:12:32 +00:00
\umlvirt{enable() : vide}\\
\umlvirt{processEvent(event : événement) : vide}\\
\umlvirt{frame() : vide}
2016-03-28 17:33:12 +00:00
}
2016-04-17 19:12:32 +00:00
\umlunicompo{Manager}{State}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% ÉTATS DE JEU PRINCIPAUX %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2016-03-28 17:33:12 +00:00
2016-04-17 19:12:32 +00:00
% Spécifications de l'état de jeu abstrait "niveau"
% qui est une collection d'objets
\umlabstract[y=-11]{Level}{
name : string\\
2016-04-03 19:59:47 +00:00
background : sprite\\
2016-04-17 19:12:32 +00:00
music : string\\
camera : vue\\
gravity\_direction : direction\\
total\_time : entier\\
players : \texttt{[Player]}\\
2016-04-03 19:59:47 +00:00
objects : \texttt{[Object]}\\
2016-04-17 19:12:32 +00:00
zone : \texttt{[vecteur]}
2016-03-28 17:33:12 +00:00
}{
2016-04-17 19:12:32 +00:00
enable() : vide\\
processEvent(event : événement) : vide\\
load(file : string) : vide\\
save(file : string) : vide\\
2016-04-03 19:59:47 +00:00
\umlvirt{frame() : vide}\\
draw() : vide\\
2016-04-17 19:12:32 +00:00
addObject(object : \texttt{Object})\\
removeObject(object : \texttt{Object})
2016-04-03 19:59:47 +00:00
}
2016-04-17 19:12:32 +00:00
\umlinherit{State}{Level}
2016-04-03 19:59:47 +00:00
2016-04-17 19:12:32 +00:00
% Spécifications de l'état de jeu "éditeur" qui permet
% de modifier des niveaux de jeu
\umlclass[x=-3.5,y=-18]{Editor}{
selection : \texttt{[Object]}
}{
enable() : vide\\
processEvent(event : événement) : vide\\
frame() : vide\\
select(objet: \texttt{Object}) : vide\\
selectAll() : vide\\
clearSelection() : vide\\
2016-04-03 19:59:47 +00:00
}
\umlinherit{Level}{Editor}
2016-04-17 19:12:32 +00:00
% Spécifications de l'état de jeu "jeu" qui permet
% de jouer aux niveaux créés
\umlclass[x=3.5,y=-18]{Game}{
mode : mode\\
next\_frame\_time : temps\\
pending\_kill : \texttt{[Object]}\\
time\_left : flottant
}{
enable() : vide\\
processEvent(event : événement) : vide\\
2016-04-03 19:59:47 +00:00
frame() : vide\\
2016-04-17 19:12:32 +00:00
update() : vide\\
kill(objet : \texttt{Object}) : vide
2016-03-28 17:33:12 +00:00
}
2016-04-03 19:59:47 +00:00
\umlinherit{Level}{Game}
2016-03-28 17:33:12 +00:00
2016-04-17 19:12:32 +00:00
% Spécifications des objets du jeu
\umlabstract[y=-25]{Object}{
2016-03-18 23:01:45 +00:00
acceleration : vecteur\\
2016-03-09 17:18:49 +00:00
velocity : vecteur\\
2016-03-18 23:01:45 +00:00
position : vecteur\\
mass : flottant\\
charge : flottant\\
restitution : flottant\\
2016-03-28 17:33:12 +00:00
static\_friction : flottant\\
dynamic\_friction : flottant\\
2016-03-18 23:01:45 +00:00
layer : entier
2016-03-09 17:18:49 +00:00
}{
2016-04-17 19:12:32 +00:00
\umlvirt{getForces(game : \texttt{Game}) : vecteur}\\
\umlvirt{activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur}\\
2016-03-18 23:01:45 +00:00
\umlvirt{getAABB() : boîte}\\
2016-04-17 19:12:32 +00:00
\umlvirt{getRadius() : flottant}\\
\umlvirt{draw(level : \texttt{Level}) : vide}\\
updateVelocity(game : \texttt{Game}) : vide\\
updatePosition() : vide\\
solveCollision(game : \texttt{Game}, object : \texttt{Object}, normal : vecteur) : vide\\
2016-03-28 17:33:12 +00:00
positionalCorrection(object : \texttt{Object}, normal : vecteur, depth : flottant) : vide\\
2016-03-09 17:18:49 +00:00
}
2016-04-17 19:12:32 +00:00
\umlunicompo{Level}{Object}
2016-03-09 17:18:49 +00:00
2016-04-17 19:12:32 +00:00
% Spécifications de l'objet "joueur"
\umlclass[x=-4,y=-31.5]{Player}{
2016-03-28 17:33:12 +00:00
player\_number : entier non-signé
}{
2016-04-17 19:12:32 +00:00
getForces(game : \texttt{Game}) : vecteur\\
draw(level : \texttt{Level}) : vide\\
activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur\\
getAABB() : boîte\\
getRadius() : flottant\\
2016-03-09 17:18:49 +00:00
}
2016-03-28 17:33:12 +00:00
\umlinherit{Object}{Player}
2016-03-09 17:18:49 +00:00
2016-04-17 19:12:32 +00:00
% Spécifications de l'objet "bloc"
\umlclass[x=4,y=-31.5]{Block}{}{
draw(level : \texttt{Level}) : vide\\
prepareDraw(resources : \texttt{ResourceManager}) : vide\\
activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur\\
getAABB() : boîte\\
getRadius() : flottant\\
2016-03-09 17:18:49 +00:00
}
\umlinherit{Object}{Block}
2016-04-17 19:12:32 +00:00
% Spécifications de l'objet "bloc de fin" permettant
% quand il est activé de terminer le niveau
\umlclass[x=0,y=-35]{FinishBlock}{}{
prepareDraw(resources : \texttt{ResourceManager}) : vide\\
activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur
}
\umlinherit{Block}{FinishBlock}
% Spécifications de l'objet "bloc de gravité" permettant
% quand il est activé de réorienter la gravité du niveau
\umlclass[x=8,y=-35]{GravityBlock}{
gravity\_direction : direction
}{
prepareDraw(resources : \texttt{ResourceManager}) : vide\\
activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur
}
\umlinherit{Block}{GravityBlock}
% Spécifications de l'objet "bloc tueur" permettant
% quand il est activé par un joueur de le tuer
\umlclass[x=0,y=-37.5]{KillBlock}{}{
prepareDraw(resources : \texttt{ResourceManager}) : vide\\
activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur
}
\umlinherit{Block}{KillBlock}
% Spécifications de l'objet "bloc d'échange" permettant
% quand il est activé par un joueur d'échanger sa charge
\umlclass[x=8,y=-37.5]{SwitchBlock}{}{
prepareDraw(resources : \texttt{ResourceManager}) : vide\\
activate(game : \texttt{Game}, object : \texttt{Object}) : vecteur
}
\umlinherit{Block}{SwitchBlock}
%%%%%%%%%%%%%%%%%%%%%%%%%%
%% ÉTATS DE JEU DU MENU %%
%%%%%%%%%%%%%%%%%%%%%%%%%%
% Spécifications de l'état de jeu "menu"
% qui est le premier état au démarrage et permet
% d'afficher les différents choix de jeu
\umlclass[x=-7,y=-11]{Menu}{
background : sprite\\
choices : \texttt{[string]}\\
actions : \texttt{[callback]}\\
selection : entier non-signé
}{
loadMainMenu() : vide\\
loadLevelMenu() : vide\\
loadEditorMenu() : vide\\
launchGame(path : string) : vide\\
launchEditor(path : string) : vide\\
launchRules() : vide\\
quit() : vide\\
enable() : vide\\
processEvent(event : événement) : vide\\
frame() : vide
}
\umlinherit{State}{Menu}
% Spécifications de l'état de jeu "règles" qui
% affiche l'image décrivant les règles
\umlclass[x=-14,y=-11]{Rules}{
background : sprite\\
}{
processEvent(event : événement) : vide\\
frame() : vide
}
\umlinherit{State}{Rules}
2016-03-09 17:18:49 +00:00
\end{tikzpicture}
\end{document}