Add dirty flag and integrate #1725

dmwever · 2024-12-04T03:49:41Z

fixes #1679. First time working with c++. Been struggling to update a test and getting it to build. Any advice will be helpful. I am using Visual Studio Code.

Please offer much critique. Complain with vigor. Correct with fervor.

dmwever · 2024-12-04T18:09:21Z

A few questions I have for this:
First, how to I integrate the clock with the Map/Terrain/Pathfinding subsystem? I don't just want to start passing the clock through everything, but it seems like, with this task, as well as the Cost Stamp and Record History issues, time will be needed in the pathfinding system. How will this be integrated?

Also, would it be good practice to include non-time based overrides for CostField set_cost which simply set the time to TIME_ZERO for initialization? I have done this for the CostField function that is used by the Map class, but only to avoid needing to pass in a time_t from the map.

Lastly, how do I run with debugging using Visual Studio Code? I make changes to a file and run, but it ignores my breakpoints.

libopenage/pathfinding/cost_field.cpp

libopenage/pathfinding/cost_field.h

libopenage/pathfinding/path.h

libopenage/pathfinding/integrator.h

libopenage/pathfinding/sector.h

heinezen · 2024-12-05T23:14:53Z

First, how to I integrate the clock with the Map/Terrain/Pathfinding subsystem? I don't just want to start passing the clock through everything, but it seems like, with this task, as well as the Cost Stamp and Record History issues, time will be needed in the pathfinding system. How will this be integrated?

Where would you need to pass the clock? You very likely only need to pass the time value but the clock is not necessary IMO.

Also, would it be good practice to include non-time based overrides for CostField set_cost which simply set the time to TIME_ZERO for initialization? I have done this for the CostField function that is used by the Map class, but only to avoid needing to pass in a time_t from the map.

That would kind of counteract introducing dirty flags, so I'm not sure if this is a good idea. In fact, I'm not really sure why we should just always pass a time. Initialization does not always happen at time zero.

Lastly, how do I run with debugging using Visual Studio Code? I make changes to a file and run, but it ignores my breakpoints.

It should just work out of the box. What is your start configuration and output?

Co-authored-by: Christoph Heine <[email protected]>

dmwever · 2024-12-06T04:52:36Z

First, how to I integrate the clock with the Map/Terrain/Pathfinding subsystem? I don't just want to start passing the clock through everything, but it seems like, with this task, as well as the Cost Stamp and Record History issues, time will be needed in the pathfinding system. How will this be integrated?

Where would you need to pass the clock? You very likely only need to pass the time value but the clock is not necessary IMO.

Perhaps that's a better question. How to get the time (or any time) into the Map subsystem.

Co-authored-by: Christoph Heine <[email protected]>

heinezen · 2024-12-07T00:57:02Z

Perhaps that's a better question. How to get the time (or any time) into the Map subsystem.

The update time comes from events in the event system that will trigger a map update. However, I wouldn't worry about that right now, since it is not implemented yet.

dmwever · 2024-12-07T17:25:16Z

It should just work out of the box. What is your start configuration and output?

If you are talking about the configurations in launch.json, it says:
"configurations": []

That's probably my problem lol. What should it say?

heinezen · 2024-12-07T17:29:03Z

Something like this should work as a configuration:

{
    "name": "Main",
    "type": "cppdbg",
    "request": "launch",
    "cwd": "${workspaceFolder}/bin",
    "program": "${workspaceFolder}/bin/run",
    "args": [
        "main",
        "--verbose",
        "--gl-debug",
    ],
    "setupCommands": [
        {
            "description": "Enable pretty-printing for gdb",
            "text": "-enable-pretty-printing",
            "ignoreFailures": true
        },
        {
            "text": "source ${workspaceFolder}/etc/openage.gdbinit"
        }
    ],
}

dmwever · 2024-12-07T17:37:11Z

Something like this should work as a configuration:

{
    "name": "Main",
    "type": "cppdbg",
    "request": "launch",
    "cwd": "${workspaceFolder}/bin",
    "program": "${workspaceFolder}/bin/run",
    "args": [
        "main",
        "--verbose",
        "--gl-debug",
    ],
    "setupCommands": [
        {
            "description": "Enable pretty-printing for gdb",
            "text": "-enable-pretty-printing",
            "ignoreFailures": true
        },
        {
            "text": "source ${workspaceFolder}/etc/openage.gdbinit"
        }
    ],
}

So to clarify, I should put this in launch.json? I am used to Visual Studio with C#.

heinezen · 2024-12-07T18:05:20Z

You should put it in the configurations array, yes.

dmwever · 2024-12-07T18:08:33Z

You should put it in the configurations array, yes.

[workspace]/bin/run does not exist

heinezen · 2024-12-07T18:10:53Z

