Skip to main content

TransformConfig.ixx File

Configuration for spatial transform components. More...

Included Headers​

#include <helios.engine.core.units> #include <helios.math> #include <helios.engine.modules.spatial.transform.components> #include <helios.engine.ecs.GameObject>

Namespaces Index​

namespacehelios
namespaceengine

Main engine module aggregating core infrastructure and game systems. More...

namespacebuilder

Fluent builder pattern for constructing GameObjects. More...

namespacegameObject

Factory and prototype classes for GameObject construction. More...

namespacebuilders

Domain-specific builders for configuring different aspects of GameObjects. More...

namespaceconfigs

Fine-grained configuration classes for component setup. More...

Classes Index​

classTransformConfig

Fluent configuration for spatial transform setup. More...

Description​

Configuration for spatial transform components.

File Listing​

The file content with the documentation metadata removed is:

1/**
2 * @file TransformConfig.ixx
3 * @brief Configuration for spatial transform components.
4 */
5module;
6
7export module helios.engine.builder.gameObject.builders.configs.TransformConfig;
8
9import helios.engine.ecs.GameObject;
10
11import helios.engine.modules.spatial.transform.components;
12
13import helios.math;
14import helios.engine.core.units;
15
16export namespace helios::engine::builder::gameObject::builders::configs {
17
18 /**
19 * @brief Fluent configuration for spatial transform setup.
20 *
21 * Automatically adds ComposeTransformComponent and provides
22 * methods for setting scale and translation.
23 */
24 class TransformConfig {
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 TransformConfig and adds ComposeTransformComponent.
35 *
36 * @param gameObject Target GameObject to configure.
37 */
38 explicit TransformConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {
39 gameObject_.add<helios::engine::modules::spatial::transform::components::ComposeTransformComponent>();
40
41 }
42
43 /**
44 * @brief Sets the scale of the entity.
45 *
46 * @param scale Scale factors for x, y, z axes.
47 * @param unit The unit of measurement (default: Meter).
48 *
49 * @return Reference to this config for chaining.
50 */
51 TransformConfig& scale(
52 const helios::math::vec3f scale,
53 const helios::core::units::Unit unit = helios::core::units::Unit::Meter
54 ) {
55 gameObject_.add<helios::engine::modules::spatial::transform::components::ScaleStateComponent>(scale, unit);
56 return *this;
57 }
58
59 /**
60 * @brief Sets the translation (position) of the entity.
61 *
62 * @param translation Position in world space.
63 *
64 * @return Reference to this config for chaining.
65 */
66 TransformConfig& translate(const helios::math::vec3f translation) {
67 gameObject_.getOrAdd<helios::engine::modules::spatial::transform::components::TranslationStateComponent>()
68 .setTranslation(translation);
69 return *this;
70 }
71
72 };
73
74}
75

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.