cpp_opengl_vehicles

---

---

Doc links

Documentation page links:

• [readme]
• [docs 00 : overview]
• [docs 01 : conceptual]
  • [docs 01 : conceptual : old conceptual documentation]
• [docs 02 : requirements]
  • [docs 02 : requirements : deadlock suppliment]
  • [docs 02 : requirements : model design drafts suppliment]
• [docs 03 : designables]
  • [docs 03 : designables : experiments 01 : render texture experimenting]
  • [docs 03 : designables : suppliments 01 : design pattern diagrams]
• [docs 04 : developments]

---

Contents

• [About]
• [Notes]
• [Changes]
  • 12/06/2024
  • 13/06/2024
  • 14/06/2024
  • 15/06/2024
  • 16/06/2024
  • 17/06/2024
  • 21/06/2024
  • 23/06/2024
  • 25/06/2024
  • 26/06/2024
  • 27/06/2024
  • 29/06/2024
  • 30/06/2024
  • 02/07/2024

---

About

[Back to Contents]

• repo is for experimenting with vehicles in opengl and c++
• in part this project is an attempt at exploring and experimenting with what a term like Computer Graphics Engineering would mean

---

Notes

[Back to Contents]

• yoinks the stuff from our template
• check out the documentation overview for different documentation thingies
• please know that the main creater of this documentation forgets the names of the things
  • some of the names of the things in documentation may be incorrectly used
  • as this project is for fun, as revision, and for the practice of the tools, there is less emphasis on documentation being 100% correct it in use, and more emphasis on the practicallity of the documentation in a software design and engineering basis for graphical art.

---

Changes

[Back to Contents]

12/06/2024

• 12/06/2024 - initial creation of repo
• 12/06/2024 - documentation setup

13/06/2024

• 13/06/2024 - some light documentation between the things

14/06/2024

• 14/06/2024 - cleaning the documentation and fixups of lings
• 14/06/2024 - added the existing diagrams from research/exploration phase
• 14/06/2024 - adding some simple actors/concept/object identification
• 14/06/2024 - better linking and created simple context diagram

15/06/2024

• 15/06/2024 - fixing up the naming of some of the conceptual document headings
• 15/06/2024 - adding use cases with some highlighting of concepts
• 15/06/2024 - created the links for draft 2 of concept highlighting
• 15/06/2024 - reorganised conceptual to accomodate the sequence diagrams and context model section
• 15/06/2024 - made up our own version of the context/domain model -> "Concept-Domain model"
• 15/06/2024 - used it to plan out some things for the stucture by creating 2nd draft of the concept modelling
• 15/06/2024 - sky box sequence diagram done
• 15/06/2024 - created sequence diagram stubs for terrain / traffic controller / car
• 15/06/2024 - finished the sequence diagram for terrain (had to correct some mistakes from work on the bus)
• 15/06/2024 - finished traffic system sequence diagram

16/06/2024

• 16/06/2024 - car/car thread init sequence done
• 16/06/2024 - car/car thread update/draw sequence stubs done
• 16/06/2024 - car/car thread draft 1 sequence complete, update and draw are combined
• 16/06/2024 - formatting, contents link updates, and draft 3 concept domain model (could say that conceptual is done)
• 16/06/2024 - lazy draft 01 domain model added to docs 02
• 16/06/2024 - added contents links to docs02
• 16/06/2024 - documentation links and formatting changes

17/06/2024

• 17/06/2024 - use cases being identified as draft
• 17/06/2024 - use cases draft 2 added
• 17/06/2024 - some architectural diagrams
• 17/06/2024 - identified some wackiness with the threads
• 17/06/2024 - context model for cars in lanes

21/06/2024

• 21/06/2024 - contents added to docs_03
• 21/06/2024 - code control flow added to docs_03
• 21/06/2024 - some more diagrams made for hypothetical ways of generating models in discussion forums
• 21/06/2024 - pre design stage requirements
• 21/06/2024 - pre development stage requirements

23/06/2024

• 23/06/2024 - moved experiments to docs_01
• 23/06/2024 - moved all requirements to docs2
• 23/06/2024 - moved design path to docs_02
• 23/06/2024 - moved design pattern suggestions to docs_02
  • maybe we should move this to docs_01, depends if it feels right there
• 23/06/2024 - updated contents for docs_02 and docs_03 to include linking
• 23/06/2024 - completed documentation refactoring to have things where they should be
• 23/06/2024 - pre-design and pre-development requirements checklists added

25/06/2024

• 25/06/2024 - added simple required field lists
• 25/06/2024 - added requirement mappings
• 25/06/2024 - cleaned up documentation linking
• 25/06/2024 - finished mapping requirement importance/types/workload
• 25/06/2024 - cleaned up the docs links more
• 25/06/2024 - added DOCS02:SUPPLIMENT01 for deadlocking details
• 25/06/2024 - added deadlock avoidance suggestions
• 25/06/2024 - added model design draft diagrams
• 25/06/2024 - risk mapping added
• 25/06/2024 - architectural done!! design document here we come :D
• 25/06/2024 - compilation linking diagram added

26/06/2024

• 26/06/2024 - added in the need for experimentation suppliments
• 26/06/2024 - cleaned up the pipeline diagrams

27/06/2024

• 27/06/2024 - added details about the render texture experiments
• 27/06/2024 - changed the suppliment links to only have suppliment links for the current document stage outside of readme/overview

29/06/2024

• 29/06/2024 - started some of the design pattern uml's
• 29/06/2024 - minimalist did the rest of them so we have something at all

30/06/2024

• 30/06/2024 - added badges to the readme page
• 30/06/2024 - added references for the libraries including details about cmake building
• 30/06/2024 - stubs for library api
• 30/06/2024 - mild restructuring of the design documentation

02/07/2024

• 02/07/2024 - moved design patterns to suppliment file
• 02/07/2024 - found that there isnt really a need for flow diagrams for the libraries, so will focus on references
• 02/07/2024 - cleaned up the library references
• 02/07/2024 - completed the design pattern uml diagrams

---