From b9eeb1218b60365c4cf20732c705e65a72d7fe23 Mon Sep 17 00:00:00 2001
From: Bamba TOP <bamba.top@etu.u-pec.fr>
Date: Sun, 27 Oct 2024 20:07:06 +0100
Subject: [PATCH] Rajout Javadoc
---
.../controller/CameraControllerListener.java | 48 +++++++++++++++----
1 file changed, 38 insertions(+), 10 deletions(-)
diff --git a/src/main/java/controller/CameraControllerListener.java b/src/main/java/controller/CameraControllerListener.java
index 514b9b0..6b700e2 100644
--- a/src/main/java/controller/CameraControllerListener.java
+++ b/src/main/java/controller/CameraControllerListener.java
@@ -1,10 +1,38 @@
-package controller;
-
-import java.awt.Point;
-
-public interface CameraControllerListener {
- void updateViewOffset(int deltaX, int deltaY);
- void setMouseDragStart(Point point);
- Point getMouseDragStart();
- void resetMouseDragStart();
-}
+package controller;
+
+import java.awt.Point;
+
+/**
+ * L'interface CameraControllerListener définit les méthodes nécessaires pour gérer les interactions
+ * de contrôle de la caméra dans une application. Elle permet de mettre à jour l'offset de la vue,
+ * de gérer le point de départ du glissement de la souris, et de réinitialiser ce point.
+ */
+public interface CameraControllerListener {
+
+ /**
+ * Met à jour le décalage de la vue en fonction des valeurs de déplacement fournies.
+ *
+ * @param deltaX le décalage horizontal pour ajuster l'offset de la vue
+ * @param deltaY le décalage vertical pour ajuster l'offset de la vue
+ */
+ void updateViewOffset(int deltaX, int deltaY);
+
+ /**
+ * Définit le point de départ pour le glissement de la souris.
+ *
+ * @param point le point de départ du glissement de la souris
+ */
+ void setMouseDragStart(Point point);
+
+ /**
+ * Récupère le point de départ du glissement de la souris.
+ *
+ * @return le point de départ du glissement de la souris
+ */
+ Point getMouseDragStart();
+
+ /**
+ * Réinitialise le point de départ du glissement de la souris, marquant la fin du glissement.
+ */
+ void resetMouseDragStart();
+}