1#ifndef PIXELPART_EFFECT_H
2#define PIXELPART_EFFECT_H
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>
17#include <unordered_map>
30class PixelpartEffect :
public VisualInstance3D {
31 GDCLASS(PixelpartEffect, VisualInstance3D)
35 virtual ~PixelpartEffect();
104 virtual void _enter_tree()
override;
105 virtual void _exit_tree()
override;
107 virtual void _process(
double dt)
override;
109 void _notification(
int p_what);
118 void set_effect(Ref<PixelpartEffectResource> resource);
125 Ref<PixelpartEffectResource>
get_effect()
const;
134 void play(
bool state);
440 void spawn_particles(String particleEmitterName, String particleTypeName,
int count);
448 Ref<PixelpartNode>
find_node(String name)
const;
456 Ref<PixelpartNode>
get_node(
int id)
const;
491 static void _bind_methods();
494 void apply_transform();
496 Ref<PixelpartEffectResource> effectResource;
497 PixelpartEffectRuntime effectRuntime;
498 bool editorPreviewEnabled =
true;
500 float effectScale = 1.0f;
502 bool finishedSignalEmitted =
false;
504 PixelpartGraphicsResourceProvider graphicsResourceProvider;
505 std::unordered_map<pixelpart::ParticleEmissionPair, std::unique_ptr<PixelpartParticleInstance3D>> particleInstances;
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