GfxEffectsConfig Class

Fluent configuration for visual effects. More...

Declaration

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

Public Constructors Index

	GfxEffectsConfig (helios::engine::ecs::GameObject gameObject)
	Constructs a GfxEffectsConfig. More...

Public Member Functions Index

GfxEffectsConfig &	spin (const float degreesPerSecond, const helios::math::vec3f spinAxis)
	Adds continuous rotation (spin) effect. More...

Private Member Attributes Index

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

Description

Fluent configuration for visual effects.

Provides methods for adding continuous rotation (spin) and other visual effects to a GameObject.

Definition at line 24 of file GfxEffectsConfig.ixx.

Public Constructors

GfxEffectsConfig()

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

inline explicit

Constructs a GfxEffectsConfig.

Parameters

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

Target GameObject to configure.

Definition at line 38 of file GfxEffectsConfig.ixx.

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

Referenced by spin.

Public Member Functions

spin()

GfxEffectsConfig & helios::engine::builder::gameObject::builders::configs::GfxEffectsConfig::spin (const float degreesPerSecond, const helios::math::vec3f spinAxis)

inline

Adds continuous rotation (spin) effect.

Parameters

degreesPerSecond	Rotation speed in degrees per second.
spinAxis	The axis of rotation (normalized).

Returns

Reference to this config for chaining.

Definition at line 48 of file GfxEffectsConfig.ixx.

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 }

Reference GfxEffectsConfig.

Private Member Attributes

gameObject_

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

Non-owning pointer to the target GameObject.

Definition at line 29 of file GfxEffectsConfig.ixx.

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

---

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

• GfxEffectsConfig.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.