Well, you need to build the project before running :D

heinezen · 2024-12-07T19:57:28Z

https://github.com/SFTtech/openage/blob/master/doc/building.md has info on the build procedure.

libopenage/pathfinding/cost_field.h

libopenage/pathfinding/integrator.cpp

dmwever · 2024-12-21T16:53:35Z

https://github.com/SFTtech/openage/blob/master/doc/building.md has info on the build procedure.

I can't seem to get this process working on windows. I can run using python openage, following the info on this page:
https://github.com/SFTtech/openage/blob/master/doc/build_instructions/windows_msvc.md

But I don't see a bin folder built in openage following the Windows instructions.

jere8184 · 2024-12-21T16:55:30Z

https://github.com/SFTtech/openage/blob/master/doc/building.md has info on the build procedure.

I can't seem to get this process working on windows. I can run using python openage, following the info on this page: https://github.com/SFTtech/openage/blob/master/doc/build_instructions/windows_msvc.md

But I don't see a bin folder built in openage following the Windows instructions.

I can walk you through it at matrix if you want

libopenage/pathfinding/cost_field.h

Co-authored-by: Christoph Heine <[email protected]>

heinezen · 2025-01-02T01:26:28Z

libopenage/pathfinding/cost_field.h


 	/**
 	 * Set the cost at a specified position.
 	 *
 	 * @param x X-coordinate of the cell.
 	 * @param y Y-coordinate of the cell.
 	 * @param cost Cost to set.
+	 * @param changed Time at which the cost value is changed.


Suggested change

* @param changed Time at which the cost value is changed.

* @param valid_until Time at which the cost value is changed.

heinezen · 2025-01-02T01:27:44Z

libopenage/pathfinding/cost_field.h


 	/**
 	 * Set the cost at a specified position.
 	 *
 	 * @param idx Index of the cell.
 	 * @param cost Cost to set.
+	 * @param changed Time at which the cost value is changed.


Suggested change

* @param changed Time at which the cost value is changed.

* @param valid_until Time at which the cost value is changed.

heinezen · 2025-01-02T01:28:35Z

libopenage/pathfinding/cost_field.h

+
+	inline void set_cost(size_t idx, cost_t cost, const time::time_t &valid_until) {


You need to remove the newline, otherwise the docstring will not be associated with the method.

Suggested change

inline void set_cost(size_t idx, cost_t cost, const time::time_t &valid_until) {

inline void set_cost(size_t idx, cost_t cost, const time::time_t &valid_until) {

heinezen · 2025-01-02T01:29:01Z

libopenage/pathfinding/cost_field.h

+	 * @param changed Time at which the cost value is changed.
+	 */
+	void set_costs(std::vector<cost_t> &&cells, const time::time_t &changed);


Suggested change

* @param changed Time at which the cost value is changed.

*/

void set_costs(std::vector<cost_t> &&cells, const time::time_t &changed);

* @param valid_until Time at which the cost value is changed.

*/

void set_costs(std::vector<cost_t> &&cells, const time::time_t &valid_until);

heinezen · 2025-01-02T01:31:53Z

libopenage/pathfinding/cost_field.h

+	/**
+	 * Check if the cost field is dirty at the specified time.
+	 *
+	 * @param time Cost field is dirty if the cost field is accessed after the time given in valid_until.


You should always explain what time represents/is used for. From your docstring, it's not apparent what a user of this method should pass for time.

Suggested change

* @param time Cost field is dirty if the cost field is accessed after the time given in valid_until.

* @param time Time of access to the cost field.

heinezen · 2025-01-02T01:32:22Z

libopenage/pathfinding/cost_field.h

 	 */
-	void set_costs(std::vector<cost_t> &&cells);
+	bool is_dirty(const time::time_t &time);


Please also document what the return value does.

heinezen · 2025-01-02T01:34:01Z

libopenage/pathfinding/cost_field.h

