This is a wiki page with the full documentation of every piece of code. Any class can be found here.

Some feature were made during our practice exam IceBites.

• Animated buttons - Bas
• Animation Controller - William
• Camera panel - Martijn
• Culling - Bas & William
• Enum extensions - Bas
• Flashingbuttons - Bas
• Geo location - Bas
• Introduction - Bas
• Menu's - William
• Photo taking - Bas (& William with zooming)
• Object Interaction Ray - Martijn
• Photobook - Bas
• Route highlighter - William
• Route Line settings - Martijn
• Save system - Bas
• Scene switcher - Bas
• Timer - Bas
• UI Statemachine - William
• Vector extensions - Bas

Written by Bas

To navigate to the different user interface panels, there are some animated buttons inspired by the buttons of Pokémon Go. First, click on the Amsterdam logo to see some buttons fly out. Then, press one to display a panel, such as the introduction panel.

The script for animated buttons.

The animation controller is a simple script that controls the animations of either the player or the NPC. This works by creating triggers that will decide whether an animation gets played.

Written by William

---
title: Animation Controller
---
graph TD;
    A[Start] --> B{Animator Assigned?};
    B -->|Yes| C[Play Animation];
    B -->|No| D(Error: No Animator Assigned);
    C --> E{Valid Animation?};
    E -->|Yes| F(Set Trigger);
    E -->|No| G(Error: Invalid Animation);

The script requires a component of the type Animator. Otherwise it will not function.

If u wish to take a closer look at the script Animation Controller.

Written by Martijn

The camera panel is a screen put in between the interaction of a point of interest and taking the photo.

Camera Panel

Written by Bas & William

To make the performance better we have of the game we will enable & disable objects if there in the camera view or not. We do this with 2 kinds of culling: Frustum Culling & Occlusion culling

Frustum culling is a technique used in computer graphics to increase rendering performance by eliminating objects that fall outside of the camera's view frustum, which is essentially the pyramid-shaped region in front of the camera. This process ensures that only objects within the camera's field of view are considered for rendering, reducing unnecessary calculations for objects that are not visible to the player.

Occlusion culling in Unity prevents rendering calculations for GameObjects hidden from view, utilizing data generated during baking to determine visibility at runtime, enhancing performance by excluding unnecessary rendering operations.

Every method is private.

The class of Culling.

This is a static class that improve the usage of enum with custom attributes.

Written by Bas

Every method is public.

EnumExtensions.cs

1. CharValue
2. StringValue
3. Vector2Value
4. Vector3Value

Written by Bas

After taking a photo, the main button and photobook button will start flashing to draw attention and guide users to view the photo. This ensures users easily locate the photo for viewing.

The script that flashes the buttons.

The Route Highlighter is a simple system that draws a line between all the points in a list. The lines will indicate the route that you need to walk, and will update accordingly.

graph TD;
    Start --> DrawLines;
    DrawLines --> WalkToWaypoint;
    WalkToWaypoint --> RemovePreviousLine;
    RemovePreviousLine --> |if LastWaypoint | Done
    RemovePreviousLine --> |if not LastWaypoint | RedrawLines 

Route Highlighter

The settings added by this feature were implemented to help the more visually impaired users. They can also be used to add a bit of personal flair while walking the route. When opening the menu, the user is presented by a choice of nine colors and a choice of line width. The choice of color is especially important for colorblind people, who may have trouble differentiating the line itself from its surroundings.

The color is changed by clicking on the colored button and applied to the Line Renderer's color value automatically. It sets both the starting and end color value to make sure the line is one color.

The line width is changed by dragging the slider to the left or right. The minimal width is 0.5 so the user can't make the line invisible, as the line is an integral part of the app. When the value of the slider changes, the user can immediately see the current value of the line width. The line width is immediately changed when the slider moves.

• ColorPicker.cs
• ColorChange.cs
• RouteColors.cs
• RouteLineWidth.cs

