fr.lip6.sma.simulacion.avatar
Class Avatar

java.lang.Object
  extended by fr.lip6.sma.simulacion.avatar.Avatar
All Implemented Interfaces:
Comparable

public final class Avatar
extends Object
implements Comparable

Classe pour les avatars (modèle). Les avatars sont les personnages à l'écran qui représentent les joueurs.

Version:
$Revision: 3 $
Author:
Paul Guyot
See Also:
Test

Field Summary
private  String mAttitude
          Référence sur l'attitude courante de l'avatar.
private  Map mImageCollections
          Référence sur les vues de l'avatar.
private  String mName
          Référence sur le nom de l'avatar.
private  Collection mViews
          Liste des vues sur cet avatar.
static String VIEWS_KEY
          Clé pour les vues dans la structure de configuration d'un avatar.
 
Constructor Summary
private Avatar(String inName, Map inImageCollections)
          Constructeur à partir d'un nom, d'une collections d'images et d'un booléen déterminant si l'avatar est activé ou non (peut être choisi ou non).
 
Method Summary
 void addView(AvatarView inView)
          Ajout d'une vue dans la liste des vues de l'avatar.
 int compareTo(Object inAlter)
          Interface Comparable.
 boolean equals(Object inAlter)
          Egalité conforme avec l'interface comparable.
 String getAttitude()
          Accesseur sur l'attitude de l'avatar.
 AvatarImageCollection getImageCollection(String inCollectionID)
          Accesseur sur une collection particulière d'images pour l'avatar.
 Set getImageCollectionIDs()
          Accesseur sur l'ensemble des vues (collections d'images).
 String getName()
          Accesseur sur le nom.
 int hashCode()
          Valeur de hachage conforme à l'égalité.
static Map loadAvatars(Map inAvatarsConfig, SimulacionMediaTracker inTracker)
          Charge les avatars à partir du tableau issu de la configuration.
 void removeView(AvatarView inView)
          Suppression d'une vue dans la liste des vues de l'avatar.
 void setAttitude(String inNewAttitude)
          Sélecteur sur l'attitude de l'avatar.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VIEWS_KEY

public static final String VIEWS_KEY
Clé pour les vues dans la structure de configuration d'un avatar.

See Also:
Constant Field Values

mName

private final String mName
Référence sur le nom de l'avatar. Ce nom est unique dans le programme (distribué)


mImageCollections

private final Map mImageCollections
Référence sur les vues de l'avatar.


mAttitude

private String mAttitude
Référence sur l'attitude courante de l'avatar.


mViews

private final Collection mViews
Liste des vues sur cet avatar.

Constructor Detail

Avatar

private Avatar(String inName,
               Map inImageCollections)
Constructeur à partir d'un nom, d'une collections d'images et d'un booléen déterminant si l'avatar est activé ou non (peut être choisi ou non).

Parameters:
inName - nom de l'avatar
inImageCollections - collections d'images pour l'avatar.
Method Detail

getName

public String getName()
Accesseur sur le nom.

Returns:
le nom de l'avatar

getImageCollectionIDs

public Set getImageCollectionIDs()
Accesseur sur l'ensemble des vues (collections d'images).

Returns:
l'ensemble des vues

getImageCollection

public AvatarImageCollection getImageCollection(String inCollectionID)
Accesseur sur une collection particulière d'images pour l'avatar.

Parameters:
inCollectionID - identifiant de la collection que l'on souhaite récupérer.
Returns:
la collection correspondante de l'avatar ou null si la collection n'est pas définie.

getAttitude

public String getAttitude()
Accesseur sur l'attitude de l'avatar.

Returns:
l'identifiant de l'attitude courante de l'avatar

setAttitude

public void setAttitude(String inNewAttitude)
Sélecteur sur l'attitude de l'avatar.

Parameters:
inNewAttitude - nouvelle attitude de l'avatar.

addView

public void addView(AvatarView inView)
Ajout d'une vue dans la liste des vues de l'avatar.

Parameters:
inView - vue à ajouter

removeView

public void removeView(AvatarView inView)
Suppression d'une vue dans la liste des vues de l'avatar.

Parameters:
inView - vue à supprimer.

compareTo

public int compareTo(Object inAlter)
Interface Comparable. La comparaison s'effecture sur le nom de l'avatar.

Specified by:
compareTo in interface Comparable
Parameters:
inAlter - objet avec lequel comparer.
Returns:
un nombre négatif si this < inAlter, zéro si this == inAlter, un nombre positif si this > inAlter

equals

public boolean equals(Object inAlter)
Egalité conforme avec l'interface comparable. La comparaison s'effecture sur le nom de l'avatar.

Overrides:
equals in class Object
Parameters:
inAlter - objet avec lequel comparer.
Returns:
true si inAlter est égal à this

hashCode

public int hashCode()
Valeur de hachage conforme à l'égalité.

Overrides:
hashCode in class Object
Returns:
la valeur de hachage dépendant du nom.

loadAvatars

public static Map loadAvatars(Map inAvatarsConfig,
                              SimulacionMediaTracker inTracker)
Charge les avatars à partir du tableau issu de la configuration.

Parameters:
inAvatarsConfig - tableau issu de la configration.
inTracker - traqueur pour charger les images.
Returns:
un tableau avec les avatars, les clés sont les noms et les valeurs les avatars