Pixelpart 1.9.1
Godot Plugin
Loading...
Searching...
No Matches
PixelpartEffect.h
1#ifndef PIXELPART_EFFECT_H
2#define PIXELPART_EFFECT_H
3
4#include "PixelpartEffectResource.h"
5#include "PixelpartEffectRuntime.h"
6#include "rendering/PixelpartGraphicsResourceProvider.h"
7#include "rendering/PixelpartParticleInstance3D.h"
8#include "particletype/PixelpartParticleType.h"
9#include "node/PixelpartParticleEmitter.h"
10#include "node/PixelpartForceField.h"
11#include "node/PixelpartCollider.h"
12#include <pixelpart-runtime/effect/ParticleEmissionPair.h>
13#include <godot_cpp/core/binder_common.hpp>
14#include <godot_cpp/classes/visual_instance3d.hpp>
15#include <cstdint>
16#include <memory>
17#include <unordered_map>
18
19namespace godot {
30class PixelpartEffect : public VisualInstance3D {
31 GDCLASS(PixelpartEffect, VisualInstance3D)
32
33public:
34 PixelpartEffect();
35 virtual ~PixelpartEffect();
36
37#ifdef DOXYGEN
42
46 bool playing;
47
51 bool loop;
52
58 float loop_time;
59
66
70 float speed;
71
76
82 int seed;
83
88
94 Dictionary inputs;
95
102#endif
103
104 virtual void _enter_tree() override;
105 virtual void _exit_tree() override;
106
107 virtual void _process(double dt) override;
108
109 void _notification(int p_what);
110
111 void draw();
112
118 void set_effect(Ref<PixelpartEffectResource> resource);
119
125 Ref<PixelpartEffectResource> get_effect() const;
126
134 void play(bool state);
135
141 void pause();
142
147 void restart();
148
153 void reset();
154
160 bool is_playing() const;
161
167 float get_time() const;
168
174 void set_loop(bool mode);
175
181 bool get_loop() const;
182
190 void set_loop_time(float time);
191
197 float get_loop_time() const;
198
206 void set_warmup_time(float time);
207
213 float get_warmup_time() const;
214
220 void set_speed(float sp);
221
227 float get_speed() const;
228
234 void set_frame_rate(float rate);
235
241 float get_frame_rate() const;
242
250 void set_seed(int sd);
251
257 int get_seed() const;
258
264 void enable_random_seed(bool mode);
265
271 bool is_random_seed_enabled() const;
272
280 void set_effect_scale(float scale);
281
287 float get_effect_scale() const;
288
296 void set_inputs(Dictionary inputs);
297
305 Dictionary get_inputs() const;
306
313 void set_input_bool(String name, bool value);
314
321 void set_input_int(String name, int value);
322
329 void set_input_float(String name, float value);
330
337 void set_input_float2(String name, Vector2 value);
338
345 void set_input_float3(String name, Vector3 value);
346
353 void set_input_float4(String name, Vector4 value);
354
361 bool get_input_bool(String name) const;
362
369 int get_input_int(String name) const;
370
377 float get_input_float(String name) const;
378
385 Vector2 get_input_float2(String name) const;
386
393 Vector3 get_input_float3(String name) const;
394
401 Vector4 get_input_float4(String name) const;
402
409 int get_input_type(String name) const;
410
416 TypedArray<String> get_input_names() const;
417
423 void activate_trigger(String name);
424
431 bool is_trigger_activated(String name) const;
432
440 void spawn_particles(String particleEmitterName, String particleTypeName, int count);
441
448 Ref<PixelpartNode> find_node(String name) const;
449
456 Ref<PixelpartNode> get_node(int id) const;
457
464 Ref<PixelpartNode> get_node_at_index(int index) const;
465
472 Ref<PixelpartParticleType> find_particle_type(String name) const;
473
480 Ref<PixelpartParticleType> get_particle_type(int id) const;
481
488 Ref<PixelpartParticleType> get_particle_type_at_index(int index) const;
489
490protected:
491 static void _bind_methods();
492
493private:
494 void apply_transform();
495
496 Ref<PixelpartEffectResource> effectResource;
497 PixelpartEffectRuntime effectRuntime;
498 bool editorPreviewEnabled = true;
499
500 float effectScale = 1.0f;
501
502 bool finishedSignalEmitted = false;
503
504 PixelpartGraphicsResourceProvider graphicsResourceProvider;
505 std::unordered_map<pixelpart::ParticleEmissionPair, std::unique_ptr<PixelpartParticleInstance3D>> particleInstances;
506};
507}
508
509#endif
float get_frame_rate() const
Return at which rate the effect is simulated, in frames per second.
Definition PixelpartEffect.cpp:203
void spawn_particles(String particleEmitterName, String particleTypeName, int count)
Generate count particles of the given type from the given emitter.
Definition PixelpartEffect.cpp:286
int get_seed() const
Return the seed used to initialize the effect simulation.
Definition PixelpartEffect.cpp:210
int get_input_int(String name) const
Return value of an effect input. The effect input must be of type int.
Definition PixelpartEffect.cpp:257
PixelpartEffectResource effect
Effect resource that is shown.
Definition PixelpartEffect.h:41
bool is_playing() const
Return whether the effect is currently playing or is paused.
Definition PixelpartEffect.cpp:165
void set_loop_time(float time)
Set time in seconds after which the effect loops.
Definition PixelpartEffect.cpp:179
void set_input_float3(String name, Vector3 value)
Definition PixelpartEffect.cpp:248
void set_inputs(Dictionary inputs)
Set dictionary of effect input values.
Definition PixelpartEffect.cpp:229
void restart()
Restart the effect and remove all existing particles.
Definition PixelpartEffect.cpp:159
bool is_random_seed_enabled() const
Return whether a random seed is used to initialize the effect simulation.
Definition PixelpartEffect.cpp:217
void set_effect_scale(float scale)
Set multiplier for the size of the effect.
Definition PixelpartEffect.cpp:221
Ref< PixelpartParticleType > get_particle_type(int id) const
Return the particle type with the given ID.
Definition PixelpartEffect.cpp:303
Ref< PixelpartParticleType > get_particle_type_at_index(int index) const
Return the particle type at the given index.
Definition PixelpartEffect.cpp:306
Dictionary get_inputs() const
Return dictionary of effect input values.
Definition PixelpartEffect.cpp:232
float warmup_time
Time in seconds the effect is pre-simulated before being rendered.
Definition PixelpartEffect.h:65
float get_time() const
Return the time in seconds since the effect has started playing.
Definition PixelpartEffect.cpp:168
bool get_input_bool(String name) const
Return value of an effect input. The effect input must be of type bool.
Definition PixelpartEffect.cpp:254
float effect_scale
Multiplier for the size of the effect.
Definition PixelpartEffect.h:101
void set_speed(float sp)
Set how fast the effect is being played.
Definition PixelpartEffect.cpp:193
bool playing
Whether the effect is currently playing or not.
Definition PixelpartEffect.h:46
float frame_rate
At which rate the effect is simulated, in frames per second.
Definition PixelpartEffect.h:75
void set_input_float(String name, float value)
Definition PixelpartEffect.cpp:242
float get_loop_time() const
Return time in seconds after which the effect loops.
Definition PixelpartEffect.cpp:182
void reset()
Restart the effect, but do not remove existing particles.
Definition PixelpartEffect.cpp:162
void set_seed(int sd)
Set the seed used to initialize the effect simulation.
Definition PixelpartEffect.cpp:207
float get_input_float(String name) const
Return value of an effect input. The effect input must be of type float.
Definition PixelpartEffect.cpp:260
bool is_trigger_activated(String name) const
Return whether trigger name was activated.
Definition PixelpartEffect.cpp:282
Ref< PixelpartNode > get_node_at_index(int index) const
Return the node at the given index.
Definition PixelpartEffect.cpp:296
void activate_trigger(String name)
Activate trigger name.
Definition PixelpartEffect.cpp:279
void set_input_float2(String name, Vector2 value)
Definition PixelpartEffect.cpp:245
bool get_loop() const
Return whether the effect restarts automatically after time loop_time.
Definition PixelpartEffect.cpp:175
void set_effect(Ref< PixelpartEffectResource > resource)
Change the effect resource that is shown.
Definition PixelpartEffect.cpp:105
int get_input_type(String name) const
Return the type of an effect input or -1 if the effect input does not exist.
Definition PixelpartEffect.cpp:272
void play(bool state)
Start playing or pause simulation of the effect.
Definition PixelpartEffect.cpp:153
Ref< PixelpartNode > get_node(int id) const
Return the node with the given ID.
Definition PixelpartEffect.cpp:293
Ref< PixelpartEffectResource > get_effect() const
Return the effect resource that is being shown.
Definition PixelpartEffect.cpp:149
Ref< PixelpartNode > find_node(String name) const
Return the node with the given name.
Definition PixelpartEffect.cpp:290
void enable_random_seed(bool mode)
Use a random seed to initialize the effect simulation.
Definition PixelpartEffect.cpp:214
void set_input_bool(String name, bool value)
Definition PixelpartEffect.cpp:236
float get_effect_scale() const
Return multiplier for the size of the effect.
Definition PixelpartEffect.cpp:225
void set_frame_rate(float rate)
Set at which rate the effect is simulated, in frames per second.
Definition PixelpartEffect.cpp:200
void set_input_int(String name, int value)
Definition PixelpartEffect.cpp:239
Vector3 get_input_float3(String name) const
Return value of an effect input. The effect input must be of type Vector3.
Definition PixelpartEffect.cpp:266
float get_speed() const
Return how fast the effect is being played.
Definition PixelpartEffect.cpp:196
Vector2 get_input_float2(String name) const
Return value of an effect input. The effect input must be of type Vector2.
Definition PixelpartEffect.cpp:263
float speed
How fast the effect is being played.
Definition PixelpartEffect.h:70
Ref< PixelpartParticleType > find_particle_type(String name) const
Return the particle type with the given name.
Definition PixelpartEffect.cpp:300
bool random_seed
Whether to use a random seed to initialize the effect simulation.
Definition PixelpartEffect.h:87
void set_loop(bool mode)
Set whether the effect restarts automatically after time loop_time.
Definition PixelpartEffect.cpp:172
float loop_time
Time in seconds after which the effect loops.
Definition PixelpartEffect.h:58
float get_warmup_time() const
Return time in seconds the effect is pre-simulated before being rendered.
Definition PixelpartEffect.cpp:189
Dictionary inputs
Dictionary of effect input values.
Definition PixelpartEffect.h:94
bool loop
Whether the effect restarts automatically after time loop_time.
Definition PixelpartEffect.h:51
Vector4 get_input_float4(String name) const
Return value of an effect input. The effect input must be of type Vector4.
Definition PixelpartEffect.cpp:269
TypedArray< String > get_input_names() const
Return names of available effect inputs.
Definition PixelpartEffect.cpp:275
void pause()
Pause simulation of the effect.
Definition PixelpartEffect.cpp:156
void set_warmup_time(float time)
Set time in seconds the effect is pre-simulated before being rendered.
Definition PixelpartEffect.cpp:186
int seed
Seed used to initialize the effect simulation.
Definition PixelpartEffect.h:82
void set_input_float4(String name, Vector4 value)
Definition PixelpartEffect.cpp:251
Resource for a Pixelpart effect that is contained in a ppfx file.
Definition PixelpartEffectResource.h:15