We aim to provide precise real-time user location within the game. This is achieved by retrieving latitude and longitude coordinates from Google Maps and converting them into meters. We utilize the formula: $\left(\text{latitude and longitude} \times \frac{\pi}{180}\right) \times \text{Earth's radius} \ (6378137 \ \text{meters})$, the 180 is the amount of degrees of a half circle. We convert the coordinates to meters because the scale of the area would be incorrect when using the raw coordinates due to the curvature of the Earth.

This methodology ensures an accurate navigation experience for users exploring Amsterdam-Oost within the game world.

It will also behave diffrently depending on wich type it has. STATIC will update at the start of the game and never again. PLAYER will update over and over again with the players location. STATIC_DEBUG & PLAYER_DEBUG will update after some time with the given coordinates form the varible.

Written by Bas

See here all the used classes fully:

• CoordinatesTransform.cs
• CoordinatesTransformType.cs
• LocationPermission.cs
• GeoPositionText.cs - Debug script

Writen by Bas

Art by Taquila

The client asked if we could add an introdution to the game, so we made a simple introduction. It's a panel with mulitple pages there you can go through, there is a photo and some text in each. It will also show when playing for the first time. It can be closed, only when having seen the last page.

• IntroductionPopup.cs
• PageHolder.cs
• IScalable.cs

The UI scripts I made serve 2 purposes. The settings script's purpose is loading, saving and creating the settings. The MenuSwitcher's purpose is switching from one menu to another without too much hassle.

If u wish to take a closer look at the scripts:

• Settings Menu
• Menu Switcher

A seamless photo taking system, with a simple to understand zoom functionality. This will be used for the interactable points of intress. These photo's will be used for the photo book.

Full:	Short:	Zoom:

Written by Bas

• PhotoTaker.cs
• PhotoData.cs
• CameraPermission.cs

The Object Interaction Ray is a versatile tool designed to enhance gameplay across various platforms, including PC, mobile, and tablet devices. With its universal functionality, players can seamlessly click and interact with in-game elements, ensuring a smooth and immersive gaming experience regardless of the device they're using. This intuitive feature adds depth and engagement to gameplay, allowing users to effortlessly navigate and engage with the virtual world at their fingertips.

Written by Martijn

• Interaction Ray (Input Parser)
• Interactable Object

To learn about Amsterdam-Oost you have a photobook. In here there are missing photo's. When you have taken a photo you will see it in the book with information about so you can learn form it. You can flip through the pages and see you collection. This will be saved between play session, even if you accidentally close the game.

Written by Bas

Art by Taquila

---
title: Photobook system
---
classDiagram
    class PhotoInteractable{
        - const string NO_TEXTURE_TO_SAVE
        - const string NO_TEXTURE_TO_LOAD
        - const string SAVED_TEXTURE
        - PhotoTaker parent
        - PhotoData data
        - byte[] _textureBytes
        + bool IsVisited() get/set
        + Page ParentPage() get/set
        + SetPhotoData()
        + GetInfo() string
        + SaveTexture(Texture2D) bool
        + GetTexture() Texture2D
        - LoadTexture() Texture2D
    }
    class PhotoTaker{
        - const string NO_CAMERA_ERROR
        - const string NO_PHOTO_INTERACTABLE_ERROR
        - const string CAMERA_NOT_ACTIVE_ERROR
        - const string UNABLE_TO_SAVE_PHOTO_ERROR
        - RawImage liveCamera
        - RawImage lastPhoto
        - Texture2D defaultTex
        - WebCamTexture _webcamTexture
        - Texture2D _currentPhoto
        - PhotoInteractable _currentInteractable
        + PhotoData Data() get/set
        + Texture2D DefaultTex() get
        + PhotoInteractable CurrentPhotoInteractable() get
        - UnityEvent onOpenCamera
        - UnityEvent onPhotoTaken
        - Awake()
        - OnDisable()
        + StartCamera()
        + TakePhoto()
        + SetCurrentPhotoInteractable(PhotoInteractable)
        + FindCamera()
        - CaptureFrame(WebCamTexture) Texture2D
    }
    class CameraPermission{
        - const string CAMERA_PERMISSION
        # OnEnable()
    }
    class PhotoBook{
        - Page[] pages
        - GameObject nextButton
        - GameObject previousButton
        - PhotoTaker photoTaker
        - int _currentPage
        - Awake()
        - OnEnable()
        + OpenNextPage()
        + CloseCurrentPage()
        + SetCurrentPageProperties()
        - SetupPhotoBook()
        - CheckButtonsUsability()
        - ViewPages()
    }
    class Page{
        - readonly Vector3 _closed
        - RawImage photo
        - TMP_Text title
        - TMP_Text info
        - PhotoInteractable interactable
        - PhotoData data
        - float animationDuration
        - AnimationCurve animationCurve
        - RectTransform _rect
        + PhotoInteractable GetPhotoInteractable() get
        - Awake()
        + SetProperties()
        + ForceClose()
        + ForceOpen()
        + AnimatePage(bool)
        - AnimateScale(Vector3) IEnumerator
    }

    CameraPermission <|-- PhotoTaker : inheritance
    PhotoBook --> Page : 1, *
    PhotoInteractable --> Page : 1, 1
    PhotoTaker --> PhotoInteractable : 1, *

Also take a look at photo taking, here you can see how photos are made.

• PhotoBook.cs - The photobook with all pages
• Page.cs - The pages that has a photo and information
• PhotoInteractable.cs - The clickable object to make photo's of
• PhotoData.cs - Data for the photos

This is a simple save system to track your progress along the route. It allows you to close the game and resume later, even if you need to use your phone for something else.

It also saves the setting from the route line.

The Saver script.

This is a simple class to make the switch and loading of scene simple.

Written by Bas

You want to see how it works SceneSwitcher.cs.

A easy to use timer class. With multiple events that can be used. There is an editor script that enhances the usage of the timer class.

Written by Bas

You want to see how it works Timer.cs, there is also a custom editor script for it.

This is a statemachine created for the User Interface which allows for easy and efficient switching between the UI elements without causing errors.

Written by William

If you want to see how it works

• UIStateCaller.cs
• UIStateManager.cs
• UIState.cs
• StateChange.cs

Provides versatile extensions for Vector2 and Vector3, enhancing functionality for various operations.

A important note, the following examples and explanations are for both Vector2 and Vector3 except the Z axis.

Written by Bas

Every method is public.

When a '*' is added, it means it's only for Vector3.

When a '?' is added, it means that it's optional.

You want to see how it works VectorExtensions.cs.