Improvements (#7)

* Improved benchmarks

* Made entity list unmodifiable, and finalised priority on systems

* Improved assertion on getting an Component from an Entity

* Updated example to showcase Oxygen's power beter

* Update lib/src/entity/entity.dart

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>

Author: wolfenrain

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "console": "terminal",
+            "name": "example",
+            "cwd": "example",
+            "request": "launch",
+            "type": "dart",
+            "args": [
+                "--enable-asserts"
+            ]
+        }
+    ]
+}

CHANGELOG.md

@@ -1,4 +1,7 @@
 ## [next]
+- Made assertion for getting/checking/removing a `Component` stricter
+- **BREAKING**: Made the `priority` field on `System` final
+- **BREAKING**: Components will now be marked for removal. This fixes the concurrent modification error
 
 ## 0.1.0
 - Stable null-safety release

analysis_options.yaml

@@ -16,6 +16,6 @@ linter:
     - non_constant_identifier_names
     - cancel_subscriptions
 
-# analyzer:
-#   exclude:
-#     - path/to/excluded/files/**
+analyzer:
+  exclude:
+    - example/** # Needed for CI/CD.. 

benchmark/object_pool_benchmark.dart

@@ -27,5 +27,12 @@ void main() {
     benchmark('new ObjectPool with 100000 instances', () {
       TestPool(initialSize: 100000);
     });
+
+    benchmark('new ObjectPool with 0 instances that grows to 100000', () {
+      final pool = TestPool(initialSize: 0);
+      for (var i = 0; i < 100000; i++) {
+        pool.acquire();
+      }
+    });
   });
 }

benchmark/query_benchmark.dart

@@ -0,0 +1,56 @@
+import 'package:oxygen/oxygen.dart';
+import 'package:benchmark/benchmark.dart';
+
+class Test100Component extends Component<void> {
+  @override
+  void init([void data]) {}
+
+  @override
+  void reset() {}
+}
+
+class Test50Component extends Component<void> {
+  @override
+  void init([void data]) {}
+
+  @override
+  void reset() {}
+}
+
+void main() {
+  group('Query', () {
+    group('With 100000 entities', () {
+      World? world;
+
+      QueryManager? queryManager;
+
+      setUp(() {
+        world = World();
+        world!.registerComponent(() => Test100Component());
+        world!.registerComponent(() => Test50Component());
+        for (var i = 0; i < 100000; i++) {
+          final entity = world!.createEntity();
+
+          entity.add<Test100Component, void>();
+          if (i % 2 == 0) {
+            entity.add<Test50Component, void>();
+          }
+        }
+        queryManager = QueryManager(world!.entityManager);
+      });
+
+      tearDown(() {
+        world = null;
+        queryManager = null;
+      });
+
+      benchmark('creating a Query that matches 100% of all the entities', () {
+        queryManager?.createQuery([Has<Test100Component>()]);
+      });
+
+      benchmark('creating a Query that matches 50% of all the entities', () {
+        queryManager?.createQuery([Has<Test50Component>()]);
+      });
+    });
+  });
+}

doc/entity.md

@@ -9,6 +9,13 @@ You can create an entity by using the [World](./world.md):
 final entity = world.createEntity('Optional name');
 ```
 
+## Removing an Entity
+```dart
+entity.dispose();
+```
+
+This will mark the Entity for removal but won't be immediately disposed until the end of the last update cycle. This allows systems to react to the Entity.
+
 ## Adding Components
 
 After you have created an entity you can easily add new components:
@@ -38,7 +45,7 @@ if (entity.has<YourComponent>()) {
 
 ## Removing Components
 ```dart
-entity.removeComponent<YourComponent>();
+entity.remove<YourComponent>();
 ```
 
 This will mark the Component for removal but won't be immediately disposed until the end of the last update cycle. This allows systems to react to the data inside the Component.

example/CHANGELOG.md

@@ -1 +1,7 @@
 # A simple Oxygen example
+
+## Run
+
+```
+dart --enable-asserts lib/main.dart
+```

example/README.md

@@ -0,0 +1,4 @@
+import 'package:example/utils/color.dart';
+import 'package:oxygen/oxygen.dart';
+
+class ColorComponent extends ValueComponent<Color> {}

example/lib/components/color_component.dart

@@ -0,0 +1,10 @@
+import 'package:oxygen/oxygen.dart';
+
+enum Direction {
+  up,
+  down,
+  left,
+  right,
+}
+
+class DirectionComponent extends ValueComponent<Direction> {}