TrackTrendsDoc/temp_annexes/Code/Zone.md

Zone.cs

/// Author : Maxime Rohmer
/// Date : 30/05/2023
/// File : Zone.cs
/// Brief : Class that contains all the methods and infos for a zone. This is designed to be potentially be inherited.
/// Version : Alpha 1.0

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace TrackTrends
{
    public class Zone
    {
        private Rectangle _bounds;
        private List<Zone> _zones;
        private List<Window> _windows;
        private Bitmap _image;
        private string _name;

        public Bitmap ZoneImage
        {
            get
            {
                //This little trickery lets you have the image that the zone sees
                Bitmap sample = new Bitmap(Bounds.Width, Bounds.Height);
                Graphics g = Graphics.FromImage(sample);
                g.DrawImage(Image, new Rectangle(0, 0, sample.Width, sample.Height), Bounds, GraphicsUnit.Pixel);
                return sample;
            }
        }
        public Bitmap Image
        {
            get { return _image; }
            set
            {
                //It automatically sets the image for the contained windows and zones
                _image = value;
                foreach (Window w in Windows)
                {
                    w.Image = ZoneImage;
                }
                foreach (Zone z in Zones)
                {
                    z.Image = Image;
                }
            }
        }
        public Rectangle Bounds { get => _bounds; protected set => _bounds = value; }
        public List<Zone> Zones { get => _zones; protected set => _zones = value; }
        public List<Window> Windows { get => _windows; protected set => _windows = value; }
        public string Name { get => _name; protected set => _name = value; }
        /// <summary>
        /// Creates a new Zone
        /// </summary>
        /// <param name="image">Image of the parent zone</param>
        /// <param name="bounds">The position and size of the zone</param>
        /// <param name="name">THe name of the zone (usefull for the JSON formatting)</param>
        public Zone(Bitmap image, Rectangle bounds, string name)
        {
            Windows = new List<Window>();
            Zones = new List<Zone>();
            Name = name;

            //You cant set the image in the CTOR because the processing is impossible at first initiation
            _image = image;
            Bounds = bounds;
        }
        /// <summary>
        /// Adds a zone to the list of zones
        /// </summary>
        /// <param name="zone">The zone you want to add</param>
        public virtual void AddZone(Zone zone)
        {
            Zones.Add(zone);
        }
        /// <summary>
        /// Add a window to the list of windows
        /// </summary>
        /// <param name="window">the window you want to add</param>
        public virtual void AddWindow(Window window)
        {
            Windows.Add(window);
        }
        /// <summary>
        /// Calls all the windows to do OCR and to give back the results so we can send them to the model
        /// </summary>
        /// <param name="driverList">A list of all the driver in the race to help with text recognition</param>
        /// <returns>A driver data object that contains all the infos about a driver</returns>
        public virtual DriverData Decode(List<string> driverList)
        {
            int sectorCount = 0;
            DriverData result = new DriverData();
            foreach(Window w in Windows)
            {
                // A switch would be prettier but I dont think its supported in this C# version
                if (w is DriverNameWindow)
                    result.Name = (string)(w as DriverNameWindow).DecodePng(driverList);
                if (w is DriverDrsWindow)
                    result.DRS = (bool)(w as DriverDrsWindow).DecodePng();
                if (w is DriverGapToLeaderWindow)
                    result.GapToLeader = (int)(w as DriverGapToLeaderWindow).DecodePng();
                if (w is DriverLapTimeWindow)
                    result.LapTime = (int)(w as DriverLapTimeWindow).DecodePng();
                if (w is DriverPositionWindow)
                    result.Position = (int)(w as DriverPositionWindow).DecodePng();
                if (w is DriverSectorWindow)
                {
                    sectorCount++;
                    if (sectorCount == 1)
                        result.Sector1 = (int)(w as DriverSectorWindow).DecodePng();
                    if (sectorCount == 2)
                        result.Sector2 = (int)(w as DriverSectorWindow).DecodePng();
                    if (sectorCount == 3)
                        result.Sector3 = (int)(w as DriverSectorWindow).DecodePng();
                }
                if (w is DriverTyresWindow)
                    result.CurrentTyre = (Tyre)(w as DriverTyresWindow).DecodePng();
            }
            return result;
        }
        public virtual Bitmap Draw()
        {
            Bitmap img;

            //If its the main zone we want to see everything
            if (Zones.Count > 0)
            {
                img = Image;
            }
            else
            {
                img = ZoneImage;
            }

            Graphics g = Graphics.FromImage(img);

            //If its the main zone we need to visualize the Zone bounds displayed
            if (Zones.Count > 0)
                g.DrawRectangle(new Pen(new SolidBrush(Color.FromArgb(249,194,46)), 5), Bounds);

            foreach (Zone z in Zones)
            {
                Rectangle newBounds = new Rectangle(z.Bounds.X, z.Bounds.Y + Bounds.Y, z.Bounds.Width, z.Bounds.Height);
                g.DrawRectangle(new Pen(new SolidBrush(Color.FromArgb(249, 194, 46)), 5), newBounds);
            }
            foreach (Window w in Windows)
            {
                g.DrawRectangle(new Pen(new SolidBrush(Color.FromArgb(252, 252, 252)), 5), w.Bounds);
            }
            return img;
        }
        public void ResetZones()
        {
            Zones.Clear();
        }
        public void ResetWindows()
        {
            foreach (Zone z in Zones)
            {
                z.ResetWindows();
            }
            Windows.Clear();
        }
        /// <summary>
        /// Checks if the given Rectangle fits in the current zone
        /// </summary>
        /// <param name="InputRectangle">The Rectangle you want to check the fittment</param>
        /// <returns></returns>
        protected bool Fits(Rectangle inputRectangle)
        {
            if (inputRectangle.X + inputRectangle.Width > Bounds.Width || inputRectangle.Y + inputRectangle.Height > Bounds.Height || inputRectangle.X < 0 || inputRectangle.Y < 0)
            {
                return false;
            }
            else
            {
                return true;
            }
        }
    }
}