SteeringConfig.ixx File

Configuration for steering/rotation components. More...

Included Headers

#include <helios.engine.modules.physics> #include <helios.engine.modules.spatial> #include <helios.engine.ecs.GameObject>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	builder
	Fluent builder pattern for constructing GameObjects. More...
namespace	gameObject
	Factory and prototype classes for GameObject construction. More...
namespace	builders
	Domain-specific builders for configuring different aspects of GameObjects. More...
namespace	configs
	Fine-grained configuration classes for component setup. More...

Classes Index

class	SteeringConfig
	Fluent configuration for steering and rotation behavior. More...

Description

Configuration for steering/rotation components.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file SteeringConfig.ixx

3 * @brief Configuration for steering/rotation components.

4 */

5module;

6

7export module helios.engine.builder.gameObject.builders.configs.SteeringConfig;

8

9import helios.engine.ecs.GameObject;

10import helios.engine.modules.physics;

11import helios.engine.modules.spatial;

12

13export namespace helios::engine::builder::gameObject::builders::configs {

14

15 /**

16 * @brief Fluent configuration for steering and rotation behavior.

17 *

18 * Automatically adds required components:

19 * - SteeringComponent

20 * - ComposeTransformComponent

21 * - RotationStateComponent

22 * - DirectionComponent

23 */

24 class SteeringConfig {

25

26 /**

27 * @brief Non-owning pointer to the target GameObject.

28 */

29 helios::engine::ecs::GameObject gameObject_;

30

31 public:

32

33 /**

34 * @brief Constructs a SteeringConfig and adds required components.

35 *

36 * @param gameObject Target GameObject to configure.

37 */

38 explicit SteeringConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {

39 gameObject_.add<helios::engine::modules::physics::motion::components::SteeringComponent>();

40

41 gameObject_.getOrAdd<helios::engine::modules::spatial::transform::components::ComposeTransformComponent>();

42 gameObject_.getOrAdd<helios::engine::modules::spatial::transform::components::RotationStateComponent>();

43 gameObject_.getOrAdd<helios::engine::modules::physics::motion::components::DirectionComponent>();

44 }

45

46 /**

47 * @brief Enables or disables instant rotation.

48 *

49 * When enabled, the entity rotates immediately to face target.

50 *

51 * @param useInstantRotation True for instant rotation.

52 *

53 * @return Reference to this config for chaining.

54 */

55 SteeringConfig& instantSteering(const bool useInstantRotation) {

56 gameObject_.get<helios::engine::modules::physics::motion::components::SteeringComponent>()

57 ->setUseInstantRotation(useInstantRotation);

58

59 return *this;

60 }

61

62 /**

63 * @brief Sets whether steering input updates movement direction.

64 *

65 * @param directionFromSteering True to link direction to steering.

66 *

67 * @return Reference to this config for chaining.

68 */

69 SteeringConfig& steeringSetsDirection(const bool directionFromSteering) {

70 gameObject_.get<helios::engine::modules::physics::motion::components::SteeringComponent>()

71 ->setDirectionFromSteering(directionFromSteering);

72

73 return *this;

74 }

75

76 };

77

78}

79

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.