Write ECS interface description

[Per-Morten]

Originally reported by: Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten)

---

Need a proper description of the ECS interface.
What functions will exist
When can they be called
What are pre conditions and post conditions

$estimate 1d
$sub #26

---

• Bitbucket: https://bitbucket.org/Per-Morten/imt3912_thesis/issue/27

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix example syntax discrepancy

Fixed a syntax discrepancy within the entity_manager_example, based on the async changes that has been done to the API.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

fix #27: Fix formatting in operation_types

The interface design should now be done.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix return type in assign_component

Fixed the return type in the assignComponent function. Also renamed the updateAll to step.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

Some of the interfaces will need some changes in lieu of the life cycle and possibly multi-threading changes.

ref #28
ref #29

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add state info to meta_information

Added a member for when a component shall start receiving different events to the meta_information structure.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

fix #27: Finished interface description

Should now be finished writing the interface description.

ref #26

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on meta_information events

Added a small section on how the meta_information will keeptrack of what events a component type is interested in.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on events

Added a section on how our first event will look, as we are thinking of creating another event system as well.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix wrongly named data_access value

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add function to entity_manager

Added a send_component_message to the entity_manager, allowing for sending message only to a component, not all components belonging to an entity.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix entity component discrepancies

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix id capitalization discrepancies

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix figure formatting

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on data_access

Added a section on data access, with the interface for it as well.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Fix format in smart_handle

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on entity_manager

Added a section on the entity_manager, giving a quick introduction to it, also addd an example of how the interface will look.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Elaborate on disclaimer, add todo

Elaborated on the disclaimer, stating how parts are omitted from some interfaces. Also added a todo to remind us to check for EntityID vs EntityId.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add function to entity_manager

Added the apply_to_all function to the entity_manager. Also cleaned up some of the documentation.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Remove required in meta_information

Removed a required member in the meta_information description, the update function is not required, and does not necessarely make sense for all components, for example the type_information component.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add member to meta_information

Added the member interesting_events to the meta_information, it will be used to interact with the already existing event system in the nox engine.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add disclaimer in the design_document

Added a disclaimer in the design_document.tex stating that this document is for internal use, and that the interfaces won't necessarily be the same as in the document.

ref #26

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on entity_manager

Created the section on entity_manager, there is nothing really there yet, as most of the work has been on the interface in the code samples file.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Refine meta_information function

Removed the value from the createMetaInformation function, as it is not technically required.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Elaborate on meta_information

Added a paragraph in meta_information on creation of meta_information and optional operations.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Cleanup smart_handle

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Elaborate on meta_information

Added a paragraph on initialization_operations, and added the initialization_operation to the meta_information struct.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on initialization_operation

Added a section on the initialization operation, also added reference to the listing.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add ref to type_identifier

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add ref to smart_handle

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add ref to i_component listing

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add code_samples_format file

Added a code_samples_format file, here all listings will be placed so they can be referred to in the text.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on meta_information

Added a section on meta_informationm, it is not entirely complete yet though.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add doxygen comments to type_identifier

Added doxygen style comments to the type_identifier for consistency, also added two convencience overloads.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Elaborate on operation_types

Elaborated on the new operation types, also added doxygen comments to the code file for consistency.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add doxygen comments to i_component

Added doxygen style comments to the i_component for consistency.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Rename smart_handle to SmartHandle

Renamed the smart_handle to SmartHandle for consistency

ref #1

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Remove todo comment

Removed todo comment in smart_handle

ref #1

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add design_document.bib

Added a design_document.bib file containing sources

ref #26

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Rename design_document_format

Renamed design_document_format to design_document to make it easier to work with the generate_pdf script.

ref #26 ref #1

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add section on smart_handle

Wrote a section regarding the smart_handle structure.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add type_identifier section

Added a section on the type identifier structure.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add operation_types section

Added a section describing the operation types concept with function pointers.

Also added the operation_types.cpp file which is needed to include the code.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Rename interface to interface_format

Renamed the interface.tex to interface_format.tex so its easier to split the different sections out on their own files. Also added the i_component.tex file, with the i_component description.

ref #1

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add IComponent section

Added a section writing about the IComponent structure. Also added needed code_samples files.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

ref #27: Add interface section to design_document

Added the interface section to the design_document_format. Also imported needed commands from latex_utility.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

Fixed formatting issue.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

Added time estimate.

[Per-Morten]

Original comment by Per-Morten Straume (Bitbucket: Per-Morten, GitHub: Per-Morten):

---

Fixed formatting issue.