GfxEffectsConfig.ixx File

Configuration for visual effects components. More...

Included Headers

#include <helios.math> #include <helios.engine.modules.spatial.transform.components.RotationStateComponent> #include <helios.engine.modules.effects.gfx.components.SpinComponent> #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	GfxEffectsConfig
	Fluent configuration for visual effects. More...

Description

Configuration for visual effects components.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file GfxEffectsConfig.ixx

3 * @brief Configuration for visual effects components.

4 */

5module;

6

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

8

9import helios.engine.ecs.GameObject;

10

11import helios.engine.modules.effects.gfx.components.SpinComponent;

12import helios.engine.modules.spatial.transform.components.RotationStateComponent;

13

14import helios.math;

15

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

17

18 /**

19 * @brief Fluent configuration for visual effects.

20 *

21 * Provides methods for adding continuous rotation (spin)

22 * and other visual effects to a GameObject.

23 */

24 class GfxEffectsConfig {

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 GfxEffectsConfig.

35 *

36 * @param gameObject Target GameObject to configure.

37 */

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

39

40 /**

41 * @brief Adds continuous rotation (spin) effect.

42 *

43 * @param degreesPerSecond Rotation speed in degrees per second.

44 * @param spinAxis The axis of rotation (normalized).

45 *

46 * @return Reference to this config for chaining.

47 */

48 GfxEffectsConfig& spin(const float degreesPerSecond, const helios::math::vec3f spinAxis) {

49 gameObject_.add<helios::engine::modules::effects::gfx::components::SpinComponent>(

50 degreesPerSecond, spinAxis

51 );

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

53 return *this;

54 }

55

56

57 };

58

59}

60

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.