godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/scene/resources/particles_material.h

385 lines
12 KiB
C++
Raw Normal View History

Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
/*************************************************************************/
/* particles_material.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/templates/rid.h"
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
#include "scene/resources/material.h"
#ifndef PARTICLES_MATERIAL_H
#define PARTICLES_MATERIAL_H
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
/*
TODO:
-Path following
-Emitter positions deformable by bones
-Proper trails
*/
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
class ParticlesMaterial : public Material {
Made use of semicolons more consitent, fixed formatting
2019-03-19 18:35:57 +00:00
GDCLASS(ParticlesMaterial, Material);
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
public:
enum Parameter {
PARAM_INITIAL_LINEAR_VELOCITY,
PARAM_ANGULAR_VELOCITY,
PARAM_ORBIT_VELOCITY,
PARAM_LINEAR_ACCEL,
PARAM_RADIAL_ACCEL,
PARAM_TANGENTIAL_ACCEL,
PARAM_DAMPING,
PARAM_ANGLE,
PARAM_SCALE,
PARAM_HUE_VARIATION,
PARAM_ANIM_SPEED,
PARAM_ANIM_OFFSET,
PARAM_MAX
};
Adjust the material key bit size for ParticlesMaterial
2021-08-18 13:50:38 +00:00
// When extending, make sure not to overflow the size of the MaterialKey below.
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-04 23:35:57 +00:00
enum ParticleFlags {
PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY,
PARTICLE_FLAG_ROTATE_Y,
PARTICLE_FLAG_DISABLE_Z,
PARTICLE_FLAG_MAX
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
};
Adjust the material key bit size for ParticlesMaterial
2021-08-18 13:50:38 +00:00
// When extending, make sure not to overflow the size of the MaterialKey below.
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
enum EmissionShape {
EMISSION_SHAPE_POINT,
EMISSION_SHAPE_SPHERE,
EMISSION_SHAPE_BOX,
EMISSION_SHAPE_POINTS,
EMISSION_SHAPE_DIRECTED_POINTS,
This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 13:45:21 +00:00
EMISSION_SHAPE_RING,
Validate input in (CPU)Particles set_emission_shape() Fixes #29777. Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 09:59:01 +00:00
EMISSION_SHAPE_MAX
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
};
Adjust the material key bit size for ParticlesMaterial
2021-08-18 13:50:38 +00:00
// When extending, make sure not to overflow the size of the MaterialKey below.
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
enum SubEmitterMode {
SUB_EMITTER_DISABLED,
SUB_EMITTER_CONSTANT,
SUB_EMITTER_AT_END,
SUB_EMITTER_AT_COLLISION,
SUB_EMITTER_MAX
};
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
private:
union MaterialKey {
Adjust the material key bit size for ParticlesMaterial
2021-08-18 13:50:38 +00:00
// The bit size of the struct must be kept below or equal to 32 bits.
// Consider this when extending ParticleFlags, EmissionShape, or SubEmitterMode.
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
struct {
uint32_t texture_mask : 16;
uint32_t texture_color : 1;
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-04 23:35:57 +00:00
uint32_t particle_flags : 4;
Adjust the material key bit size for ParticlesMaterial
2021-08-18 13:50:38 +00:00
uint32_t emission_shape : 3;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
uint32_t invalid_key : 1;
uint32_t has_emission_color : 1;
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
uint32_t sub_emitter : 2;
Implement GPU Particle Collisions -Sphere Attractor -Box Attractor -Vector Field -Sphere Collider -Box Collider -Baked SDF Collider -Heightmap Collider
2020-10-08 00:29:49 +00:00
uint32_t attractor_enabled : 1;
uint32_t collision_enabled : 1;
uint32_t collision_scale : 1;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
};
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
uint32_t key = 0;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
bool operator<(const MaterialKey &p_key) const {
return key < p_key.key;
}
};
struct ShaderData {
RID shader;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int users = 0;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
};
static Map<MaterialKey, ShaderData> shader_map;
MaterialKey current_key;
_FORCE_INLINE_ MaterialKey _compute_key() const {
MaterialKey mk;
mk.key = 0;
for (int i = 0; i < PARAM_MAX; i++) {
if (tex_parameters[i].is_valid()) {
mk.texture_mask |= (1 << i);
}
}
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-04 23:35:57 +00:00
for (int i = 0; i < PARTICLE_FLAG_MAX; i++) {
if (particle_flags[i]) {
mk.particle_flags |= (1 << i);
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
}
}
mk.texture_color = color_ramp.is_valid() ? 1 : 0;
mk.emission_shape = emission_shape;
mk.has_emission_color = emission_shape >= EMISSION_SHAPE_POINTS && emission_color_texture.is_valid();
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
mk.sub_emitter = sub_emitter_mode;
Implement GPU Particle Collisions -Sphere Attractor -Box Attractor -Vector Field -Sphere Collider -Box Collider -Baked SDF Collider -Heightmap Collider
2020-10-08 00:29:49 +00:00
mk.collision_enabled = collision_enabled;
mk.attractor_enabled = attractor_interaction_enabled;
mk.collision_scale = collision_scale;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
return mk;
}
Reimplement Mutex with C++'s <mutex> Main: - It's now implemented thanks to `<mutex>`. No more platform-specific implementations. - `BinaryMutex` (non-recursive) is added, as an alternative for special cases. - Doesn't need allocation/deallocation anymore. It can live in the stack and be part of other classes. - Because of that, it's methods are now `const` and the inner mutex is `mutable` so it can be easily used in `const` contexts. - A no-op implementation is provided if `NO_THREADS` is defined. No more need to add `#ifdef NO_THREADS` just for this. - `MutexLock` now takes a reference. At this point the cases of null `Mutex`es are rare. If you ever need that, just don't use `MutexLock`. - Thread-safe utilities are therefore simpler now. Misc.: - `ScopedMutexLock` is dropped and replaced by `MutexLock`, because they were pretty much the same. - Every case of lock, do-something, unlock is replaced by `MutexLock` (complex cases where it's not straightfoward are kept as as explicit lock and unlock). - `ShaderRD` contained an `std::mutex`, which has been replaced by `Mutex`.
2020-02-26 10:28:13 +00:00
static Mutex material_mutex;
Moved dirty material lists from static to lifetime controlled by main. As with 7d82bed4f4cac8f5227d935c0496290e24eb48c8, The list is now destroyed before the OS object, so can print errors if there are unfreed materials.
2018-11-21 15:48:05 +00:00
static SelfList<ParticlesMaterial>::List *dirty_materials;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
struct ShaderNames {
Add a Direction property to ParticlesMaterial
2019-03-04 22:45:53 +00:00
StringName direction;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
StringName spread;
StringName flatness;
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 17:46:27 +00:00
StringName initial_linear_velocity_min;
StringName initial_angle_min;
StringName angular_velocity_min;
StringName orbit_velocity_min;
StringName linear_accel_min;
StringName radial_accel_min;
StringName tangent_accel_min;
StringName damping_min;
StringName scale_min;
StringName hue_variation_min;
StringName anim_speed_min;
StringName anim_offset_min;
StringName initial_linear_velocity_max;
StringName initial_angle_max;
StringName angular_velocity_max;
StringName orbit_velocity_max;
StringName linear_accel_max;
StringName radial_accel_max;
StringName tangent_accel_max;
StringName damping_max;
StringName scale_max;
StringName hue_variation_max;
StringName anim_speed_max;
StringName anim_offset_max;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
StringName angle_texture;
StringName angular_velocity_texture;
StringName orbit_velocity_texture;
StringName linear_accel_texture;
StringName radial_accel_texture;
StringName tangent_accel_texture;
StringName damping_texture;
StringName scale_texture;
StringName hue_variation_texture;
StringName anim_speed_texture;
StringName anim_offset_texture;
StringName color;
StringName color_ramp;
Random initial color parameter for ParticleMaterial Works with 2D and 3D GPU Particles
2021-11-23 12:50:35 +00:00
StringName color_initial_ramp;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
StringName emission_sphere_radius;
StringName emission_box_extents;
StringName emission_texture_point_count;
StringName emission_texture_points;
StringName emission_texture_normal;
StringName emission_texture_color;
This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 13:45:21 +00:00
StringName emission_ring_axis;
StringName emission_ring_height;
StringName emission_ring_radius;
StringName emission_ring_inner_radius;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
StringName gravity;
added individual particle random lifetime
2019-07-15 04:48:20 +00:00
StringName lifetime_randomness;
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
StringName sub_emitter_frequency;
StringName sub_emitter_amount_at_end;
StringName sub_emitter_keep_velocity;
Implement GPU Particle Collisions -Sphere Attractor -Box Attractor -Vector Field -Sphere Collider -Box Collider -Baked SDF Collider -Heightmap Collider
2020-10-08 00:29:49 +00:00
StringName collision_friction;
StringName collision_bounce;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
};
static ShaderNames *shader_names;
SelfList<ParticlesMaterial> element;
void _update_shader();
_FORCE_INLINE_ void _queue_shader_change();
_FORCE_INLINE_ bool _is_shader_dirty() const;
Prevent shaders from generating code before the constructor finishes. Fixes #43733: "creating SpatialMaterial in a separate thread creates invalid shaders (temporarily)." The bug occurred because various setters called in materials' constructors add materials to queues that are processed on the main thread. This means that when the materials are created in another thread, they can be processed on the main thread before the constructor has finished. The fix adds a flag to affected materials that prevents them from being added to the queue until their constructors have finished initialising all the members.
2021-09-07 15:39:37 +00:00
bool is_initialized = false;
Add a Direction property to ParticlesMaterial
2019-03-04 22:45:53 +00:00
Vector3 direction;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
float spread;
float flatness;
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 17:46:27 +00:00
float params_min[PARAM_MAX];
float params_max[PARAM_MAX];
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
Ref<Texture2D> tex_parameters[PARAM_MAX];
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Color color;
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
Ref<Texture2D> color_ramp;
Random initial color parameter for ParticleMaterial Works with 2D and 3D GPU Particles
2021-11-23 12:50:35 +00:00
Ref<Texture2D> color_initial_ramp;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-04 23:35:57 +00:00
bool particle_flags[PARTICLE_FLAG_MAX];
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
EmissionShape emission_shape;
float emission_sphere_radius;
Vector3 emission_box_extents;
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
Ref<Texture2D> emission_point_texture;
Ref<Texture2D> emission_normal_texture;
Ref<Texture2D> emission_color_texture;
This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 13:45:21 +00:00
Vector3 emission_ring_axis;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
real_t emission_ring_height;
real_t emission_ring_radius;
real_t emission_ring_inner_radius;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int emission_point_count = 1;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
bool anim_loop;
Vector3 gravity;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
double lifetime_randomness;
added individual particle random lifetime
2019-07-15 04:48:20 +00:00
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
SubEmitterMode sub_emitter_mode;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
double sub_emitter_frequency;
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
int sub_emitter_amount_at_end;
bool sub_emitter_keep_velocity;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
//do not save emission points here
Implement GPU Particle Collisions -Sphere Attractor -Box Attractor -Vector Field -Sphere Collider -Box Collider -Baked SDF Collider -Heightmap Collider
2020-10-08 00:29:49 +00:00
bool attractor_interaction_enabled;
bool collision_enabled;
bool collision_scale;
float collision_friction;
float collision_bounce;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
protected:
static void _bind_methods();
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual void _validate_property(PropertyInfo &property) const override;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
public:
Add a Direction property to ParticlesMaterial
2019-03-04 22:45:53 +00:00
void set_direction(Vector3 p_direction);
Vector3 get_direction() const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
void set_spread(float p_spread);
float get_spread() const;
void set_flatness(float p_flatness);
float get_flatness() const;
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 17:46:27 +00:00
void set_param_min(Parameter p_param, float p_value);
float get_param_min(Parameter p_param) const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 17:46:27 +00:00
void set_param_max(Parameter p_param, float p_value);
float get_param_max(Parameter p_param) const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
void set_param_texture(Parameter p_param, const Ref<Texture2D> &p_texture);
Ref<Texture2D> get_param_texture(Parameter p_param) const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
void set_color(const Color &p_color);
Color get_color() const;
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
void set_color_ramp(const Ref<Texture2D> &p_texture);
Ref<Texture2D> get_color_ramp() const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Random initial color parameter for ParticleMaterial Works with 2D and 3D GPU Particles
2021-11-23 12:50:35 +00:00
void set_color_initial_ramp(const Ref<Texture2D> &p_texture);
Ref<Texture2D> get_color_initial_ramp() const;
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-04 23:35:57 +00:00
void set_particle_flag(ParticleFlags p_particle_flag, bool p_enable);
bool get_particle_flag(ParticleFlags p_particle_flag) const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
void set_emission_shape(EmissionShape p_shape);
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
void set_emission_sphere_radius(real_t p_radius);
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
void set_emission_box_extents(Vector3 p_extents);
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
void set_emission_point_texture(const Ref<Texture2D> &p_points);
void set_emission_normal_texture(const Ref<Texture2D> &p_normals);
void set_emission_color_texture(const Ref<Texture2D> &p_colors);
This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 13:45:21 +00:00
void set_emission_ring_axis(Vector3 p_axis);
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
void set_emission_ring_height(real_t p_height);
void set_emission_ring_radius(real_t p_radius);
void set_emission_ring_inner_radius(real_t p_radius);
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
void set_emission_point_count(int p_count);
EmissionShape get_emission_shape() const;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
real_t get_emission_sphere_radius() const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Vector3 get_emission_box_extents() const;
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
Ref<Texture2D> get_emission_point_texture() const;
Ref<Texture2D> get_emission_normal_texture() const;
Ref<Texture2D> get_emission_color_texture() const;
This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 13:45:21 +00:00
Vector3 get_emission_ring_axis() const;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
real_t get_emission_ring_height() const;
real_t get_emission_ring_radius() const;
real_t get_emission_ring_inner_radius() const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
int get_emission_point_count() const;
void set_gravity(const Vector3 &p_gravity);
Vector3 get_gravity() const;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
void set_lifetime_randomness(double p_lifetime);
double get_lifetime_randomness() const;
added individual particle random lifetime
2019-07-15 04:48:20 +00:00
Implement GPU Particle Collisions -Sphere Attractor -Box Attractor -Vector Field -Sphere Collider -Box Collider -Baked SDF Collider -Heightmap Collider
2020-10-08 00:29:49 +00:00
void set_attractor_interaction_enabled(bool p_enable);
bool is_attractor_interaction_enabled() const;
void set_collision_enabled(bool p_enabled);
bool is_collision_enabled() const;
void set_collision_use_scale(bool p_scale);
bool is_collision_using_scale() const;
void set_collision_friction(float p_friction);
float get_collision_friction() const;
void set_collision_bounce(float p_bounce);
float get_collision_bounce() const;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
static void init_shaders();
static void finish_shaders();
static void flush_changes();
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
void set_sub_emitter_mode(SubEmitterMode p_sub_emitter_mode);
SubEmitterMode get_sub_emitter_mode() const;
Use real_t and double where appropriate in Particles
2021-08-12 14:07:47 +00:00
void set_sub_emitter_frequency(double p_frequency);
double get_sub_emitter_frequency() const;
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
void set_sub_emitter_amount_at_end(int p_amount);
int get_sub_emitter_amount_at_end() const;
void set_sub_emitter_keep_velocity(bool p_enable);
bool get_sub_emitter_keep_velocity() const;
Added ability to visualize native shaders
2021-01-05 23:01:50 +00:00
virtual RID get_shader_rid() const override;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Shader::Mode get_shader_mode() const override;
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
ParticlesMaterial();
~ParticlesMaterial();
};
VARIANT_ENUM_CAST(ParticlesMaterial::Parameter)
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-04 23:35:57 +00:00
VARIANT_ENUM_CAST(ParticlesMaterial::ParticleFlags)
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
VARIANT_ENUM_CAST(ParticlesMaterial::EmissionShape)
Implement manual particle emission and particle sub emitters.
2020-09-06 12:18:10 +00:00
VARIANT_ENUM_CAST(ParticlesMaterial::SubEmitterMode)
Move ParticlesMaterial code to its own resource file It's shared by both 2D and 3D particles (+ CPU ones), so it makes sense to have as a common resource. It also allowed to disable compilation of Particles (3D) when using 'disable_3d'. Also cleaned up includes in SpatialEditorGizmos and some other places, as well as dropped dead code in material_editor_plugin.cpp.
2018-09-04 09:30:04 +00:00
#endif // PARTICLES_MATERIAL_H