+	bool is_dirty(const time::time_t &time);
+
+	/**
+	 * Cleans the dirty flag by setting it to time_MAX.


The internal mechanism of tracking the dirty status is not really relevant for the user of this method. Therefore, you can remove it from the docstring.

Suggested change

* Cleans the dirty flag by setting it to time_MAX.

* Clear the dirty flag.

heinezen · 2025-01-02T01:35:38Z

libopenage/pathfinding/demo/demo_1.cpp

+	time::Clock clock = time::Clock();
+	clock.start();
+	const time::time_t time = clock.get_time();


You don't need a clock in this demo because you can just pass 0 as the time in all calls.

heinezen · 2025-01-02T01:40:08Z

libopenage/pathfinding/integrator.h

@@ -56,6 +56,7 @@ class Integrator {
 	 * @param other_sector_id Sector ID of the other side of the portal.
 	 * @param portal Portal.
 	 * @param target Coordinates of the target cell, relative to the integration field origin.
+	 * @param time The time to check is the cached cost field is dirty.


This description is not really useful. How should the user of this method know what time value they have to pass? Caching and dirty checks are also not controlled by the user and therefore don't have to be mentioned.

Suggested change

* @param time The time to check is the cached cost field is dirty.

* @param time Time of the path request.

heinezen · 2025-01-02T01:40:31Z

libopenage/pathfinding/integrator.h

@@ -114,6 +116,7 @@ class Integrator {
 	 * @param other_sector_id Sector ID of the other side of the portal.
 	 * @param portal Portal.
 	 * @param target Coordinates of the target cell, relative to the integration field origin.
+	 * @param time The time to check is the cached cost field is dirty.


same here

Suggested change

* @param time The time to check is the cached cost field is dirty.

* @param time Time of the path request.

Add dirty flag and integrate

9ea8b58

heinezen requested changes Dec 5, 2024

View reviewed changes

dmwever and others added 3 commits December 5, 2024 19:50

Update libopenage/pathfinding/cost_field.cpp

a12b347

Co-authored-by: Christoph Heine <[email protected]>

Add const to time_t and improve docstrings

73647d4

change sector is_dirty to a reference

5a17e4e

dmwever and others added 4 commits December 5, 2024 22:56

Change fieldCache to unique_ptr and add docs

22e594f

Grammar

ce77c9f

Co-authored-by: Christoph Heine <[email protected]>

Grammar

d33d4f7

Co-authored-by: Christoph Heine <[email protected]>

Use contains()

3adb802

Co-authored-by: Christoph Heine <[email protected]>

dmwever added 2 commits December 7, 2024 12:00

Merge branch 'master' into Add-Cost-Field-Dirty-Flag

6251a72

several changes

fd72608

heinezen requested changes Dec 12, 2024

View reviewed changes

libopenage/pathfinding/cost_field.h Outdated Show resolved Hide resolved

libopenage/pathfinding/cost_field.h Outdated Show resolved Hide resolved

libopenage/pathfinding/integrator.cpp Outdated Show resolved Hide resolved

libopenage/pathfinding/integrator.cpp Outdated Show resolved Hide resolved

heinezen added improvement Enhancement of an existing component lang: c++ Done in C++ code area: simulation Involved in the game mechanics and simulation labels Dec 15, 2024

next round of changes

b9f6bd1

heinezen reviewed Dec 24, 2024

View reviewed changes

libopenage/pathfinding/cost_field.h Outdated Show resolved Hide resolved

libopenage/pathfinding/cost_field.h Outdated Show resolved Hide resolved

libopenage/pathfinding/cost_field.h Outdated Show resolved Hide resolved

libopenage/pathfinding/cost_field.h Outdated Show resolved Hide resolved

dmwever and others added 2 commits December 24, 2024 20:48

Update libopenage/pathfinding/cost_field.h

6f2c407

Co-authored-by: Christoph Heine <[email protected]>

- more fixes

e7fb51e

heinezen requested changes Jan 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add dirty flag and integrate #1725

Add dirty flag and integrate #1725

dmwever commented Dec 4, 2024 •

edited

Loading

dmwever commented Dec 4, 2024

heinezen commented Dec 5, 2024

dmwever commented Dec 6, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 7, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 7, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 7, 2024 •

edited

Loading

heinezen commented Dec 7, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 21, 2024

jere8184 commented Dec 21, 2024 •

edited

Loading

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

heinezen Jan 2, 2025

	* @param changed Time at which the cost value is changed.
	* @param valid_until Time at which the cost value is changed.


		inline void set_cost(size_t idx, cost_t cost, const time::time_t &valid_until) {

	* @param time Cost field is dirty if the cost field is accessed after the time given in valid_until.
	* @param time Time of access to the cost field.

	* Cleans the dirty flag by setting it to time_MAX.
	* Clear the dirty flag.

	* @param time The time to check is the cached cost field is dirty.
	* @param time Time of the path request.

Add dirty flag and integrate #1725

Are you sure you want to change the base?

Add dirty flag and integrate #1725

Conversation

dmwever commented Dec 4, 2024 • edited Loading

dmwever commented Dec 4, 2024

heinezen commented Dec 5, 2024

dmwever commented Dec 6, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 7, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 7, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 7, 2024 • edited Loading

heinezen commented Dec 7, 2024

heinezen commented Dec 7, 2024

dmwever commented Dec 21, 2024

jere8184 commented Dec 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmwever commented Dec 4, 2024 •

edited

Loading

dmwever commented Dec 7, 2024 •

edited

Loading

jere8184 commented Dec 21, 2024 •

edited

Loading