RandomSpawnPlacer.ixx File

Placer that spawns entities at random positions within bounds. More...

Included Headers

#include <helios.engine.ecs.EntityHandle> #include <helios.math> #include <helios.util.Random> #include <helios.engine.runtime.spawn.behavior.SpawnPlacer> #include <helios.engine.runtime.spawn.types.SpawnContext> #include <helios.engine.runtime.spawn.types.SpawnPlanCursor>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	runtime
	Runtime infrastructure for game execution and lifecycle orchestration. More...
namespace	spawn
	Entity spawning infrastructure for the helios engine. More...
namespace	behavior
	Spawn behavior strategies for positioning and initializing entities. More...
namespace	placements
	Concrete SpawnPlacer implementations. More...

Classes Index

class	RandomSpawnPlacer
	Placer that spawns entities at random positions within bounds. More...

Description

Placer that spawns entities at random positions within bounds.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file RandomSpawnPlacer.ixx

3 * @brief Placer that spawns entities at random positions within bounds.

4 */

5module;

6

7export module helios.engine.runtime.spawn.behavior.placements.RandomSpawnPlacer;

8

9import helios.engine.runtime.spawn.types.SpawnPlanCursor;

10import helios.engine.runtime.spawn.types.SpawnContext;

11import helios.engine.runtime.spawn.behavior.SpawnPlacer;

12import helios.util.Random;

13import helios.math;

14import helios.engine.ecs.EntityHandle;

15

16using namespace helios::engine::runtime::spawn::types;

17export namespace helios::engine::runtime::spawn::behavior::placements {

18

19 /**

20 * @brief Placer that spawns entities at random positions within bounds.

21 *

22 * @details RandomSpawnPlacer generates random X and Y coordinates within

23 * the provided level bounds. The Z coordinate is set to 0, making this

24 * suitable for 2D games.

25 *

26 * @note Uses a static Random generator with a fixed seed for reproducibility.

27 *

28 * @see SpawnPlacer

29 */

30 class RandomSpawnPlacer final : public SpawnPlacer {

31

32 helios::util::Random rGen_{12345};

33

34 public:

35

36 /**

37 * @brief Returns a random position within the level bounds.

38 *

39 * @param entityHandle The handle of the entity being spawned (unused).

40 * @param gameObjectBounds The bounding box of the entity to spawn (unused).

41 * @param environmentBounds The level bounds to spawn within.

42 * @param cursor The current position within the spawn batch (unused).

43 * @param spawnContext Context data (unused).

44 *

45 * @return A random vec3f with Z = 0

46 */

47 helios::math::vec3f getPosition(

48 const helios::engine::ecs::EntityHandle& entityHandle,

49 const helios::math::aabbf& gameObjectBounds,

50 const helios::math::aabbf& environmentBounds,

51 const SpawnPlanCursor& cursor,

52 const SpawnContext& spawnContext

53 ) override {

54

55

56 float xPos = rGen_.randomFloat(environmentBounds.min()[0], environmentBounds.max()[0]);

57 float yPos = rGen_.randomFloat(environmentBounds.min()[1], environmentBounds.max()[1]);

58

59 return helios::math::vec3f{xPos, yPos, 0.0f};

60 }

61

62 /**

63 * @brief Resets the random number generator to its initial seed.

64 */

65 void onReset() noexcept override {

66 rGen_.reset();

67 }

68

69

70 };

71

72}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.