RoomView est une application Android permettant de visualiser des batiments à la manière de Google Street View.
Cette application permet de créer de nouveau batiments, créer leurs pièces avec leurs zones correspondantes, leurs ajouter des photos, des chemins.
L'application permet également de visualiser les batiments créés, de naviguer à l'intérieur des batiments, de voir les photos prises à l'intérieur des pièces.
## Getting started
## Installation
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
1. Cloner le projet
2. Importer le projet dans Android Studio
3. Lancer l'émulateur ou brancher un téléphone Android à l'ordinateur pour y transferer l'application
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Explications du code
Il existe 5 packages principaux dans le projet :
-`com.example.roomview` : Contient les activités principales de l'application
-`Common` : Contient les classes utilisées par plusieurs activités
-`Popups` : Contient les classes des popups utilisées dans l'application
-`Structures` : Contient les classes des structures de données utilisées dans l'application
-`Views` : Contient les classes des vues personnalisées utilisées dans l'application
## Add your files
### Package `com.example.roomview`
Contient les activités principales de l'application:
-`MainActivity` : Activité principale de l'application, permet de créer un nouveau batiment, de supprimer un batiment existant, de voir les batiments existants
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-`BuildingActivity` : Activité permettant de voir les pièces d'un batiment, de créer une nouvelle pièce, de supprimer une pièce existante
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
-`RoomActivity` : Activité permettant de visualiser les zones et chemins d'une pièce, de créer une nouvelle zone, de supprimer une zone existante, de créer un nouveau chemin, de supprimer un chemin existant
-`ZoneActivity` : Activité permettant de visualiser les photos prises dans une zone, créer une nouvelle photo, de supprimer une photo existante
-[ ] [Set up project integrations](https://gitlab.univ-lorraine.fr/loisil2u/projet-android/-/settings/integrations)
-`PhotoActivity` : Activité permettant de prendre une photo, de visualiser une photo existante, et de modifier les chemins présents sur la photo
## Collaborate with your team
-`PathwayActivity` : Activité permettant de modifier un chemin existant, son nom, son type, sa / ses destination(s)
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-`BuildingView` : Activité permettant de selectionner des actions a faire dans un batiment, comme d'aller dans une pièce pour la visiter ou alors de demander un itinéraire pour aller d'une pièce à une autre
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-[ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
-`ZoneView` : Activité permettant de visualiser une zone en regardant les photos qu'elle a en fonction de l'orientation de l'utilisateur, de voir les chemins présents sur la photo actuelle et de naviguer entre les zones / photos du batiment
Use the built-in continuous integration in GitLab.
-`DirectionsActivity` : Activité permettant de visualiser les directions pour aller d'une pièce à une autre, apres avoir demandé un itinéraire dans `BuildingView`
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
### Package `Common`
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
Contient les classes utilisées par plusieurs activités:
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-`BuildingManager` : Classe permettant de gérer la liste des batiments de l'application et de les sauvegarder de manière transparente dans les fichiers de l'application
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
-`Callback` : Interface permettant de définir ce qu'est un callback (une fonction qui est appelée après une action, prend en paramètre un objet quelconque et retourne un objet quelconque)
# Editing this README
-`Coord` : Classe permettant de définir une coordonnée (x, y) avec des méthodes supplémentaires pour calculer la distance entre deux coordonnées et passer d'un repère relatif vers absolu et inversement
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-`Directions` : Classe permettant de calculer les directions pour aller d'une pièce à une autre, en utilisant un algorithme personnel de recherche de chemin le plus court (algorithme recursif)
## Suggestions for a good README
-`DirectionsStep` : Classe permettant de définir une étape d'un itinéraire, avec une description de l'étape et un titre de l'étape, générés automatiquement a partir des informations de l'étape
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
-`ImageManager` : Classe permettant de gérer la récupération d'une image depuis une URL
Choose a self-explaining name for your project.
## Description
-`InfoBinding` : Classe permettant de définir un binding entre une information et une vue, utilisé dans la classe *InfoAdapter* pour lier les informations d'un element à une vue
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
-`Position` : Classe permettant de définir une position (longitude, latitude), utilisée pour définir la position de utilisateur dans la classe *MeteoInfo*
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
### Package `Popups`
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Contient les classes des popups utilisées dans l'application:
-`BuildingPopup` : Popup permettant de créer et modifier un batiment
## Installation
-`PathwayPopup` : Popup permettant de créer un chemin
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-`PhotoPopup` : Popup permettant de créer une photo
-`RoomPopup` : Popup permettant de créer et modifier une pièce
-`ZonePopup` : Popup permettant de créer et modifier une zone
-`PhotoInfoPopup` : Popup permettant d'afficher les informations d'une photo (meteo + date)
-`RemovePopup` : Popup permettant de valider la suppression d'un élément
-`WalkPopup` : Popup permettant de créer et modifier le déplacement vers une autre zone
-`StairsDestPopup` : Popup permettant de sélectionner la destination d'un escalier (utilisée pendant la navigation)
-`GotoPopup` : Popup permettant de sélectionner la destination d'un chemin (utilisée pendant la création d'un chemin)
-`DirectionsPopup` : Popup permettant de sélectionner les informations pour le calcul d'un itinéaire (pièce de départ, pièce d'arrivée)
### Package `Structures`
Contient les classes des structures de données utilisées dans l'application:
-`BuildingInfo` : Représente un batiment, contient une liste de pièces
-`RoomInfo` : Représente une pièce, contient une liste de zones
-`ZoneInfo` : Représente une zone, contient une liste de photos
-`PathInfo` : Représente un chemin, contient une destination (pièce)
-`PathStairs` : Représente un escalier, contient deux destinations (pièce haut, pièce bas)
-`StairsDirection` : Représente une direction d'escalier (haut, bas, ou les deux)
-`PathDoor` : Représente une porte, contient une destination (pièce)
-`PathType` : Représente un type de chemin (escalier ou porte)
-`WalkInfo` : Représente un déplacement, contient une destination (zone)
-`PhotoInfo` : Représente une photo, contient une liste de chemins
## Usage
-`Orientation` : Représente une orientation (Nord, Sud, Est, Ouest)
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
-`MeteoInfo` : Représente les informations météorologiques d'une photo, contient la température, l'humidité, la pression et un état de la météo (pluvieux, nuageux, ...)
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
### Package `Views`
If you have ideas for releases in the future, it is a good idea to list them in the README.
Contient les classes des vues personnalisés utilisées dans l'application:
-`InfoAdapter` : Classe permettant de créer une liste customisée, en utilisant un layout personnalisé, une liste des elements a afficher et la manière dont les elements sont liés a la vue. Gère aussi les evenements de clic sur les elements de la liste, et la recherche dans la liste a partir d'une chaine de caractères
## Contributing
-`ClickDetector` : Classe permettant de détecter les clics sur une vue, en utilisant un callback pour appeler une fonction lorsqu'un clic est détecté
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-`DoorsSelector` : Classe permettant d'afficher les chemins d'une photo, en créer de nouveaux, les modifier et les supprimer
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-`LevelCanvas` : Classe permettant d'afficher l'orientation du smartphone pendant la capture d'une photo (comme un niveau a bulle)
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
## Icone
For open source projects, say how it is licensed.
l'icone de l'application à été créée à partir de deux icones trouvées sur [heroicons](https://heroicons.com/):
- Outline Home
- Outline Map
## Project status
## Autheur
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
