UiTransformConfig Class

Fluent configuration for spatial transform setup. More...

Declaration

class helios::engine::builder::gameObject::builders::configs::UiTransformConfig { ... }

Public Constructors Index

	UiTransformConfig (helios::engine::ecs::GameObject gameObject)
	Constructs a UiTransformConfig and adds ComposeTransformComponent. More...

Public Member Functions Index

UiTransformConfig &	anchor (const helios::engine::modules::ui::layout::Anchor anchor)
	Sets the anchor point for UI positioning. More...
UiTransformConfig &	viewport (const helios::engine::common::types::ViewportId viewportId)
	Sets the viewport for this UI element. More...
UiTransformConfig &	pivot (const helios::engine::modules::ui::layout::Anchor anchor)
	Sets the pivot point for transformations. More...
UiTransformConfig &	offsets (const helios::math::vec4f offsets)
	Sets the offsets for UI positioning. More...

Private Member Attributes Index

helios::engine::ecs::GameObject	gameObject_
	Non-owning pointer to the target GameObject. More...

Description

Fluent configuration for spatial transform setup.

Automatically adds ComposeTransformComponent and provides methods for setting scale and translation.

Definition at line 30 of file UiTransformConfig.ixx.

Public Constructors

UiTransformConfig()

helios::engine::builder::gameObject::builders::configs::UiTransformConfig::UiTransformConfig (helios::engine::ecs::GameObject gameObject)

inline explicit

Constructs a UiTransformConfig and adds ComposeTransformComponent.

Parameters

<a href="/docs/helios/namespaces/helios/engine/builder/gameobject">gameObject</a>

Target GameObject to configure.

Definition at line 45 of file UiTransformConfig.ixx.

45 explicit UiTransformConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {

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

47 gameObject_.getOrAdd<helios::engine::modules::spatial::transform::components::TranslationStateComponent>();

48 gameObject_.add<helios::engine::modules::ui::transform::components::UiTransformComponent>();

49 }

Referenced by anchor, offsets, pivot and viewport.

Public Member Functions

anchor()

UiTransformConfig & helios::engine::builder::gameObject::builders::configs::UiTransformConfig::anchor (const helios::engine::modules::ui::layout::Anchor anchor)

inline

Sets the anchor point for UI positioning.

Parameters

anchor

The anchor position (e.g., TopLeft, Center).

Returns

Reference to this config for chaining.

Definition at line 58 of file UiTransformConfig.ixx.

58 UiTransformConfig& anchor(const helios::engine::modules::ui::layout::Anchor anchor) {

59 gameObject_.get<helios::engine::modules::ui::transform::components::UiTransformComponent>()

60 ->setAnchor(anchor);

61 return *this;

62 }

References anchor and UiTransformConfig.

Referenced by anchor and pivot.

offsets()

UiTransformConfig & helios::engine::builder::gameObject::builders::configs::UiTransformConfig::offsets (const helios::math::vec4f offsets)

inline

Sets the offsets for UI positioning.

Parameters

offsets

The offsets as vec4f (top, right, bottom, left).

Returns

Reference to this config for chaining.

Definition at line 97 of file UiTransformConfig.ixx.

97 UiTransformConfig& offsets(const helios::math::vec4f offsets) {

98 gameObject_.get<helios::engine::modules::ui::transform::components::UiTransformComponent>()

99 ->setOffsets(offsets);

100 return *this;

101 }

References offsets and UiTransformConfig.

Referenced by offsets.

pivot()

UiTransformConfig & helios::engine::builder::gameObject::builders::configs::UiTransformConfig::pivot (const helios::engine::modules::ui::layout::Anchor anchor)

inline

Sets the pivot point for transformations.

Parameters

anchor

The pivot position.

Returns

Reference to this config for chaining.

Definition at line 84 of file UiTransformConfig.ixx.

84 UiTransformConfig& pivot(const helios::engine::modules::ui::layout::Anchor anchor) {

85 gameObject_.get<helios::engine::modules::ui::transform::components::UiTransformComponent>()

86 ->setPivot(anchor);

87 return *this;

88 }

References anchor and UiTransformConfig.

viewport()

UiTransformConfig & helios::engine::builder::gameObject::builders::configs::UiTransformConfig::viewport (const helios::engine::common::types::ViewportId viewportId)

inline

Sets the viewport for this UI element.

Parameters

viewportId

The ID of the viewport to attach to.

Returns

Reference to this config for chaining.

Definition at line 71 of file UiTransformConfig.ixx.

71 UiTransformConfig& viewport(const helios::engine::common::types::ViewportId viewportId) {

72 gameObject_.get<helios::engine::modules::ui::transform::components::UiTransformComponent>()

73 ->setViewportId(viewportId);

74 return *this;

75 }

Reference UiTransformConfig.

Private Member Attributes

gameObject_

helios::engine::ecs::GameObject helios::engine::builder::gameObject::builders::configs::UiTransformConfig::gameObject_

Non-owning pointer to the target GameObject.

Definition at line 35 of file UiTransformConfig.ixx.

35 helios::engine::ecs::GameObject gameObject_;

---

The documentation for this class was generated from the following file:

• UiTransformConfig.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.