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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

359 lines
14 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* visual_shader_particle_nodes.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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. */
/**************************************************************************/
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
#ifndef VISUAL_SHADER_PARTICLE_NODES_H
#define VISUAL_SHADER_PARTICLE_NODES_H
#include "scene/resources/visual_shader.h"
// Emit nodes
class VisualShaderNodeParticleEmitter : public VisualShaderNode {
GDCLASS(VisualShaderNodeParticleEmitter, VisualShaderNode);
Added 2D boolean hint for particle emitters in visual shaders
2021-11-04 15:42:57 +00:00
protected:
bool mode_2d = false;
static void _bind_methods();
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
public:
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
Make port previews in visual shader visible in other shader modes
2021-10-08 19:55:07 +00:00
virtual bool has_output_port_preview(int p_port) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
virtual void set_mode_2d(bool p_enabled);
Added 2D boolean hint for particle emitters in visual shaders
2021-11-04 15:42:57 +00:00
bool is_mode_2d() const;
Vector<StringName> get_editable_properties() const override;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
virtual HashMap<StringName, String> get_editable_properties_names() const override;
Added 2D boolean hint for particle emitters in visual shaders
2021-11-04 15:42:57 +00:00
bool is_show_prop_names() const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
VisualShaderNodeParticleEmitter();
};
class VisualShaderNodeParticleSphereEmitter : public VisualShaderNodeParticleEmitter {
GDCLASS(VisualShaderNodeParticleSphereEmitter, VisualShaderNodeParticleEmitter);
public:
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
virtual String generate_global_per_node(Shader::Mode p_mode, int p_id) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
VisualShaderNodeParticleSphereEmitter();
};
class VisualShaderNodeParticleBoxEmitter : public VisualShaderNodeParticleEmitter {
GDCLASS(VisualShaderNodeParticleBoxEmitter, VisualShaderNodeParticleEmitter);
public:
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
virtual void set_mode_2d(bool p_enabled) override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
virtual String generate_global_per_node(Shader::Mode p_mode, int p_id) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
VisualShaderNodeParticleBoxEmitter();
};
class VisualShaderNodeParticleRingEmitter : public VisualShaderNodeParticleEmitter {
GDCLASS(VisualShaderNodeParticleRingEmitter, VisualShaderNodeParticleEmitter);
public:
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
virtual String generate_global_per_node(Shader::Mode p_mode, int p_id) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
VisualShaderNodeParticleRingEmitter();
};
Added `MeshEmitter` node for particles in visual shader
2021-11-05 19:57:24 +00:00
class VisualShaderNodeParticleMeshEmitter : public VisualShaderNodeParticleEmitter {
GDCLASS(VisualShaderNodeParticleMeshEmitter, VisualShaderNodeParticleEmitter);
Ref<Mesh> mesh;
bool use_all_surfaces = true;
int surface_index = 0;
Ref<ImageTexture> position_texture;
Ref<ImageTexture> normal_texture;
Enchance `VisualShaderNodeMeshEmitter`, add more ports and fix bugs
2021-11-18 10:30:51 +00:00
Ref<ImageTexture> color_texture;
Ref<ImageTexture> uv_texture;
Ref<ImageTexture> uv2_texture;
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
String _generate_code(VisualShader::Type p_type, int p_id, const String *p_output_vars, int p_index, const String &p_texture_name, PortType p_port_type) const;
Enchance `VisualShaderNodeMeshEmitter`, add more ports and fix bugs
2021-11-18 10:30:51 +00:00
void _update_texture(const Vector<Vector2> &p_array, Ref<ImageTexture> &r_texture);
void _update_texture(const Vector<Vector3> &p_array, Ref<ImageTexture> &r_texture);
void _update_texture(const Vector<Color> &p_array, Ref<ImageTexture> &r_texture);
void _update_textures();
Added `MeshEmitter` node for particles in visual shader
2021-11-05 19:57:24 +00:00
protected:
static void _bind_methods();
public:
virtual String get_caption() const override;
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
Enchance `VisualShaderNodeMeshEmitter`, add more ports and fix bugs
2021-11-18 10:30:51 +00:00
virtual String generate_global(Shader::Mode p_mode, VisualShader::Type p_type, int p_id) const override;
Added `MeshEmitter` node for particles in visual shader
2021-11-05 19:57:24 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
void set_mesh(Ref<Mesh> p_mesh);
Ref<Mesh> get_mesh() const;
void set_use_all_surfaces(bool p_enabled);
bool is_use_all_surfaces() const;
void set_surface_index(int p_surface_index);
int get_surface_index() const;
Vector<StringName> get_editable_properties() const override;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, String> get_editable_properties_names() const override;
Added `MeshEmitter` node for particles in visual shader
2021-11-05 19:57:24 +00:00
Vector<VisualShader::DefaultTextureParam> get_default_texture_parameters(VisualShader::Type p_type, int p_id) const override;
VisualShaderNodeParticleMeshEmitter();
};
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
class VisualShaderNodeParticleMultiplyByAxisAngle : public VisualShaderNode {
GDCLASS(VisualShaderNodeParticleMultiplyByAxisAngle, VisualShaderNode);
bool degrees_mode = true;
protected:
static void _bind_methods();
public:
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
virtual bool is_show_prop_names() const override;
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
Make port previews in visual shader visible in other shader modes
2021-10-08 19:55:07 +00:00
virtual bool has_output_port_preview(int p_port) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
void set_degrees_mode(bool p_enabled);
bool is_degrees_mode() const;
Vector<StringName> get_editable_properties() const override;
VisualShaderNodeParticleMultiplyByAxisAngle();
};
class VisualShaderNodeParticleConeVelocity : public VisualShaderNode {
GDCLASS(VisualShaderNodeParticleConeVelocity, VisualShaderNode);
public:
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
Make port previews in visual shader visible in other shader modes
2021-10-08 19:55:07 +00:00
virtual bool has_output_port_preview(int p_port) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
VisualShaderNodeParticleConeVelocity();
};
class VisualShaderNodeParticleRandomness : public VisualShaderNode {
GDCLASS(VisualShaderNodeParticleRandomness, VisualShaderNode);
public:
enum OpType {
OP_TYPE_SCALAR,
Add some more fixes to visual shader
2022-02-07 05:46:51 +00:00
OP_TYPE_VECTOR_2D,
OP_TYPE_VECTOR_3D,
Add few improvements for `VisualShaderNodeParticleRandomness`
2023-01-09 17:12:32 +00:00
OP_TYPE_VECTOR_4D,
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
OP_TYPE_MAX,
};
private:
OpType op_type = OP_TYPE_SCALAR;
protected:
static void _bind_methods();
public:
Vector<StringName> get_editable_properties() const override;
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
Add few improvements for `VisualShaderNodeParticleRandomness`
2023-01-09 17:12:32 +00:00
virtual bool is_input_port_default(int p_port, Shader::Mode p_mode) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
Make port previews in visual shader visible in other shader modes
2021-10-08 19:55:07 +00:00
virtual bool has_output_port_preview(int p_port) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
Add few improvements for `VisualShaderNodeParticleRandomness`
2023-01-09 17:12:32 +00:00
virtual String generate_global_per_node(Shader::Mode p_mode, int p_id) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
void set_op_type(OpType p_type);
OpType get_op_type() const;
VisualShaderNodeParticleRandomness();
};
VARIANT_ENUM_CAST(VisualShaderNodeParticleRandomness::OpType)
// Process nodes
Fix incorrect inheritance of `VisualShaderNodeParticleAccelerator`
2021-08-16 11:17:31 +00:00
class VisualShaderNodeParticleAccelerator : public VisualShaderNode {
GDCLASS(VisualShaderNodeParticleAccelerator, VisualShaderNode);
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
public:
enum Mode {
MODE_LINEAR,
MODE_RADIAL,
MODE_TANGENTIAL,
MODE_MAX,
};
private:
Mode mode = MODE_LINEAR;
protected:
static void _bind_methods();
public:
Vector<StringName> get_editable_properties() const override;
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
Make port previews in visual shader visible in other shader modes
2021-10-08 19:55:07 +00:00
virtual bool has_output_port_preview(int p_port) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
void set_mode(Mode p_mode);
Mode get_mode() const;
VisualShaderNodeParticleAccelerator();
};
VARIANT_ENUM_CAST(VisualShaderNodeParticleAccelerator::Mode)
// Common nodes
class VisualShaderNodeParticleOutput : public VisualShaderNodeOutput {
GDCLASS(VisualShaderNodeParticleOutput, VisualShaderNodeOutput);
public:
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
virtual bool is_port_separator(int p_index) const override;
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
VisualShaderNodeParticleOutput();
};
class VisualShaderNodeParticleEmit : public VisualShaderNode {
GDCLASS(VisualShaderNodeParticleEmit, VisualShaderNode);
public:
enum EmitFlags {
EMIT_FLAG_POSITION = 1,
EMIT_FLAG_ROT_SCALE = 2,
EMIT_FLAG_VELOCITY = 4,
EMIT_FLAG_COLOR = 8,
EMIT_FLAG_CUSTOM = 16,
};
protected:
int flags = EMIT_FLAG_POSITION | EMIT_FLAG_ROT_SCALE | EMIT_FLAG_VELOCITY | EMIT_FLAG_COLOR | EMIT_FLAG_CUSTOM;
static void _bind_methods();
public:
Vector<StringName> get_editable_properties() const override;
virtual String get_caption() const override;
virtual int get_input_port_count() const override;
virtual PortType get_input_port_type(int p_port) const override;
virtual String get_input_port_name(int p_port) const override;
virtual int get_output_port_count() const override;
virtual PortType get_output_port_type(int p_port) const override;
virtual String get_output_port_name(int p_port) const override;
void add_flag(EmitFlags p_flag);
bool has_flag(EmitFlags p_flag) const;
void set_flags(EmitFlags p_flags);
EmitFlags get_flags() const;
virtual bool is_show_prop_names() const override;
virtual bool is_generate_input_var(int p_port) const override;
Fix default input port hints for some modes in visual shader
2022-01-22 08:09:16 +00:00
virtual bool is_input_port_default(int p_port, Shader::Mode p_mode) const override;
Continuation of work on visual particles system
2020-09-15 07:57:40 +00:00
virtual String generate_code(Shader::Mode p_mode, VisualShader::Type p_type, int p_id, const String *p_input_vars, const String *p_output_vars, bool p_for_preview = false) const override;
VisualShaderNodeParticleEmit();
};
VARIANT_ENUM_CAST(VisualShaderNodeParticleEmit::EmitFlags)
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // VISUAL_SHADER_PARTICLE_NODES_H