Brunot
Loading...
Searching...
No Matches
ParticleGenerator.h
Go to the documentation of this file.
1
10// ____ __ __ __
11// /\__ _\/\ \ /\ \/\ \
12// \/_/\ \/\ \ \___ __ \ \ \_\ \ ___ __ __ ____ __
13// \ \ \ \ \ _ `\ /'__`\ \ \ _ \ / __`\/\ \/\ \ /',__\ /'__`\
14// \ \ \ \ \ \ \ \/\ __/ \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\ __/
15// \ \_\ \ \_\ \_\ \____\ \ \_\ \_\ \____/\ \____/\/\____/\ \____\
16// \/_/ \/_/\/_/\/____/ \/_/\/_/\/___/ \/___/ \/___/ \/____/
17
18#pragma once
19#include "Framework/Component.h"
21
22class ParticleEmitter;
23
59class ParticleGenerator final : public Component
60{
61public:
62#pragma region static_functions
63 static auto bindLuaTypes(sol::state& lua) -> void {}
64 static auto getEnum() -> ComponentTypeEnum
65 {
66 return cParticleGenerator;
67 }
68
69#pragma endregion
70
73 auto operator=(const ParticleGenerator&) -> ParticleGenerator& = default;
74 ~ParticleGenerator() override = default;
75 ParticleGenerator(ParticleGenerator&& other) noexcept = default;
76 auto operator=(ParticleGenerator&& other) noexcept -> ParticleGenerator& = default;
77
78#pragma region overriden_functions
79
80 auto clone() const -> std::unique_ptr<GameObject> override
81 {
82 return std::make_unique<ParticleGenerator>(*this);
83 }
84
85 auto componentShowMenu() -> void override;
86 // for debug ImGUI
87private:
88 auto onUpdate(float dt) -> void override;
89public:
90 auto endWindow() -> void override
91 {
92 } // for debug ImGUI
93private:
94 auto onRender() -> void override;
95public:
96 auto load(const Stream& stream) -> void override;
97 auto save(Stream& stream) const -> void override;
98 auto onEnterEngine() -> void override;
99
100 friend auto to_json(json& j, const ParticleGenerator& n) -> void;
101 friend auto from_json(const json& j, ParticleGenerator& n) -> void;
102
103
104#pragma endregion
105
106#pragma region ParticleGenerator_functions
107
109 auto addEmitter() -> void;
110
111 auto addEmitter(std::unique_ptr<ParticleEmitter> emitter) -> void;
112
113
114 auto removeEmitters(const std::string& emitter) -> void;
115
116 auto removeEmitter(int index) -> void;
117
123 auto activate() -> void;
124
130 auto deactivate() -> void;
131
132#pragma endregion
133
134#pragma region messaging_functions
135 auto linkMessages() -> void;
136
137#pragma endregion
138
139private:
140#pragma region member_variables
141
142
144 std::vector<std::unique_ptr<ParticleEmitter>> emitters;
145
147 bool active = true;
149 bool repeats = true;
150
151#pragma endregion
152
153#pragma region helper_functions
154
155#pragma endregion
156
157#pragma region static_variables
158
159#pragma endregion
160
161};
sys::Json Stream
Definition AudioObject.h:20
The base class for components, holding all of their shared All components should inherit from this.
nlohmann::json json
Definition Json.cpp:19
An object that manages many of a single type of particle.
ComponentTypeEnum
This enum lists out every type of component we have.
Definition Component.h:39
Component(ComponentTypeEnum type, const char *typeName)
Definition Component.cpp:72
GameObject(std::string typeName, gobj::Type parentType, gobj::Type type)
constructor for gameobject.
Definition GameObject.cpp:24
An object that manages many of a single type of particle.
Definition ParticleEmitter.h:32
A Component that generates several types of particles, by holding several ParticleEmitters.
Definition ParticleGenerator.h:60
std::vector< std::unique_ptr< ParticleEmitter > > emitters
All the particle emitters inside the generator.
Definition ParticleGenerator.h:144
auto endWindow() -> void override
currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
Definition ParticleGenerator.h:90
auto activate() -> void
Activates the particle generator, and all it's emitters If the particle generator is set to repeat,...
Definition ParticleGenerator.cpp:218
auto onEnterEngine() -> void override
hook that is called when a GameObject enters the Engine tree.
Definition ParticleGenerator.cpp:144
auto onRender() -> void override
called every frame after update has been called for every object.
Definition ParticleGenerator.cpp:130
auto removeEmitters(const std::string &emitter) -> void
Definition ParticleGenerator.cpp:201
~ParticleGenerator() override=default
friend auto to_json(json &j, const ParticleGenerator &n) -> void
Definition ParticleGenerator.cpp:152
auto operator=(const ParticleGenerator &) -> ParticleGenerator &=default
auto operator=(ParticleGenerator &&other) noexcept -> ParticleGenerator &=default
ParticleGenerator()
Definition ParticleGenerator.cpp:27
bool active
whether the generator should currently emit particles
Definition ParticleGenerator.h:147
auto removeEmitter(int index) -> void
Definition ParticleGenerator.cpp:212
static auto bindLuaTypes(sol::state &lua) -> void
Definition ParticleGenerator.h:63
bool repeats
whether the generator continuously emits particles (true), or emits on a burst
Definition ParticleGenerator.h:149
auto save(Stream &stream) const -> void override
Implementations will load the state of a GameObject to a th::Json object.
Definition ParticleGenerator.cpp:139
auto linkMessages() -> void
Definition ParticleGenerator.cpp:235
ParticleGenerator(ParticleGenerator &&other) noexcept=default
auto addEmitter() -> void
Creates a new, default constructed Particle Emitter.
Definition ParticleGenerator.cpp:189
friend auto from_json(const json &j, ParticleGenerator &n) -> void
Definition ParticleGenerator.cpp:165
auto onUpdate(float dt) -> void override
called once every frame.
Definition ParticleGenerator.cpp:91
auto clone() const -> std::unique_ptr< GameObject > override
makes a copy a GameObject even if it's held polymorphically
Definition ParticleGenerator.h:80
static auto getEnum() -> ComponentTypeEnum
Definition ParticleGenerator.h:64
auto deactivate() -> void
deactivates the particle generator, and all of it's emitters If the particle generator is set to repe...
Definition ParticleGenerator.cpp:228
auto load(const Stream &stream) -> void override
Implementations will load the state of a GameObject from a th::Json Object.
Definition ParticleGenerator.cpp:134
auto componentShowMenu() -> void override
Definition ParticleGenerator.cpp:50