57f52092c3
Restarting particle animation frequently is often done in the VFX tweaking process. This shortcut is available for both GPUParticles and CPUParticles, in 2D and 3D.
430 lines
15 KiB
C++
430 lines
15 KiB
C++
/**************************************************************************/
|
|
/* gpu_particles_2d_editor_plugin.cpp */
|
|
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#include "gpu_particles_2d_editor_plugin.h"
|
|
|
|
#include "canvas_item_editor_plugin.h"
|
|
#include "core/io/image_loader.h"
|
|
#include "editor/editor_node.h"
|
|
#include "editor/editor_settings.h"
|
|
#include "editor/editor_undo_redo_manager.h"
|
|
#include "editor/gui/editor_file_dialog.h"
|
|
#include "editor/scene_tree_dock.h"
|
|
#include "scene/2d/cpu_particles_2d.h"
|
|
#include "scene/gui/menu_button.h"
|
|
#include "scene/gui/separator.h"
|
|
#include "scene/resources/image_texture.h"
|
|
#include "scene/resources/particle_process_material.h"
|
|
|
|
void GPUParticles2DEditorPlugin::edit(Object *p_object) {
|
|
particles = Object::cast_to<GPUParticles2D>(p_object);
|
|
}
|
|
|
|
bool GPUParticles2DEditorPlugin::handles(Object *p_object) const {
|
|
return p_object->is_class("GPUParticles2D");
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::make_visible(bool p_visible) {
|
|
if (p_visible) {
|
|
toolbar->show();
|
|
} else {
|
|
toolbar->hide();
|
|
}
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_file_selected(const String &p_file) {
|
|
source_emission_file = p_file;
|
|
emission_mask->popup_centered();
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_selection_changed() {
|
|
List<Node *> selected_nodes = EditorNode::get_singleton()->get_editor_selection()->get_selected_node_list();
|
|
|
|
if (selected_particles.is_empty() && selected_nodes.is_empty()) {
|
|
return;
|
|
}
|
|
|
|
for (GPUParticles2D *SP : selected_particles) {
|
|
SP->set_show_visibility_rect(false);
|
|
}
|
|
selected_particles.clear();
|
|
|
|
for (Node *P : selected_nodes) {
|
|
GPUParticles2D *selected_particle = Object::cast_to<GPUParticles2D>(P);
|
|
if (selected_particle != nullptr) {
|
|
selected_particle->set_show_visibility_rect(true);
|
|
selected_particles.push_back(selected_particle);
|
|
}
|
|
}
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_menu_callback(int p_idx) {
|
|
switch (p_idx) {
|
|
case MENU_GENERATE_VISIBILITY_RECT: {
|
|
// Add one second to the default generation lifetime, since the progress is updated every second.
|
|
generate_seconds->set_value(MAX(1.0, trunc(particles->get_lifetime()) + 1.0));
|
|
|
|
if (generate_seconds->get_value() >= 11.0 + CMP_EPSILON) {
|
|
// Only pop up the time dialog if the particle's lifetime is long enough to warrant shortening it.
|
|
generate_visibility_rect->popup_centered();
|
|
} else {
|
|
// Generate the visibility rect immediately.
|
|
_generate_visibility_rect();
|
|
}
|
|
} break;
|
|
case MENU_LOAD_EMISSION_MASK: {
|
|
file->popup_file_dialog();
|
|
|
|
} break;
|
|
case MENU_CLEAR_EMISSION_MASK: {
|
|
emission_mask->popup_centered();
|
|
} break;
|
|
case MENU_OPTION_CONVERT_TO_CPU_PARTICLES: {
|
|
CPUParticles2D *cpu_particles = memnew(CPUParticles2D);
|
|
cpu_particles->convert_from_particles(particles);
|
|
cpu_particles->set_name(particles->get_name());
|
|
cpu_particles->set_transform(particles->get_transform());
|
|
cpu_particles->set_visible(particles->is_visible());
|
|
cpu_particles->set_process_mode(particles->get_process_mode());
|
|
cpu_particles->set_z_index(particles->get_z_index());
|
|
|
|
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
|
|
ur->create_action(TTR("Convert to CPUParticles2D"), UndoRedo::MERGE_DISABLE, particles);
|
|
SceneTreeDock::get_singleton()->replace_node(particles, cpu_particles);
|
|
ur->commit_action(false);
|
|
|
|
} break;
|
|
case MENU_RESTART: {
|
|
particles->restart();
|
|
}
|
|
}
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_generate_visibility_rect() {
|
|
double time = generate_seconds->get_value();
|
|
|
|
float running = 0.0;
|
|
|
|
EditorProgress ep("gen_vrect", TTR("Generating Visibility Rect (Waiting for Particle Simulation)"), int(time));
|
|
|
|
bool was_emitting = particles->is_emitting();
|
|
if (!was_emitting) {
|
|
particles->set_emitting(true);
|
|
OS::get_singleton()->delay_usec(1000);
|
|
}
|
|
|
|
Rect2 rect;
|
|
while (running < time) {
|
|
uint64_t ticks = OS::get_singleton()->get_ticks_usec();
|
|
ep.step("Generating...", int(running), true);
|
|
OS::get_singleton()->delay_usec(1000);
|
|
|
|
Rect2 capture = particles->capture_rect();
|
|
if (rect == Rect2()) {
|
|
rect = capture;
|
|
} else {
|
|
rect = rect.merge(capture);
|
|
}
|
|
|
|
running += (OS::get_singleton()->get_ticks_usec() - ticks) / 1000000.0;
|
|
}
|
|
|
|
if (!was_emitting) {
|
|
particles->set_emitting(false);
|
|
}
|
|
|
|
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
|
|
undo_redo->create_action(TTR("Generate Visibility Rect"));
|
|
undo_redo->add_do_method(particles, "set_visibility_rect", rect);
|
|
undo_redo->add_undo_method(particles, "set_visibility_rect", particles->get_visibility_rect());
|
|
undo_redo->commit_action();
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_generate_emission_mask() {
|
|
Ref<ParticleProcessMaterial> pm = particles->get_process_material();
|
|
if (!pm.is_valid()) {
|
|
EditorNode::get_singleton()->show_warning(TTR("Can only set point into a ParticleProcessMaterial process material"));
|
|
return;
|
|
}
|
|
|
|
Ref<Image> img;
|
|
img.instantiate();
|
|
Error err = ImageLoader::load_image(source_emission_file, img);
|
|
ERR_FAIL_COND_MSG(err != OK, "Error loading image '" + source_emission_file + "'.");
|
|
|
|
if (img->is_compressed()) {
|
|
img->decompress();
|
|
}
|
|
img->convert(Image::FORMAT_RGBA8);
|
|
ERR_FAIL_COND(img->get_format() != Image::FORMAT_RGBA8);
|
|
Size2i s = img->get_size();
|
|
ERR_FAIL_COND(s.width == 0 || s.height == 0);
|
|
|
|
Vector<Point2> valid_positions;
|
|
Vector<Point2> valid_normals;
|
|
Vector<uint8_t> valid_colors;
|
|
|
|
valid_positions.resize(s.width * s.height);
|
|
|
|
EmissionMode emode = (EmissionMode)emission_mask_mode->get_selected();
|
|
|
|
if (emode == EMISSION_MODE_BORDER_DIRECTED) {
|
|
valid_normals.resize(s.width * s.height);
|
|
}
|
|
|
|
bool capture_colors = emission_colors->is_pressed();
|
|
|
|
if (capture_colors) {
|
|
valid_colors.resize(s.width * s.height * 4);
|
|
}
|
|
|
|
int vpc = 0;
|
|
|
|
{
|
|
Vector<uint8_t> img_data = img->get_data();
|
|
const uint8_t *r = img_data.ptr();
|
|
|
|
for (int i = 0; i < s.width; i++) {
|
|
for (int j = 0; j < s.height; j++) {
|
|
uint8_t a = r[(j * s.width + i) * 4 + 3];
|
|
|
|
if (a > 128) {
|
|
if (emode == EMISSION_MODE_SOLID) {
|
|
if (capture_colors) {
|
|
valid_colors.write[vpc * 4 + 0] = r[(j * s.width + i) * 4 + 0];
|
|
valid_colors.write[vpc * 4 + 1] = r[(j * s.width + i) * 4 + 1];
|
|
valid_colors.write[vpc * 4 + 2] = r[(j * s.width + i) * 4 + 2];
|
|
valid_colors.write[vpc * 4 + 3] = r[(j * s.width + i) * 4 + 3];
|
|
}
|
|
valid_positions.write[vpc++] = Point2(i, j);
|
|
|
|
} else {
|
|
bool on_border = false;
|
|
for (int x = i - 1; x <= i + 1; x++) {
|
|
for (int y = j - 1; y <= j + 1; y++) {
|
|
if (x < 0 || y < 0 || x >= s.width || y >= s.height || r[(y * s.width + x) * 4 + 3] <= 128) {
|
|
on_border = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (on_border) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (on_border) {
|
|
valid_positions.write[vpc] = Point2(i, j);
|
|
|
|
if (emode == EMISSION_MODE_BORDER_DIRECTED) {
|
|
Vector2 normal;
|
|
for (int x = i - 2; x <= i + 2; x++) {
|
|
for (int y = j - 2; y <= j + 2; y++) {
|
|
if (x == i && y == j) {
|
|
continue;
|
|
}
|
|
|
|
if (x < 0 || y < 0 || x >= s.width || y >= s.height || r[(y * s.width + x) * 4 + 3] <= 128) {
|
|
normal += Vector2(x - i, y - j).normalized();
|
|
}
|
|
}
|
|
}
|
|
|
|
normal.normalize();
|
|
valid_normals.write[vpc] = normal;
|
|
}
|
|
|
|
if (capture_colors) {
|
|
valid_colors.write[vpc * 4 + 0] = r[(j * s.width + i) * 4 + 0];
|
|
valid_colors.write[vpc * 4 + 1] = r[(j * s.width + i) * 4 + 1];
|
|
valid_colors.write[vpc * 4 + 2] = r[(j * s.width + i) * 4 + 2];
|
|
valid_colors.write[vpc * 4 + 3] = r[(j * s.width + i) * 4 + 3];
|
|
}
|
|
|
|
vpc++;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
valid_positions.resize(vpc);
|
|
if (valid_normals.size()) {
|
|
valid_normals.resize(vpc);
|
|
}
|
|
|
|
ERR_FAIL_COND_MSG(valid_positions.is_empty(), "No pixels with transparency > 128 in image...");
|
|
|
|
Vector<uint8_t> texdata;
|
|
|
|
int w = 2048;
|
|
int h = (vpc / 2048) + 1;
|
|
|
|
texdata.resize(w * h * 2 * sizeof(float));
|
|
|
|
{
|
|
Vector2 offset;
|
|
if (emission_mask_centered->is_pressed()) {
|
|
offset = Vector2(-s.width * 0.5, -s.height * 0.5);
|
|
}
|
|
|
|
uint8_t *tw = texdata.ptrw();
|
|
float *twf = reinterpret_cast<float *>(tw);
|
|
for (int i = 0; i < vpc; i++) {
|
|
twf[i * 2 + 0] = valid_positions[i].x + offset.x;
|
|
twf[i * 2 + 1] = valid_positions[i].y + offset.y;
|
|
}
|
|
}
|
|
|
|
img.instantiate();
|
|
img->set_data(w, h, false, Image::FORMAT_RGF, texdata);
|
|
pm->set_emission_point_texture(ImageTexture::create_from_image(img));
|
|
pm->set_emission_point_count(vpc);
|
|
|
|
if (capture_colors) {
|
|
Vector<uint8_t> colordata;
|
|
colordata.resize(w * h * 4); //use RG texture
|
|
|
|
{
|
|
uint8_t *tw = colordata.ptrw();
|
|
for (int i = 0; i < vpc * 4; i++) {
|
|
tw[i] = valid_colors[i];
|
|
}
|
|
}
|
|
|
|
img.instantiate();
|
|
img->set_data(w, h, false, Image::FORMAT_RGBA8, colordata);
|
|
pm->set_emission_color_texture(ImageTexture::create_from_image(img));
|
|
}
|
|
|
|
if (valid_normals.size()) {
|
|
pm->set_emission_shape(ParticleProcessMaterial::EMISSION_SHAPE_DIRECTED_POINTS);
|
|
|
|
Vector<uint8_t> normdata;
|
|
normdata.resize(w * h * 2 * sizeof(float)); //use RG texture
|
|
|
|
{
|
|
uint8_t *tw = normdata.ptrw();
|
|
float *twf = reinterpret_cast<float *>(tw);
|
|
for (int i = 0; i < vpc; i++) {
|
|
twf[i * 2 + 0] = valid_normals[i].x;
|
|
twf[i * 2 + 1] = valid_normals[i].y;
|
|
}
|
|
}
|
|
|
|
img.instantiate();
|
|
img->set_data(w, h, false, Image::FORMAT_RGF, normdata);
|
|
pm->set_emission_normal_texture(ImageTexture::create_from_image(img));
|
|
|
|
} else {
|
|
pm->set_emission_shape(ParticleProcessMaterial::EMISSION_SHAPE_POINTS);
|
|
}
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_ENTER_TREE: {
|
|
menu->get_popup()->connect("id_pressed", callable_mp(this, &GPUParticles2DEditorPlugin::_menu_callback));
|
|
menu->set_icon(menu->get_editor_theme_icon(SNAME("GPUParticles2D")));
|
|
file->connect("file_selected", callable_mp(this, &GPUParticles2DEditorPlugin::_file_selected));
|
|
EditorNode::get_singleton()->get_editor_selection()->connect("selection_changed", callable_mp(this, &GPUParticles2DEditorPlugin::_selection_changed));
|
|
} break;
|
|
}
|
|
}
|
|
|
|
void GPUParticles2DEditorPlugin::_bind_methods() {
|
|
}
|
|
|
|
GPUParticles2DEditorPlugin::GPUParticles2DEditorPlugin() {
|
|
particles = nullptr;
|
|
|
|
toolbar = memnew(HBoxContainer);
|
|
add_control_to_container(CONTAINER_CANVAS_EDITOR_MENU, toolbar);
|
|
toolbar->hide();
|
|
|
|
menu = memnew(MenuButton);
|
|
menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("particles/restart_emission"), MENU_RESTART);
|
|
menu->get_popup()->add_item(TTR("Generate Visibility Rect"), MENU_GENERATE_VISIBILITY_RECT);
|
|
menu->get_popup()->add_item(TTR("Load Emission Mask"), MENU_LOAD_EMISSION_MASK);
|
|
// menu->get_popup()->add_item(TTR("Clear Emission Mask"), MENU_CLEAR_EMISSION_MASK);
|
|
menu->get_popup()->add_item(TTR("Convert to CPUParticles2D"), MENU_OPTION_CONVERT_TO_CPU_PARTICLES);
|
|
menu->set_text(TTR("GPUParticles2D"));
|
|
menu->set_switch_on_hover(true);
|
|
toolbar->add_child(menu);
|
|
|
|
file = memnew(EditorFileDialog);
|
|
List<String> ext;
|
|
ImageLoader::get_recognized_extensions(&ext);
|
|
for (const String &E : ext) {
|
|
file->add_filter("*." + E, E.to_upper());
|
|
}
|
|
file->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
|
|
toolbar->add_child(file);
|
|
|
|
generate_visibility_rect = memnew(ConfirmationDialog);
|
|
generate_visibility_rect->set_title(TTR("Generate Visibility Rect"));
|
|
VBoxContainer *genvb = memnew(VBoxContainer);
|
|
generate_visibility_rect->add_child(genvb);
|
|
generate_seconds = memnew(SpinBox);
|
|
genvb->add_margin_child(TTR("Generation Time (sec):"), generate_seconds);
|
|
generate_seconds->set_min(0.1);
|
|
generate_seconds->set_max(25);
|
|
generate_seconds->set_value(2);
|
|
|
|
toolbar->add_child(generate_visibility_rect);
|
|
|
|
generate_visibility_rect->connect("confirmed", callable_mp(this, &GPUParticles2DEditorPlugin::_generate_visibility_rect));
|
|
|
|
emission_mask = memnew(ConfirmationDialog);
|
|
emission_mask->set_title(TTR("Load Emission Mask"));
|
|
VBoxContainer *emvb = memnew(VBoxContainer);
|
|
emission_mask->add_child(emvb);
|
|
emission_mask_mode = memnew(OptionButton);
|
|
emvb->add_margin_child(TTR("Emission Mask"), emission_mask_mode);
|
|
emission_mask_mode->add_item(TTR("Solid Pixels"), EMISSION_MODE_SOLID);
|
|
emission_mask_mode->add_item(TTR("Border Pixels"), EMISSION_MODE_BORDER);
|
|
emission_mask_mode->add_item(TTR("Directed Border Pixels"), EMISSION_MODE_BORDER_DIRECTED);
|
|
VBoxContainer *optionsvb = memnew(VBoxContainer);
|
|
emvb->add_margin_child(TTR("Options"), optionsvb);
|
|
emission_mask_centered = memnew(CheckBox);
|
|
emission_mask_centered->set_text(TTR("Centered"));
|
|
optionsvb->add_child(emission_mask_centered);
|
|
emission_colors = memnew(CheckBox);
|
|
emission_colors->set_text(TTR("Capture Colors from Pixel"));
|
|
optionsvb->add_child(emission_colors);
|
|
|
|
toolbar->add_child(emission_mask);
|
|
|
|
emission_mask->connect("confirmed", callable_mp(this, &GPUParticles2DEditorPlugin::_generate_emission_mask));
|
|
}
|
|
|
|
GPUParticles2DEditorPlugin::~GPUParticles2DEditorPlugin() {
|
|
}
|