Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/editor/scene/3d/skeleton_3d_editor_plugin.cpp
9903 views
1
/**************************************************************************/
2
/* skeleton_3d_editor_plugin.cpp */
3
/**************************************************************************/
4
/* This file is part of: */
5
/* GODOT ENGINE */
6
/* https://godotengine.org */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10
/* */
11
/* Permission is hereby granted, free of charge, to any person obtaining */
12
/* a copy of this software and associated documentation files (the */
13
/* "Software"), to deal in the Software without restriction, including */
14
/* without limitation the rights to use, copy, modify, merge, publish, */
15
/* distribute, sublicense, and/or sell copies of the Software, and to */
16
/* permit persons to whom the Software is furnished to do so, subject to */
17
/* the following conditions: */
18
/* */
19
/* The above copyright notice and this permission notice shall be */
20
/* included in all copies or substantial portions of the Software. */
21
/* */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29
/**************************************************************************/
30
31
#include "skeleton_3d_editor_plugin.h"
32
33
#include "core/io/resource_saver.h"
34
#include "editor/animation/animation_player_editor_plugin.h"
35
#include "editor/editor_node.h"
36
#include "editor/editor_string_names.h"
37
#include "editor/editor_undo_redo_manager.h"
38
#include "editor/inspector/editor_properties.h"
39
#include "editor/inspector/editor_properties_vector.h"
40
#include "editor/scene/3d/node_3d_editor_plugin.h"
41
#include "editor/settings/editor_settings.h"
42
#include "editor/themes/editor_scale.h"
43
#include "scene/3d/mesh_instance_3d.h"
44
#include "scene/3d/physics/collision_shape_3d.h"
45
#include "scene/3d/physics/physical_bone_3d.h"
46
#include "scene/3d/physics/physical_bone_simulator_3d.h"
47
#include "scene/gui/separator.h"
48
#include "scene/gui/texture_rect.h"
49
#include "scene/resources/3d/capsule_shape_3d.h"
50
#include "scene/resources/skeleton_profile.h"
51
#include "scene/resources/surface_tool.h"
52
53
void BonePropertiesEditor::create_editors() {
54
section = memnew(EditorInspectorSection);
55
section->setup("trf_properties", label, this, Color(0.0f, 0.0f, 0.0f), true);
56
section->unfold();
57
add_child(section);
58
59
enabled_checkbox = memnew(EditorPropertyCheck());
60
enabled_checkbox->set_label("Pose Enabled");
61
enabled_checkbox->set_selectable(false);
62
enabled_checkbox->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
63
section->get_vbox()->add_child(enabled_checkbox);
64
65
// Position property.
66
position_property = memnew(EditorPropertyVector3());
67
position_property->setup(-10000, 10000, 0.001, true);
68
position_property->set_label("Position");
69
position_property->set_selectable(false);
70
position_property->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
71
position_property->connect("property_keyed", callable_mp(this, &BonePropertiesEditor::_property_keyed));
72
section->get_vbox()->add_child(position_property);
73
74
// Rotation property.
75
rotation_property = memnew(EditorPropertyQuaternion());
76
rotation_property->setup(-10000, 10000, 0.001, true);
77
rotation_property->set_label("Rotation");
78
rotation_property->set_selectable(false);
79
rotation_property->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
80
rotation_property->connect("property_keyed", callable_mp(this, &BonePropertiesEditor::_property_keyed));
81
section->get_vbox()->add_child(rotation_property);
82
83
// Scale property.
84
scale_property = memnew(EditorPropertyVector3());
85
scale_property->setup(-10000, 10000, 0.001, true, true);
86
scale_property->set_label("Scale");
87
scale_property->set_selectable(false);
88
scale_property->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_value_changed));
89
scale_property->connect("property_keyed", callable_mp(this, &BonePropertiesEditor::_property_keyed));
90
section->get_vbox()->add_child(scale_property);
91
92
// Transform/Matrix section.
93
rest_section = memnew(EditorInspectorSection);
94
rest_section->setup("trf_properties_transform", "Rest", this, Color(0.0f, 0.0f, 0.0f), true);
95
section->get_vbox()->add_child(rest_section);
96
97
// Transform/Matrix property.
98
rest_matrix = memnew(EditorPropertyTransform3D());
99
rest_matrix->setup(-10000, 10000, 0.001, true);
100
rest_matrix->set_label("Transform");
101
rest_matrix->set_selectable(false);
102
rest_section->get_vbox()->add_child(rest_matrix);
103
104
// Bone Metadata property
105
meta_section = memnew(EditorInspectorSection);
106
meta_section->setup("bone_meta", TTR("Bone Metadata"), this, Color(.0f, .0f, .0f), true);
107
section->get_vbox()->add_child(meta_section);
108
109
EditorInspectorActionButton *add_metadata_button = memnew(EditorInspectorActionButton(TTRC("Add Bone Metadata"), SNAME("Add")));
110
add_metadata_button->connect(SceneStringName(pressed), callable_mp(this, &BonePropertiesEditor::_show_add_meta_dialog));
111
section->get_vbox()->add_child(add_metadata_button);
112
113
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
114
undo_redo->connect("version_changed", callable_mp(this, &BonePropertiesEditor::_update_properties));
115
undo_redo->connect("history_changed", callable_mp(this, &BonePropertiesEditor::_update_properties));
116
}
117
118
void BonePropertiesEditor::_notification(int p_what) {
119
switch (p_what) {
120
case NOTIFICATION_THEME_CHANGED: {
121
const Color section_color = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor));
122
section->set_bg_color(section_color);
123
rest_section->set_bg_color(section_color);
124
} break;
125
}
126
}
127
128
void BonePropertiesEditor::_value_changed(const String &p_property, const Variant &p_value, const String &p_name, bool p_changing) {
129
if (updating || !skeleton) {
130
return;
131
}
132
133
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
134
undo_redo->create_action(TTR("Set Bone Transform"), UndoRedo::MERGE_ENDS);
135
undo_redo->add_undo_property(skeleton, p_property, skeleton->get(p_property));
136
undo_redo->add_do_property(skeleton, p_property, p_value);
137
138
Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
139
if (se) {
140
undo_redo->add_do_method(se, "update_joint_tree");
141
undo_redo->add_undo_method(se, "update_joint_tree");
142
}
143
144
undo_redo->commit_action();
145
}
146
147
void BonePropertiesEditor::_meta_changed(const String &p_property, const Variant &p_value, const String &p_name, bool p_changing) {
148
if (!skeleton || p_property.get_slicec('/', 2) != "bone_meta") {
149
return;
150
}
151
152
int bone = p_property.get_slicec('/', 1).to_int();
153
if (bone >= skeleton->get_bone_count()) {
154
return;
155
}
156
157
String key = p_property.get_slicec('/', 3);
158
if (!skeleton->has_bone_meta(bone, key)) {
159
return;
160
}
161
162
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
163
undo_redo->create_action(vformat(TTR("Modify metadata '%s' for bone '%s'"), key, skeleton->get_bone_name(bone)));
164
undo_redo->add_do_property(skeleton, p_property, p_value);
165
undo_redo->add_do_method(meta_editors[p_property], "update_property");
166
undo_redo->add_undo_property(skeleton, p_property, skeleton->get_bone_meta(bone, key));
167
undo_redo->add_undo_method(meta_editors[p_property], "update_property");
168
undo_redo->commit_action();
169
}
170
171
void BonePropertiesEditor::_meta_deleted(const String &p_property) {
172
if (!skeleton || p_property.get_slicec('/', 2) != "bone_meta") {
173
return;
174
}
175
176
int bone = p_property.get_slicec('/', 1).to_int();
177
if (bone >= skeleton->get_bone_count()) {
178
return;
179
}
180
181
String key = p_property.get_slicec('/', 3);
182
if (!skeleton->has_bone_meta(bone, key)) {
183
return;
184
}
185
186
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
187
undo_redo->create_action(vformat(TTR("Remove metadata '%s' from bone '%s'"), key, skeleton->get_bone_name(bone)));
188
undo_redo->add_do_property(skeleton, p_property, Variant());
189
undo_redo->add_undo_property(skeleton, p_property, skeleton->get_bone_meta(bone, key));
190
undo_redo->commit_action();
191
192
emit_signal(SNAME("property_deleted"), p_property);
193
}
194
195
void BonePropertiesEditor::_show_add_meta_dialog() {
196
if (!add_meta_dialog) {
197
add_meta_dialog = memnew(AddMetadataDialog());
198
add_meta_dialog->connect(SceneStringName(confirmed), callable_mp(this, &BonePropertiesEditor::_add_meta_confirm));
199
add_child(add_meta_dialog);
200
}
201
202
int bone = Skeleton3DEditor::get_singleton()->get_selected_bone();
203
StringName dialog_title = skeleton->get_bone_name(bone);
204
205
List<StringName> existing_meta_keys;
206
skeleton->get_bone_meta_list(bone, &existing_meta_keys);
207
add_meta_dialog->open(dialog_title, existing_meta_keys);
208
}
209
210
void BonePropertiesEditor::_add_meta_confirm() {
211
int bone = Skeleton3DEditor::get_singleton()->get_selected_bone();
212
String name = add_meta_dialog->get_meta_name();
213
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
214
undo_redo->create_action(vformat(TTR("Add metadata '%s' to bone '%s'"), name, skeleton->get_bone_name(bone)));
215
undo_redo->add_do_method(skeleton, "set_bone_meta", bone, name, add_meta_dialog->get_meta_defval());
216
undo_redo->add_undo_method(skeleton, "set_bone_meta", bone, name, Variant());
217
undo_redo->commit_action();
218
}
219
220
BonePropertiesEditor::BonePropertiesEditor(Skeleton3D *p_skeleton) :
221
skeleton(p_skeleton) {
222
create_editors();
223
}
224
225
void BonePropertiesEditor::set_keyable(const bool p_keyable) {
226
position_property->set_keying(p_keyable);
227
rotation_property->set_keying(p_keyable);
228
scale_property->set_keying(p_keyable);
229
}
230
231
void BonePropertiesEditor::set_target(const String &p_prop) {
232
enabled_checkbox->set_object_and_property(skeleton, p_prop + "enabled");
233
enabled_checkbox->update_property();
234
235
position_property->set_object_and_property(skeleton, p_prop + "position");
236
position_property->update_property();
237
238
rotation_property->set_object_and_property(skeleton, p_prop + "rotation");
239
rotation_property->update_property();
240
241
scale_property->set_object_and_property(skeleton, p_prop + "scale");
242
scale_property->update_property();
243
244
rest_matrix->set_object_and_property(skeleton, p_prop + "rest");
245
rest_matrix->update_property();
246
}
247
248
void BonePropertiesEditor::_property_keyed(const String &p_path, bool p_advance) {
249
AnimationTrackEditor *te = AnimationPlayerEditor::get_singleton()->get_track_editor();
250
if (!te || !te->has_keying()) {
251
return;
252
}
253
te->_clear_selection();
254
PackedStringArray split = p_path.split("/");
255
if (split.size() == 3 && split[0] == "bones") {
256
int bone_idx = split[1].to_int();
257
if (split[2] == "position") {
258
te->insert_transform_key(skeleton, skeleton->get_bone_name(bone_idx), Animation::TYPE_POSITION_3D, (Vector3)skeleton->get(p_path) / skeleton->get_motion_scale());
259
}
260
if (split[2] == "rotation") {
261
te->insert_transform_key(skeleton, skeleton->get_bone_name(bone_idx), Animation::TYPE_ROTATION_3D, skeleton->get(p_path));
262
}
263
if (split[2] == "scale") {
264
te->insert_transform_key(skeleton, skeleton->get_bone_name(bone_idx), Animation::TYPE_SCALE_3D, skeleton->get(p_path));
265
}
266
}
267
}
268
269
void BonePropertiesEditor::_update_properties() {
270
if (!skeleton) {
271
return;
272
}
273
int selected = Skeleton3DEditor::get_singleton()->get_selected_bone();
274
List<PropertyInfo> props;
275
HashSet<StringName> meta_seen;
276
skeleton->get_property_list(&props);
277
for (const PropertyInfo &E : props) {
278
PackedStringArray split = E.name.split("/");
279
if (split.size() >= 3 && split[0] == "bones") {
280
if (split[1].to_int() == selected) {
281
if (split[2] == "enabled") {
282
enabled_checkbox->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
283
enabled_checkbox->update_property();
284
enabled_checkbox->update_editor_property_status();
285
enabled_checkbox->queue_redraw();
286
}
287
if (split[2] == "position") {
288
position_property->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
289
position_property->update_property();
290
position_property->update_editor_property_status();
291
position_property->queue_redraw();
292
}
293
if (split[2] == "rotation") {
294
rotation_property->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
295
rotation_property->update_property();
296
rotation_property->update_editor_property_status();
297
rotation_property->queue_redraw();
298
}
299
if (split[2] == "scale") {
300
scale_property->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
301
scale_property->update_property();
302
scale_property->update_editor_property_status();
303
scale_property->queue_redraw();
304
}
305
if (split[2] == "rest") {
306
rest_matrix->set_read_only(E.usage & PROPERTY_USAGE_READ_ONLY);
307
rest_matrix->update_property();
308
rest_matrix->update_editor_property_status();
309
rest_matrix->queue_redraw();
310
}
311
if (split[2] == "bone_meta") {
312
meta_seen.insert(E.name);
313
if (!meta_editors.find(E.name)) {
314
EditorProperty *editor = EditorInspectorDefaultPlugin::get_editor_for_property(skeleton, E.type, E.name, PROPERTY_HINT_NONE, "", E.usage);
315
editor->set_label(split[3]);
316
editor->set_object_and_property(skeleton, E.name);
317
editor->set_deletable(true);
318
editor->set_selectable(false);
319
editor->connect("property_changed", callable_mp(this, &BonePropertiesEditor::_meta_changed));
320
editor->connect("property_deleted", callable_mp(this, &BonePropertiesEditor::_meta_deleted));
321
322
meta_section->get_vbox()->add_child(editor);
323
editor->update_property();
324
editor->update_editor_property_status();
325
editor->queue_redraw();
326
327
meta_editors[E.name] = editor;
328
}
329
}
330
}
331
}
332
}
333
// UI for any bone metadata prop not seen during the iteration has to be deleted
334
for (KeyValue<StringName, EditorProperty *> iter : meta_editors) {
335
if (!meta_seen.has(iter.key)) {
336
callable_mp((Node *)meta_section->get_vbox(), &Node::remove_child).call_deferred(iter.value);
337
meta_editors.remove(meta_editors.find(iter.key));
338
}
339
}
340
}
341
342
Skeleton3DEditor *Skeleton3DEditor::singleton = nullptr;
343
344
void Skeleton3DEditor::set_keyable(const bool p_keyable) {
345
keyable = p_keyable;
346
if (p_keyable) {
347
animation_hb->show();
348
} else {
349
animation_hb->hide();
350
}
351
}
352
353
void Skeleton3DEditor::set_bone_options_enabled(const bool p_bone_options_enabled) {
354
skeleton_options->get_popup()->set_item_disabled(SKELETON_OPTION_RESET_SELECTED_POSES, !p_bone_options_enabled);
355
skeleton_options->get_popup()->set_item_disabled(SKELETON_OPTION_SELECTED_POSES_TO_RESTS, !p_bone_options_enabled);
356
}
357
358
void Skeleton3DEditor::_bind_methods() {
359
ClassDB::bind_method(D_METHOD("update_all"), &Skeleton3DEditor::update_all);
360
ClassDB::bind_method(D_METHOD("update_joint_tree"), &Skeleton3DEditor::update_joint_tree);
361
}
362
363
void Skeleton3DEditor::_on_click_skeleton_option(int p_skeleton_option) {
364
if (!skeleton) {
365
return;
366
}
367
368
switch (p_skeleton_option) {
369
case SKELETON_OPTION_RESET_ALL_POSES: {
370
reset_pose(true);
371
break;
372
}
373
case SKELETON_OPTION_RESET_SELECTED_POSES: {
374
reset_pose(false);
375
break;
376
}
377
case SKELETON_OPTION_ALL_POSES_TO_RESTS: {
378
pose_to_rest(true);
379
break;
380
}
381
case SKELETON_OPTION_SELECTED_POSES_TO_RESTS: {
382
pose_to_rest(false);
383
break;
384
}
385
case SKELETON_OPTION_CREATE_PHYSICAL_SKELETON: {
386
create_physical_skeleton();
387
break;
388
}
389
case SKELETON_OPTION_EXPORT_SKELETON_PROFILE: {
390
export_skeleton_profile();
391
break;
392
}
393
}
394
}
395
396
void Skeleton3DEditor::reset_pose(const bool p_all_bones) {
397
if (!skeleton) {
398
return;
399
}
400
const int bone_count = skeleton->get_bone_count();
401
if (!bone_count) {
402
return;
403
}
404
405
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
406
ur->create_action(TTR("Set Bone Transform"), UndoRedo::MERGE_ENDS);
407
if (p_all_bones) {
408
for (int i = 0; i < bone_count; i++) {
409
ur->add_undo_method(skeleton, "set_bone_pose_position", i, skeleton->get_bone_pose_position(i));
410
ur->add_undo_method(skeleton, "set_bone_pose_rotation", i, skeleton->get_bone_pose_rotation(i));
411
ur->add_undo_method(skeleton, "set_bone_pose_scale", i, skeleton->get_bone_pose_scale(i));
412
}
413
ur->add_do_method(skeleton, "reset_bone_poses");
414
} else {
415
// Todo: Do method with multiple bone selection.
416
if (selected_bone == -1) {
417
ur->commit_action();
418
return;
419
}
420
ur->add_undo_method(skeleton, "set_bone_pose_position", selected_bone, skeleton->get_bone_pose_position(selected_bone));
421
ur->add_undo_method(skeleton, "set_bone_pose_rotation", selected_bone, skeleton->get_bone_pose_rotation(selected_bone));
422
ur->add_undo_method(skeleton, "set_bone_pose_scale", selected_bone, skeleton->get_bone_pose_scale(selected_bone));
423
ur->add_do_method(skeleton, "reset_bone_pose", selected_bone);
424
}
425
426
ur->add_undo_method(this, "update_joint_tree");
427
ur->add_do_method(this, "update_joint_tree");
428
429
ur->commit_action();
430
}
431
432
void Skeleton3DEditor::insert_keys(const bool p_all_bones) {
433
if (!skeleton) {
434
return;
435
}
436
437
bool pos_enabled = key_loc_button->is_pressed();
438
bool rot_enabled = key_rot_button->is_pressed();
439
bool scl_enabled = key_scale_button->is_pressed();
440
441
int bone_len = skeleton->get_bone_count();
442
Node *root = EditorNode::get_singleton()->get_tree()->get_root();
443
String path = String(root->get_path_to(skeleton));
444
445
AnimationTrackEditor *te = AnimationPlayerEditor::get_singleton()->get_track_editor();
446
te->make_insert_queue();
447
for (int i = 0; i < bone_len; i++) {
448
const String name = skeleton->get_bone_name(i);
449
450
if (name.is_empty()) {
451
continue;
452
}
453
454
if (pos_enabled && (p_all_bones || te->has_track(skeleton, name, Animation::TYPE_POSITION_3D))) {
455
te->insert_transform_key(skeleton, name, Animation::TYPE_POSITION_3D, skeleton->get_bone_pose_position(i) / skeleton->get_motion_scale());
456
}
457
if (rot_enabled && (p_all_bones || te->has_track(skeleton, name, Animation::TYPE_ROTATION_3D))) {
458
te->insert_transform_key(skeleton, name, Animation::TYPE_ROTATION_3D, skeleton->get_bone_pose_rotation(i));
459
}
460
if (scl_enabled && (p_all_bones || te->has_track(skeleton, name, Animation::TYPE_SCALE_3D))) {
461
te->insert_transform_key(skeleton, name, Animation::TYPE_SCALE_3D, skeleton->get_bone_pose_scale(i));
462
}
463
}
464
te->commit_insert_queue();
465
}
466
467
void Skeleton3DEditor::pose_to_rest(const bool p_all_bones) {
468
if (!skeleton) {
469
return;
470
}
471
const int bone_count = skeleton->get_bone_count();
472
if (!bone_count) {
473
return;
474
}
475
476
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
477
ur->create_action(TTR("Set Bone Rest"), UndoRedo::MERGE_ENDS);
478
if (p_all_bones) {
479
for (int i = 0; i < bone_count; i++) {
480
ur->add_do_method(skeleton, "set_bone_rest", i, skeleton->get_bone_pose(i));
481
ur->add_undo_method(skeleton, "set_bone_rest", i, skeleton->get_bone_rest(i));
482
}
483
} else {
484
// Todo: Do method with multiple bone selection.
485
if (selected_bone == -1) {
486
ur->commit_action();
487
return;
488
}
489
ur->add_do_method(skeleton, "set_bone_rest", selected_bone, skeleton->get_bone_pose(selected_bone));
490
ur->add_undo_method(skeleton, "set_bone_rest", selected_bone, skeleton->get_bone_rest(selected_bone));
491
}
492
493
ur->add_undo_method(this, "update_joint_tree");
494
ur->add_do_method(this, "update_joint_tree");
495
496
ur->commit_action();
497
}
498
499
void Skeleton3DEditor::create_physical_skeleton() {
500
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
501
ERR_FAIL_NULL(get_tree());
502
Node *owner = get_tree()->get_edited_scene_root();
503
504
const int bone_count = skeleton->get_bone_count();
505
506
if (!bone_count) {
507
EditorNode::get_singleton()->show_warning(vformat(TTR("Cannot create a physical skeleton for a Skeleton3D node with no bones.")));
508
return;
509
}
510
511
Vector<BoneInfo> bones_infos;
512
bones_infos.resize(bone_count);
513
514
ur->create_action(TTR("Create physical bones"), UndoRedo::MERGE_ALL);
515
516
PhysicalBoneSimulator3D *simulator = memnew(PhysicalBoneSimulator3D);
517
ur->add_do_method(skeleton, "add_child", simulator);
518
ur->add_do_method(simulator, "set_owner", owner);
519
ur->add_do_method(simulator, "set_name", "PhysicalBoneSimulator3D");
520
for (int bone_id = 0; bone_count > bone_id; ++bone_id) {
521
const int parent = skeleton->get_bone_parent(bone_id);
522
523
if (parent < 0) {
524
bones_infos.write[bone_id].relative_rest = skeleton->get_bone_rest(bone_id);
525
} else {
526
const int parent_parent = skeleton->get_bone_parent(parent);
527
528
bones_infos.write[bone_id].relative_rest = bones_infos[parent].relative_rest * skeleton->get_bone_rest(bone_id);
529
530
// Create physical bone on parent.
531
if (!bones_infos[parent].physical_bone) {
532
PhysicalBone3D *physical_bone = create_physical_bone(parent, bone_id, bones_infos);
533
if (physical_bone && physical_bone->get_child(0)) {
534
CollisionShape3D *collision_shape = Object::cast_to<CollisionShape3D>(physical_bone->get_child(0));
535
if (collision_shape) {
536
bones_infos.write[parent].physical_bone = physical_bone;
537
538
ur->add_do_method(simulator, "add_child", physical_bone);
539
ur->add_do_method(physical_bone, "set_owner", owner);
540
ur->add_do_method(collision_shape, "set_owner", owner);
541
ur->add_do_property(physical_bone, "bone_name", skeleton->get_bone_name(parent));
542
543
// Create joint between parent of parent.
544
if (parent_parent != -1) {
545
ur->add_do_method(physical_bone, "set_joint_type", PhysicalBone3D::JOINT_TYPE_PIN);
546
}
547
548
ur->add_do_method(Node3DEditor::get_singleton(), SceneStringName(_request_gizmo), physical_bone);
549
ur->add_do_method(Node3DEditor::get_singleton(), SceneStringName(_request_gizmo), collision_shape);
550
551
ur->add_do_reference(physical_bone);
552
ur->add_undo_method(simulator, "remove_child", physical_bone);
553
}
554
}
555
}
556
}
557
}
558
ur->add_undo_method(skeleton, "remove_child", simulator);
559
ur->commit_action();
560
}
561
562
PhysicalBone3D *Skeleton3DEditor::create_physical_bone(int bone_id, int bone_child_id, const Vector<BoneInfo> &bones_infos) {
563
const Transform3D child_rest = skeleton->get_bone_rest(bone_child_id);
564
565
const real_t half_height(child_rest.origin.length() * 0.5);
566
const real_t radius(half_height * 0.2);
567
568
CapsuleShape3D *bone_shape_capsule = memnew(CapsuleShape3D);
569
bone_shape_capsule->set_height(half_height * 2);
570
bone_shape_capsule->set_radius(radius);
571
572
CollisionShape3D *bone_shape = memnew(CollisionShape3D);
573
bone_shape->set_shape(bone_shape_capsule);
574
bone_shape->set_name("CollisionShape3D");
575
576
Transform3D capsule_transform;
577
capsule_transform.basis.rows[0] = Vector3(1, 0, 0);
578
capsule_transform.basis.rows[1] = Vector3(0, 0, 1);
579
capsule_transform.basis.rows[2] = Vector3(0, -1, 0);
580
bone_shape->set_transform(capsule_transform);
581
582
/// Get an up vector not collinear with child rest origin
583
Vector3 up = Vector3(0, 1, 0);
584
if (up.cross(child_rest.origin).is_zero_approx()) {
585
up = Vector3(0, 0, 1);
586
}
587
588
Transform3D body_transform;
589
body_transform.basis = Basis::looking_at(child_rest.origin, up);
590
body_transform.origin = body_transform.basis.xform(Vector3(0, 0, -half_height));
591
592
Transform3D joint_transform;
593
joint_transform.origin = Vector3(0, 0, half_height);
594
595
PhysicalBone3D *physical_bone = memnew(PhysicalBone3D);
596
physical_bone->add_child(bone_shape);
597
physical_bone->set_name("Physical Bone " + skeleton->get_bone_name(bone_id));
598
physical_bone->set_body_offset(body_transform);
599
physical_bone->set_joint_offset(joint_transform);
600
return physical_bone;
601
}
602
603
void Skeleton3DEditor::export_skeleton_profile() {
604
if (!skeleton->get_bone_count()) {
605
EditorNode::get_singleton()->show_warning(vformat(TTR("Cannot export a SkeletonProfile for a Skeleton3D node with no bones.")));
606
return;
607
}
608
609
file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
610
file_dialog->set_title(TTR("Export Skeleton Profile As..."));
611
612
List<String> exts;
613
ResourceLoader::get_recognized_extensions_for_type("SkeletonProfile", &exts);
614
file_dialog->clear_filters();
615
for (const String &K : exts) {
616
file_dialog->add_filter("*." + K);
617
}
618
619
file_dialog->popup_file_dialog();
620
}
621
622
void Skeleton3DEditor::_file_selected(const String &p_file) {
623
// Export SkeletonProfile.
624
Ref<SkeletonProfile> sp(memnew(SkeletonProfile));
625
626
// Build SkeletonProfile.
627
sp->set_group_size(1);
628
629
Vector<Vector2> handle_positions;
630
Vector2 position_max;
631
Vector2 position_min;
632
633
const int bone_count = skeleton->get_bone_count();
634
sp->set_bone_size(bone_count);
635
for (int i = 0; i < bone_count; i++) {
636
sp->set_bone_name(i, skeleton->get_bone_name(i));
637
int parent = skeleton->get_bone_parent(i);
638
if (parent >= 0) {
639
sp->set_bone_parent(i, skeleton->get_bone_name(parent));
640
}
641
sp->set_reference_pose(i, skeleton->get_bone_rest(i));
642
643
Transform3D grest = skeleton->get_bone_global_rest(i);
644
handle_positions.append(Vector2(grest.origin.x, grest.origin.y));
645
if (i == 0) {
646
position_max = Vector2(grest.origin.x, grest.origin.y);
647
position_min = Vector2(grest.origin.x, grest.origin.y);
648
} else {
649
position_max = position_max.max(Vector2(grest.origin.x, grest.origin.y));
650
position_min = position_min.min(Vector2(grest.origin.x, grest.origin.y));
651
}
652
}
653
654
// Layout handles provisionaly.
655
Vector2 bound = Vector2(position_max.x - position_min.x, position_max.y - position_min.y);
656
Vector2 center = Vector2((position_max.x + position_min.x) * 0.5, (position_max.y + position_min.y) * 0.5);
657
float nrm = MAX(bound.x, bound.y);
658
if (nrm > 0) {
659
for (int i = 0; i < bone_count; i++) {
660
handle_positions.write[i] = (handle_positions[i] - center) / nrm * 0.9;
661
sp->set_handle_offset(i, Vector2(0.5 + handle_positions[i].x, 0.5 - handle_positions[i].y));
662
}
663
}
664
665
Error err = ResourceSaver::save(sp, p_file);
666
667
if (err != OK) {
668
EditorNode::get_singleton()->show_warning(vformat(TTR("Error saving file: %s"), p_file));
669
return;
670
}
671
}
672
673
Variant Skeleton3DEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
674
TreeItem *selected = joint_tree->get_selected();
675
676
if (!selected) {
677
return Variant();
678
}
679
680
Ref<Texture> icon = selected->get_icon(0);
681
682
VBoxContainer *vb = memnew(VBoxContainer);
683
HBoxContainer *hb = memnew(HBoxContainer);
684
TextureRect *tf = memnew(TextureRect);
685
tf->set_texture(icon);
686
tf->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED);
687
hb->add_child(tf);
688
Label *label = memnew(Label(selected->get_text(0)));
689
label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
690
hb->add_child(label);
691
vb->add_child(hb);
692
hb->set_modulate(Color(1, 1, 1, 1));
693
694
set_drag_preview(vb);
695
Dictionary drag_data;
696
drag_data["type"] = "nodes";
697
drag_data["node"] = selected;
698
699
return drag_data;
700
}
701
702
bool Skeleton3DEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
703
TreeItem *target = (p_point == Vector2(Math::INF, Math::INF)) ? joint_tree->get_selected() : joint_tree->get_item_at_position(p_point);
704
if (!target) {
705
return false;
706
}
707
708
const String path = target->get_metadata(0);
709
if (!path.begins_with("bones/")) {
710
return false;
711
}
712
713
TreeItem *selected = Object::cast_to<TreeItem>(Dictionary(p_data)["node"]);
714
if (target == selected) {
715
return false;
716
}
717
718
const String path2 = target->get_metadata(0);
719
if (!path2.begins_with("bones/")) {
720
return false;
721
}
722
723
return true;
724
}
725
726
void Skeleton3DEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
727
if (!can_drop_data_fw(p_point, p_data, p_from)) {
728
return;
729
}
730
731
TreeItem *target = (p_point == Vector2(Math::INF, Math::INF)) ? joint_tree->get_selected() : joint_tree->get_item_at_position(p_point);
732
TreeItem *selected = Object::cast_to<TreeItem>(Dictionary(p_data)["node"]);
733
734
const BoneId target_boneidx = String(target->get_metadata(0)).get_slicec('/', 1).to_int();
735
const BoneId selected_boneidx = String(selected->get_metadata(0)).get_slicec('/', 1).to_int();
736
737
move_skeleton_bone(skeleton->get_path(), selected_boneidx, target_boneidx);
738
}
739
740
void Skeleton3DEditor::move_skeleton_bone(NodePath p_skeleton_path, int32_t p_selected_boneidx, int32_t p_target_boneidx) {
741
Node *node = get_node_or_null(p_skeleton_path);
742
Skeleton3D *skeleton_node = Object::cast_to<Skeleton3D>(node);
743
ERR_FAIL_NULL(skeleton_node);
744
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
745
ur->create_action(TTR("Set Bone Parentage"));
746
// If the target is a child of ourselves, we move only *us* and not our children.
747
if (skeleton_node->is_bone_parent_of(p_target_boneidx, p_selected_boneidx)) {
748
const BoneId parent_idx = skeleton_node->get_bone_parent(p_selected_boneidx);
749
const int bone_count = skeleton_node->get_bone_count();
750
for (BoneId i = 0; i < bone_count; ++i) {
751
if (skeleton_node->get_bone_parent(i) == p_selected_boneidx) {
752
ur->add_undo_method(skeleton_node, "set_bone_parent", i, skeleton_node->get_bone_parent(i));
753
ur->add_do_method(skeleton_node, "set_bone_parent", i, parent_idx);
754
skeleton_node->set_bone_parent(i, parent_idx);
755
}
756
}
757
}
758
ur->add_undo_method(skeleton_node, "set_bone_parent", p_selected_boneidx, skeleton_node->get_bone_parent(p_selected_boneidx));
759
ur->add_do_method(skeleton_node, "set_bone_parent", p_selected_boneidx, p_target_boneidx);
760
761
ur->add_undo_method(this, "update_joint_tree");
762
ur->add_do_method(this, "update_joint_tree");
763
764
skeleton_node->set_bone_parent(p_selected_boneidx, p_target_boneidx);
765
766
ur->commit_action();
767
}
768
769
void Skeleton3DEditor::_joint_tree_selection_changed() {
770
TreeItem *selected = joint_tree->get_selected();
771
if (selected) {
772
const String path = selected->get_metadata(0);
773
if (!path.begins_with("bones/")) {
774
return;
775
}
776
const int b_idx = path.get_slicec('/', 1).to_int();
777
selected_bone = b_idx;
778
if (pose_editor) {
779
const String bone_path = "bones/" + itos(b_idx) + "/";
780
pose_editor->set_target(bone_path);
781
pose_editor->set_keyable(keyable);
782
}
783
}
784
785
if (pose_editor && pose_editor->is_inside_tree()) {
786
pose_editor->set_visible(selected);
787
}
788
set_bone_options_enabled(selected);
789
790
_update_properties();
791
_update_gizmo_visible();
792
}
793
794
// May be not used with single select mode.
795
void Skeleton3DEditor::_joint_tree_rmb_select(const Vector2 &p_pos, MouseButton p_button) {
796
}
797
798
void Skeleton3DEditor::_joint_tree_button_clicked(Object *p_item, int p_column, int p_id, MouseButton p_button) {
799
if (!skeleton) {
800
return;
801
}
802
803
TreeItem *tree_item = Object::cast_to<TreeItem>(p_item);
804
if (tree_item) {
805
String tree_item_metadata = tree_item->get_metadata(0);
806
807
String bone_enabled_property = tree_item_metadata + "/enabled";
808
String bone_parent_property = tree_item_metadata + "/parent";
809
String bone_name_property = tree_item_metadata + "/name";
810
String bone_position_property = tree_item_metadata + "/position";
811
String bone_rotation_property = tree_item_metadata + "/rotation";
812
String bone_scale_property = tree_item_metadata + "/scale";
813
String bone_rest_property = tree_item_metadata + "/rest";
814
815
Variant current_enabled = skeleton->get(bone_enabled_property);
816
Variant current_parent = skeleton->get(bone_parent_property);
817
Variant current_name = skeleton->get(bone_name_property);
818
Variant current_position = skeleton->get(bone_position_property);
819
Variant current_rotation = skeleton->get(bone_rotation_property);
820
Variant current_scale = skeleton->get(bone_scale_property);
821
Variant current_rest = skeleton->get(bone_rest_property);
822
823
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
824
ur->create_action(TTR("Revert Bone"));
825
826
bool can_revert_enabled = EditorPropertyRevert::can_property_revert(skeleton, bone_enabled_property, &current_enabled);
827
if (can_revert_enabled) {
828
bool is_valid = false;
829
Variant new_enabled = EditorPropertyRevert::get_property_revert_value(skeleton, bone_enabled_property, &is_valid);
830
if (is_valid) {
831
ur->add_undo_method(skeleton, "set", bone_enabled_property, current_enabled);
832
ur->add_do_method(skeleton, "set", bone_enabled_property, new_enabled);
833
}
834
}
835
836
bool can_revert_parent = EditorPropertyRevert::can_property_revert(skeleton, bone_parent_property, &current_parent);
837
if (can_revert_parent) {
838
bool is_valid = false;
839
Variant new_parent = EditorPropertyRevert::get_property_revert_value(skeleton, bone_parent_property, &is_valid);
840
if (is_valid) {
841
ur->add_undo_method(skeleton, "set", bone_parent_property, current_parent);
842
ur->add_do_method(skeleton, "set", bone_parent_property, new_parent);
843
}
844
}
845
bool can_revert_name = EditorPropertyRevert::can_property_revert(skeleton, bone_name_property, &current_name);
846
if (can_revert_name) {
847
bool is_valid = false;
848
Variant new_name = EditorPropertyRevert::get_property_revert_value(skeleton, bone_name_property, &is_valid);
849
if (is_valid) {
850
ur->add_undo_method(skeleton, "set", bone_name_property, current_name);
851
ur->add_do_method(skeleton, "set", bone_name_property, new_name);
852
}
853
}
854
bool can_revert_position = EditorPropertyRevert::can_property_revert(skeleton, bone_position_property, &current_position);
855
if (can_revert_position) {
856
bool is_valid = false;
857
Variant new_position = EditorPropertyRevert::get_property_revert_value(skeleton, bone_position_property, &is_valid);
858
if (is_valid) {
859
ur->add_undo_method(skeleton, "set", bone_position_property, current_position);
860
ur->add_do_method(skeleton, "set", bone_position_property, new_position);
861
}
862
}
863
bool can_revert_rotation = EditorPropertyRevert::can_property_revert(skeleton, bone_rotation_property, &current_rotation);
864
if (can_revert_rotation) {
865
bool is_valid = false;
866
Variant new_rotation = EditorPropertyRevert::get_property_revert_value(skeleton, bone_rotation_property, &is_valid);
867
if (is_valid) {
868
ur->add_undo_method(skeleton, "set", bone_rotation_property, current_rotation);
869
ur->add_do_method(skeleton, "set", bone_rotation_property, new_rotation);
870
}
871
}
872
bool can_revert_scale = EditorPropertyRevert::can_property_revert(skeleton, bone_scale_property, &current_scale);
873
if (can_revert_scale) {
874
bool is_valid = false;
875
Variant new_scale = EditorPropertyRevert::get_property_revert_value(skeleton, bone_scale_property, &is_valid);
876
if (is_valid) {
877
ur->add_undo_method(skeleton, "set", bone_scale_property, current_scale);
878
ur->add_do_method(skeleton, "set", bone_scale_property, new_scale);
879
}
880
}
881
bool can_revert_rest = EditorPropertyRevert::can_property_revert(skeleton, bone_rest_property, &current_rest);
882
if (can_revert_rest) {
883
bool is_valid = false;
884
Variant new_rest = EditorPropertyRevert::get_property_revert_value(skeleton, bone_rest_property, &is_valid);
885
if (is_valid) {
886
ur->add_undo_method(skeleton, "set", bone_rest_property, current_rest);
887
ur->add_do_method(skeleton, "set", bone_rest_property, new_rest);
888
}
889
}
890
891
ur->add_undo_method(this, "update_all");
892
ur->add_do_method(this, "update_all");
893
894
ur->commit_action();
895
}
896
return;
897
}
898
899
void Skeleton3DEditor::_update_properties() {
900
if (pose_editor) {
901
pose_editor->_update_properties();
902
}
903
Node3DEditor::get_singleton()->update_transform_gizmo();
904
}
905
906
void Skeleton3DEditor::update_joint_tree() {
907
joint_tree->clear();
908
909
if (!skeleton) {
910
return;
911
}
912
913
TreeItem *root = joint_tree->create_item();
914
915
HashMap<int, TreeItem *> items;
916
917
items.insert(-1, root);
918
919
Ref<Texture> bone_icon = get_editor_theme_icon(SNAME("Bone"));
920
921
Vector<int> bones_to_process = skeleton->get_parentless_bones();
922
while (bones_to_process.size() > 0) {
923
int current_bone_idx = bones_to_process[0];
924
bones_to_process.erase(current_bone_idx);
925
926
const int parent_idx = skeleton->get_bone_parent(current_bone_idx);
927
TreeItem *parent_item = items.find(parent_idx)->value;
928
929
TreeItem *joint_item = joint_tree->create_item(parent_item);
930
items.insert(current_bone_idx, joint_item);
931
932
joint_item->set_text(0, skeleton->get_bone_name(current_bone_idx));
933
joint_item->set_icon(0, bone_icon);
934
joint_item->set_selectable(0, true);
935
joint_item->set_metadata(0, "bones/" + itos(current_bone_idx));
936
937
String bone_enabled_property = "bones/" + itos(current_bone_idx) + "/enabled";
938
String bone_parent_property = "bones/" + itos(current_bone_idx) + "/parent";
939
String bone_name_property = "bones/" + itos(current_bone_idx) + "/name";
940
String bone_position_property = "bones/" + itos(current_bone_idx) + "/position";
941
String bone_rotation_property = "bones/" + itos(current_bone_idx) + "/rotation";
942
String bone_scale_property = "bones/" + itos(current_bone_idx) + "/scale";
943
String bone_rest_property = "bones/" + itos(current_bone_idx) + "/rest";
944
945
Variant current_enabled = skeleton->get(bone_enabled_property);
946
Variant current_parent = skeleton->get(bone_parent_property);
947
Variant current_name = skeleton->get(bone_name_property);
948
Variant current_position = skeleton->get(bone_position_property);
949
Variant current_rotation = skeleton->get(bone_rotation_property);
950
Variant current_scale = skeleton->get(bone_scale_property);
951
Variant current_rest = skeleton->get(bone_rest_property);
952
953
bool can_revert_enabled = EditorPropertyRevert::can_property_revert(skeleton, bone_enabled_property, &current_enabled);
954
bool can_revert_parent = EditorPropertyRevert::can_property_revert(skeleton, bone_parent_property, &current_parent);
955
bool can_revert_name = EditorPropertyRevert::can_property_revert(skeleton, bone_name_property, &current_name);
956
bool can_revert_position = EditorPropertyRevert::can_property_revert(skeleton, bone_position_property, &current_position);
957
bool can_revert_rotation = EditorPropertyRevert::can_property_revert(skeleton, bone_rotation_property, &current_rotation);
958
bool can_revert_scale = EditorPropertyRevert::can_property_revert(skeleton, bone_scale_property, &current_scale);
959
bool can_revert_rest = EditorPropertyRevert::can_property_revert(skeleton, bone_rest_property, &current_rest);
960
961
if (can_revert_enabled || can_revert_parent || can_revert_name || can_revert_position || can_revert_rotation || can_revert_scale || can_revert_rest) {
962
joint_item->add_button(0, get_editor_theme_icon(SNAME("ReloadSmall")), JOINT_BUTTON_REVERT, false, TTR("Revert"));
963
}
964
965
// Add the bone's children to the list of bones to be processed.
966
Vector<int> current_bone_child_bones = skeleton->get_bone_children(current_bone_idx);
967
int child_bone_size = current_bone_child_bones.size();
968
for (int i = 0; i < child_bone_size; i++) {
969
bones_to_process.push_back(current_bone_child_bones[i]);
970
}
971
972
if (current_bone_idx == selected_bone) {
973
joint_item->select(0);
974
}
975
}
976
}
977
978
void Skeleton3DEditor::update_all() {
979
_update_properties();
980
update_joint_tree();
981
}
982
983
void Skeleton3DEditor::create_editors() {
984
set_h_size_flags(SIZE_EXPAND_FILL);
985
set_focus_mode(FOCUS_ALL);
986
987
Node3DEditor *ne = Node3DEditor::get_singleton();
988
AnimationTrackEditor *te = AnimationPlayerEditor::get_singleton()->get_track_editor();
989
990
// Create File dialog.
991
file_dialog = memnew(EditorFileDialog);
992
file_dialog->connect("file_selected", callable_mp(this, &Skeleton3DEditor::_file_selected));
993
add_child(file_dialog);
994
995
// Create Top Menu Bar.
996
topmenu_bar = memnew(HBoxContainer);
997
ne->add_control_to_menu_panel(topmenu_bar);
998
999
// Create Skeleton Option in Top Menu Bar.
1000
skeleton_options = memnew(MenuButton);
1001
skeleton_options->set_flat(false);
1002
skeleton_options->set_theme_type_variation("FlatMenuButton");
1003
topmenu_bar->add_child(skeleton_options);
1004
1005
skeleton_options->set_text(TTR("Skeleton3D"));
1006
1007
// Skeleton options.
1008
PopupMenu *p = skeleton_options->get_popup();
1009
p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/reset_all_poses", TTRC("Reset All Bone Poses")), SKELETON_OPTION_RESET_ALL_POSES);
1010
p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/reset_selected_poses", TTRC("Reset Selected Poses")), SKELETON_OPTION_RESET_SELECTED_POSES);
1011
p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/all_poses_to_rests", TTRC("Apply All Poses to Rests")), SKELETON_OPTION_ALL_POSES_TO_RESTS);
1012
p->add_shortcut(ED_SHORTCUT("skeleton_3d_editor/selected_poses_to_rests", TTRC("Apply Selected Poses to Rests")), SKELETON_OPTION_SELECTED_POSES_TO_RESTS);
1013
p->add_item(TTR("Create Physical Skeleton"), SKELETON_OPTION_CREATE_PHYSICAL_SKELETON);
1014
p->add_item(TTR("Export Skeleton Profile"), SKELETON_OPTION_EXPORT_SKELETON_PROFILE);
1015
1016
p->connect(SceneStringName(id_pressed), callable_mp(this, &Skeleton3DEditor::_on_click_skeleton_option));
1017
set_bone_options_enabled(false);
1018
1019
Vector<Variant> button_binds;
1020
button_binds.resize(1);
1021
1022
edit_mode_button = memnew(Button);
1023
topmenu_bar->add_child(edit_mode_button);
1024
edit_mode_button->set_theme_type_variation(SceneStringName(FlatButton));
1025
edit_mode_button->set_toggle_mode(true);
1026
edit_mode_button->set_focus_mode(FOCUS_ACCESSIBILITY);
1027
edit_mode_button->set_tooltip_text(TTR("Edit Mode\nShow buttons on joints."));
1028
edit_mode_button->connect(SceneStringName(toggled), callable_mp(this, &Skeleton3DEditor::edit_mode_toggled));
1029
1030
edit_mode = false;
1031
1032
if (skeleton) {
1033
skeleton->add_child(handles_mesh_instance);
1034
handles_mesh_instance->set_skeleton_path(NodePath(""));
1035
}
1036
1037
// Keying buttons.
1038
animation_hb = memnew(HBoxContainer);
1039
topmenu_bar->add_child(animation_hb);
1040
animation_hb->add_child(memnew(VSeparator));
1041
animation_hb->hide();
1042
1043
key_loc_button = memnew(Button);
1044
key_loc_button->set_theme_type_variation(SceneStringName(FlatButton));
1045
key_loc_button->set_toggle_mode(true);
1046
key_loc_button->set_pressed(false);
1047
key_loc_button->set_focus_mode(FOCUS_ACCESSIBILITY);
1048
key_loc_button->set_tooltip_text(TTR("Translation mask for inserting keys."));
1049
animation_hb->add_child(key_loc_button);
1050
1051
key_rot_button = memnew(Button);
1052
key_rot_button->set_theme_type_variation(SceneStringName(FlatButton));
1053
key_rot_button->set_toggle_mode(true);
1054
key_rot_button->set_pressed(true);
1055
key_rot_button->set_focus_mode(FOCUS_ACCESSIBILITY);
1056
key_rot_button->set_tooltip_text(TTR("Rotation mask for inserting keys."));
1057
animation_hb->add_child(key_rot_button);
1058
1059
key_scale_button = memnew(Button);
1060
key_scale_button->set_theme_type_variation(SceneStringName(FlatButton));
1061
key_scale_button->set_toggle_mode(true);
1062
key_scale_button->set_pressed(false);
1063
key_scale_button->set_focus_mode(FOCUS_ACCESSIBILITY);
1064
key_scale_button->set_tooltip_text(TTR("Scale mask for inserting keys."));
1065
animation_hb->add_child(key_scale_button);
1066
1067
key_insert_button = memnew(Button);
1068
key_insert_button->set_theme_type_variation(SceneStringName(FlatButton));
1069
key_insert_button->set_focus_mode(FOCUS_ACCESSIBILITY);
1070
key_insert_button->connect(SceneStringName(pressed), callable_mp(this, &Skeleton3DEditor::insert_keys).bind(false));
1071
key_insert_button->set_tooltip_text(TTRC("Insert key (based on mask) for bones with an existing track."));
1072
key_insert_button->set_shortcut(ED_SHORTCUT("skeleton_3d_editor/insert_key_to_existing_tracks", TTRC("Insert Key (Existing Tracks)"), Key::INSERT));
1073
animation_hb->add_child(key_insert_button);
1074
1075
key_insert_all_button = memnew(Button);
1076
key_insert_all_button->set_theme_type_variation(SceneStringName(FlatButton));
1077
key_insert_all_button->set_focus_mode(FOCUS_ACCESSIBILITY);
1078
key_insert_all_button->connect(SceneStringName(pressed), callable_mp(this, &Skeleton3DEditor::insert_keys).bind(true));
1079
key_insert_all_button->set_tooltip_text(TTRC("Insert key (based on mask) for all bones."));
1080
key_insert_all_button->set_shortcut(ED_SHORTCUT("skeleton_3d_editor/insert_key_of_all_bones", TTRC("Insert Key (All Bones)"), KeyModifierMask::CMD_OR_CTRL + Key::INSERT));
1081
animation_hb->add_child(key_insert_all_button);
1082
1083
// Bone tree.
1084
bones_section = memnew(EditorInspectorSection);
1085
bones_section->setup("bones", "Bones", skeleton, Color(0.0f, 0.0, 0.0f), true);
1086
add_child(bones_section);
1087
bones_section->unfold();
1088
1089
ScrollContainer *s_con = memnew(ScrollContainer);
1090
s_con->set_h_size_flags(SIZE_EXPAND_FILL);
1091
s_con->set_custom_minimum_size(Size2(1, 350) * EDSCALE);
1092
bones_section->get_vbox()->add_child(s_con);
1093
1094
joint_tree = memnew(Tree);
1095
joint_tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
1096
joint_tree->set_columns(1);
1097
joint_tree->set_focus_mode(Control::FOCUS_NONE);
1098
joint_tree->set_select_mode(Tree::SELECT_SINGLE);
1099
joint_tree->set_hide_root(true);
1100
joint_tree->set_v_size_flags(SIZE_EXPAND_FILL);
1101
joint_tree->set_h_size_flags(SIZE_EXPAND_FILL);
1102
joint_tree->set_allow_rmb_select(true);
1103
joint_tree->set_theme_type_variation("TreeSecondary");
1104
SET_DRAG_FORWARDING_GCD(joint_tree, Skeleton3DEditor);
1105
s_con->add_child(joint_tree);
1106
1107
pose_editor = memnew(BonePropertiesEditor(skeleton));
1108
pose_editor->set_label(TTR("Bone Transform"));
1109
pose_editor->set_visible(false);
1110
add_child(pose_editor);
1111
1112
set_keyable(te->has_keying());
1113
}
1114
1115
void Skeleton3DEditor::_notification(int p_what) {
1116
switch (p_what) {
1117
case NOTIFICATION_ENTER_TREE: {
1118
update_joint_tree();
1119
1120
joint_tree->connect(SceneStringName(item_selected), callable_mp(this, &Skeleton3DEditor::_joint_tree_selection_changed));
1121
joint_tree->connect("item_mouse_selected", callable_mp(this, &Skeleton3DEditor::_joint_tree_rmb_select));
1122
joint_tree->connect("button_clicked", callable_mp(this, &Skeleton3DEditor::_joint_tree_button_clicked));
1123
1124
skeleton->connect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_draw_gizmo));
1125
skeleton->connect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_update_properties));
1126
skeleton->connect(SceneStringName(bone_enabled_changed), callable_mp(this, &Skeleton3DEditor::_bone_enabled_changed));
1127
skeleton->connect(SceneStringName(show_rest_only_changed), callable_mp(this, &Skeleton3DEditor::_update_gizmo_visible));
1128
1129
get_tree()->connect("node_removed", callable_mp(this, &Skeleton3DEditor::_node_removed), Object::CONNECT_ONE_SHOT);
1130
} break;
1131
case NOTIFICATION_READY: {
1132
// Will trigger NOTIFICATION_THEME_CHANGED, but won't cause any loops if called here.
1133
add_theme_constant_override("separation", 0);
1134
} break;
1135
case NOTIFICATION_THEME_CHANGED: {
1136
skeleton_options->set_button_icon(get_editor_theme_icon(SNAME("Skeleton3D")));
1137
edit_mode_button->set_button_icon(get_editor_theme_icon(SNAME("ToolBoneSelect")));
1138
key_loc_button->set_button_icon(get_editor_theme_icon(SNAME("KeyPosition")));
1139
key_rot_button->set_button_icon(get_editor_theme_icon(SNAME("KeyRotation")));
1140
key_scale_button->set_button_icon(get_editor_theme_icon(SNAME("KeyScale")));
1141
key_insert_button->set_button_icon(get_editor_theme_icon(SNAME("Key")));
1142
key_insert_all_button->set_button_icon(get_editor_theme_icon(SNAME("NewKey")));
1143
bones_section->set_bg_color(get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
1144
1145
update_joint_tree();
1146
} break;
1147
case NOTIFICATION_PREDELETE: {
1148
if (skeleton) {
1149
select_bone(-1); // Requires that the joint_tree has not been deleted.
1150
skeleton->disconnect(SceneStringName(show_rest_only_changed), callable_mp(this, &Skeleton3DEditor::_update_gizmo_visible));
1151
skeleton->disconnect(SceneStringName(bone_enabled_changed), callable_mp(this, &Skeleton3DEditor::_bone_enabled_changed));
1152
skeleton->disconnect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_draw_gizmo));
1153
skeleton->disconnect(SceneStringName(pose_updated), callable_mp(this, &Skeleton3DEditor::_update_properties));
1154
skeleton->set_transform_gizmo_visible(true);
1155
1156
if (handles_mesh_instance->get_parent()) {
1157
handles_mesh_instance->get_parent()->remove_child(handles_mesh_instance);
1158
}
1159
}
1160
edit_mode_toggled(false);
1161
} break;
1162
}
1163
}
1164
1165
void Skeleton3DEditor::_node_removed(Node *p_node) {
1166
if (skeleton && p_node == skeleton) {
1167
skeleton = nullptr;
1168
skeleton_options->hide();
1169
}
1170
1171
_update_properties();
1172
}
1173
1174
void Skeleton3DEditor::edit_mode_toggled(const bool pressed) {
1175
edit_mode = pressed;
1176
_update_gizmo_visible();
1177
}
1178
1179
Skeleton3DEditor::Skeleton3DEditor(EditorInspectorPluginSkeleton *e_plugin, Skeleton3D *p_skeleton) :
1180
editor_plugin(e_plugin),
1181
skeleton(p_skeleton) {
1182
singleton = this;
1183
1184
// Handle.
1185
handle_material.instantiate();
1186
handle_shader.instantiate();
1187
handle_shader->set_code(R"(
1188
// Skeleton 3D gizmo handle shader.
1189
1190
shader_type spatial;
1191
render_mode unshaded, shadows_disabled, depth_draw_always, fog_disabled;
1192
1193
uniform sampler2D texture_albedo : source_color;
1194
uniform float point_size : hint_range(0, 128) = 32;
1195
1196
void vertex() {
1197
if (!OUTPUT_IS_SRGB) {
1198
COLOR.rgb = mix(pow((COLOR.rgb + vec3(0.055)) * (1.0 / (1.0 + 0.055)), vec3(2.4)), COLOR.rgb * (1.0 / 12.92), lessThan(COLOR.rgb, vec3(0.04045)));
1199
}
1200
1201
VERTEX = VERTEX;
1202
POSITION = PROJECTION_MATRIX * VIEW_MATRIX * MODEL_MATRIX * vec4(VERTEX.xyz, 1.0);
1203
POSITION.z = mix(POSITION.z, POSITION.w, 0.999);
1204
POINT_SIZE = point_size;
1205
}
1206
1207
void fragment() {
1208
vec4 albedo_tex = texture(texture_albedo, POINT_COORD);
1209
vec3 col = albedo_tex.rgb + COLOR.rgb;
1210
col = vec3(min(col.r, 1.0), min(col.g, 1.0), min(col.b, 1.0));
1211
ALBEDO = col;
1212
1213
if (albedo_tex.a < 0.5) {
1214
discard;
1215
}
1216
1217
ALPHA = albedo_tex.a;
1218
}
1219
)");
1220
handle_material->set_shader(handle_shader);
1221
Ref<Texture2D> handle = EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("EditorBoneHandle"), EditorStringName(EditorIcons));
1222
handle_material->set_shader_parameter("point_size", handle->get_width());
1223
handle_material->set_shader_parameter("texture_albedo", handle);
1224
1225
handles_mesh_instance = memnew(MeshInstance3D);
1226
handles_mesh_instance->set_cast_shadows_setting(GeometryInstance3D::SHADOW_CASTING_SETTING_OFF);
1227
handles_mesh.instantiate();
1228
handles_mesh_instance->set_mesh(handles_mesh);
1229
1230
create_editors();
1231
}
1232
1233
void Skeleton3DEditor::update_bone_original() {
1234
if (!skeleton) {
1235
return;
1236
}
1237
if (skeleton->get_bone_count() == 0 || selected_bone == -1) {
1238
return;
1239
}
1240
bone_original_position = skeleton->get_bone_pose_position(selected_bone);
1241
bone_original_rotation = skeleton->get_bone_pose_rotation(selected_bone);
1242
bone_original_scale = skeleton->get_bone_pose_scale(selected_bone);
1243
}
1244
1245
void Skeleton3DEditor::_hide_handles() {
1246
handles_mesh_instance->hide();
1247
}
1248
1249
void Skeleton3DEditor::_draw_gizmo() {
1250
if (!skeleton) {
1251
return;
1252
}
1253
1254
// If you call get_bone_global_pose() while drawing the surface, such as toggle rest mode,
1255
// the skeleton update will be done first and
1256
// the drawing surface will be interrupted once and an error will occur.
1257
skeleton->force_update_all_dirty_bones();
1258
1259
// Handles.
1260
if (edit_mode) {
1261
_draw_handles();
1262
} else {
1263
_hide_handles();
1264
}
1265
}
1266
1267
void Skeleton3DEditor::_draw_handles() {
1268
const int bone_count = skeleton->get_bone_count();
1269
1270
handles_mesh->clear_surfaces();
1271
1272
if (bone_count) {
1273
handles_mesh_instance->show();
1274
1275
handles_mesh->surface_begin(Mesh::PRIMITIVE_POINTS);
1276
1277
for (int i = 0; i < bone_count; i++) {
1278
Color c;
1279
if (i == selected_bone) {
1280
c = Color(1, 1, 0);
1281
} else {
1282
c = Color(0.1, 0.25, 0.8);
1283
}
1284
Vector3 point = skeleton->get_bone_global_pose(i).origin;
1285
handles_mesh->surface_set_color(c);
1286
handles_mesh->surface_add_vertex(point);
1287
}
1288
handles_mesh->surface_end();
1289
handles_mesh->surface_set_material(0, handle_material);
1290
} else {
1291
handles_mesh_instance->hide();
1292
}
1293
}
1294
1295
TreeItem *Skeleton3DEditor::_find(TreeItem *p_node, const NodePath &p_path) {
1296
if (!p_node) {
1297
return nullptr;
1298
}
1299
1300
NodePath np = p_node->get_metadata(0);
1301
if (np == p_path) {
1302
return p_node;
1303
}
1304
1305
TreeItem *children = p_node->get_first_child();
1306
while (children) {
1307
TreeItem *n = _find(children, p_path);
1308
if (n) {
1309
return n;
1310
}
1311
children = children->get_next();
1312
}
1313
1314
return nullptr;
1315
}
1316
1317
void Skeleton3DEditor::_subgizmo_selection_change() {
1318
if (!skeleton) {
1319
return;
1320
}
1321
1322
// Once validated by subgizmos_intersect_ray, but required if through inspector's bones tree.
1323
if (!edit_mode) {
1324
skeleton->clear_subgizmo_selection();
1325
return;
1326
}
1327
1328
int selected = -1;
1329
Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
1330
if (se) {
1331
selected = se->get_selected_bone();
1332
}
1333
1334
if (selected >= 0) {
1335
Vector<Ref<Node3DGizmo>> gizmos = skeleton->get_gizmos();
1336
for (int i = 0; i < gizmos.size(); i++) {
1337
Ref<EditorNode3DGizmo> gizmo = gizmos[i];
1338
if (gizmo.is_null()) {
1339
continue;
1340
}
1341
Ref<Skeleton3DGizmoPlugin> plugin = gizmo->get_plugin();
1342
if (plugin.is_null()) {
1343
continue;
1344
}
1345
skeleton->set_subgizmo_selection(gizmo, selected, skeleton->get_bone_global_pose(selected));
1346
break;
1347
}
1348
} else {
1349
skeleton->clear_subgizmo_selection();
1350
}
1351
}
1352
1353
void Skeleton3DEditor::select_bone(int p_idx) {
1354
if (p_idx >= 0) {
1355
TreeItem *ti = _find(joint_tree->get_root(), "bones/" + itos(p_idx));
1356
if (ti) {
1357
// Make visible when it's collapsed.
1358
TreeItem *node = ti->get_parent();
1359
while (node && node != joint_tree->get_root()) {
1360
node->set_collapsed(false);
1361
node = node->get_parent();
1362
}
1363
ti->select(0);
1364
joint_tree->scroll_to_item(ti);
1365
}
1366
} else {
1367
selected_bone = -1;
1368
joint_tree->deselect_all();
1369
_joint_tree_selection_changed();
1370
}
1371
}
1372
1373
Skeleton3DEditor::~Skeleton3DEditor() {
1374
singleton = nullptr;
1375
1376
handles_mesh_instance->queue_free();
1377
1378
Node3DEditor *ne = Node3DEditor::get_singleton();
1379
1380
ne->remove_control_from_menu_panel(topmenu_bar);
1381
memdelete(topmenu_bar);
1382
}
1383
1384
bool EditorInspectorPluginSkeleton::can_handle(Object *p_object) {
1385
return Object::cast_to<Skeleton3D>(p_object) != nullptr;
1386
}
1387
1388
void EditorInspectorPluginSkeleton::parse_begin(Object *p_object) {
1389
Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_object);
1390
ERR_FAIL_NULL(skeleton);
1391
1392
skel_editor = memnew(Skeleton3DEditor(this, skeleton));
1393
add_custom_control(skel_editor);
1394
}
1395
1396
Skeleton3DEditorPlugin::Skeleton3DEditorPlugin() {
1397
skeleton_plugin = memnew(EditorInspectorPluginSkeleton);
1398
1399
EditorInspector::add_inspector_plugin(skeleton_plugin);
1400
1401
Ref<Skeleton3DGizmoPlugin> gizmo_plugin = Ref<Skeleton3DGizmoPlugin>(memnew(Skeleton3DGizmoPlugin));
1402
Node3DEditor::get_singleton()->add_gizmo_plugin(gizmo_plugin);
1403
}
1404
1405
EditorPlugin::AfterGUIInput Skeleton3DEditorPlugin::forward_3d_gui_input(Camera3D *p_camera, const Ref<InputEvent> &p_event) {
1406
Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
1407
Node3DEditor *ne = Node3DEditor::get_singleton();
1408
if (se && se->is_edit_mode()) {
1409
const Ref<InputEventMouseButton> mb = p_event;
1410
if (mb.is_valid() && mb->get_button_index() == MouseButton::LEFT) {
1411
if (ne->get_tool_mode() != Node3DEditor::TOOL_MODE_SELECT) {
1412
if (!ne->is_gizmo_visible()) {
1413
return EditorPlugin::AFTER_GUI_INPUT_STOP;
1414
}
1415
}
1416
if (mb->is_pressed()) {
1417
se->update_bone_original();
1418
}
1419
}
1420
return EditorPlugin::AFTER_GUI_INPUT_CUSTOM;
1421
}
1422
return EditorPlugin::AFTER_GUI_INPUT_PASS;
1423
}
1424
1425
bool Skeleton3DEditorPlugin::handles(Object *p_object) const {
1426
return p_object->is_class("Skeleton3D");
1427
}
1428
1429
void Skeleton3DEditor::_bone_enabled_changed(const int p_bone_id) {
1430
_update_gizmo_visible();
1431
}
1432
1433
void Skeleton3DEditor::_update_gizmo_visible() {
1434
_subgizmo_selection_change();
1435
if (edit_mode) {
1436
if (selected_bone == -1) {
1437
skeleton->set_transform_gizmo_visible(false);
1438
} else {
1439
if (skeleton->is_bone_enabled(selected_bone) && !skeleton->is_show_rest_only()) {
1440
skeleton->set_transform_gizmo_visible(true);
1441
} else {
1442
skeleton->set_transform_gizmo_visible(false);
1443
}
1444
}
1445
} else {
1446
skeleton->set_transform_gizmo_visible(true);
1447
}
1448
_draw_gizmo();
1449
}
1450
1451
int Skeleton3DEditor::get_selected_bone() const {
1452
return selected_bone;
1453
}
1454
1455
Skeleton3DGizmoPlugin::SelectionMaterials Skeleton3DGizmoPlugin::selection_materials;
1456
1457
Skeleton3DGizmoPlugin::Skeleton3DGizmoPlugin() {
1458
selection_materials.unselected_mat.instantiate();
1459
selection_materials.unselected_mat->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED);
1460
selection_materials.unselected_mat->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA);
1461
selection_materials.unselected_mat->set_flag(StandardMaterial3D::FLAG_ALBEDO_FROM_VERTEX_COLOR, true);
1462
selection_materials.unselected_mat->set_flag(StandardMaterial3D::FLAG_SRGB_VERTEX_COLOR, true);
1463
selection_materials.unselected_mat->set_flag(StandardMaterial3D::FLAG_DISABLE_FOG, true);
1464
1465
selection_materials.selected_mat.instantiate();
1466
Ref<Shader> selected_sh = Ref<Shader>(memnew(Shader));
1467
selected_sh->set_code(R"(
1468
// Skeleton 3D gizmo bones shader.
1469
1470
shader_type spatial;
1471
render_mode unshaded, shadows_disabled;
1472
void vertex() {
1473
if (!OUTPUT_IS_SRGB) {
1474
COLOR.rgb = mix( pow((COLOR.rgb + vec3(0.055)) * (1.0 / (1.0 + 0.055)), vec3(2.4)), COLOR.rgb* (1.0 / 12.92), lessThan(COLOR.rgb,vec3(0.04045)) );
1475
}
1476
VERTEX = VERTEX;
1477
POSITION = PROJECTION_MATRIX * VIEW_MATRIX * MODEL_MATRIX * vec4(VERTEX.xyz, 1.0);
1478
POSITION.z = mix(POSITION.z, POSITION.w, 0.998);
1479
}
1480
void fragment() {
1481
ALBEDO = COLOR.rgb;
1482
ALPHA = COLOR.a;
1483
}
1484
)");
1485
selection_materials.selected_mat->set_shader(selected_sh);
1486
}
1487
1488
Skeleton3DGizmoPlugin::~Skeleton3DGizmoPlugin() {
1489
selection_materials.unselected_mat.unref();
1490
selection_materials.selected_mat.unref();
1491
}
1492
1493
bool Skeleton3DGizmoPlugin::has_gizmo(Node3D *p_spatial) {
1494
return Object::cast_to<Skeleton3D>(p_spatial) != nullptr;
1495
}
1496
1497
String Skeleton3DGizmoPlugin::get_gizmo_name() const {
1498
return "Skeleton3D";
1499
}
1500
1501
int Skeleton3DGizmoPlugin::get_priority() const {
1502
return -1;
1503
}
1504
1505
int Skeleton3DGizmoPlugin::subgizmos_intersect_ray(const EditorNode3DGizmo *p_gizmo, Camera3D *p_camera, const Vector2 &p_point) const {
1506
Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
1507
ERR_FAIL_NULL_V(skeleton, -1);
1508
1509
Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
1510
1511
if (!se || !se->is_edit_mode()) {
1512
return -1;
1513
}
1514
1515
if (Node3DEditor::get_singleton()->get_tool_mode() != Node3DEditor::TOOL_MODE_SELECT) {
1516
return -1;
1517
}
1518
1519
// Select bone.
1520
real_t grab_threshold = 4 * EDSCALE;
1521
Vector3 ray_from = p_camera->get_global_transform().origin;
1522
Transform3D gt = skeleton->get_global_transform();
1523
int closest_idx = -1;
1524
real_t closest_dist = 1e10;
1525
const int bone_count = skeleton->get_bone_count();
1526
for (int i = 0; i < bone_count; i++) {
1527
Vector3 joint_pos_3d = gt.xform(skeleton->get_bone_global_pose(i).origin);
1528
Vector2 joint_pos_2d = p_camera->unproject_position(joint_pos_3d);
1529
real_t dist_3d = ray_from.distance_to(joint_pos_3d);
1530
real_t dist_2d = p_point.distance_to(joint_pos_2d);
1531
if (dist_2d < grab_threshold && dist_3d < closest_dist) {
1532
closest_dist = dist_3d;
1533
closest_idx = i;
1534
}
1535
}
1536
1537
if (closest_idx >= 0) {
1538
se->select_bone(closest_idx);
1539
return closest_idx;
1540
}
1541
1542
se->select_bone(-1);
1543
return -1;
1544
}
1545
1546
Transform3D Skeleton3DGizmoPlugin::get_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id) const {
1547
Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
1548
ERR_FAIL_NULL_V(skeleton, Transform3D());
1549
1550
return skeleton->get_bone_global_pose(p_id);
1551
}
1552
1553
void Skeleton3DGizmoPlugin::set_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id, Transform3D p_transform) {
1554
Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
1555
ERR_FAIL_NULL(skeleton);
1556
1557
// Prepare for global to local.
1558
Transform3D original_to_local;
1559
int parent_idx = skeleton->get_bone_parent(p_id);
1560
if (parent_idx >= 0) {
1561
original_to_local = skeleton->get_bone_global_pose(parent_idx);
1562
}
1563
Basis to_local = original_to_local.get_basis().inverse();
1564
1565
// Prepare transform.
1566
Transform3D t;
1567
1568
// Basis.
1569
t.basis = to_local * p_transform.get_basis();
1570
1571
// Origin.
1572
Vector3 orig = skeleton->get_bone_pose(p_id).origin;
1573
Vector3 sub = p_transform.origin - skeleton->get_bone_global_pose(p_id).origin;
1574
t.origin = orig + to_local.xform(sub);
1575
1576
// Apply transform.
1577
skeleton->set_bone_pose_position(p_id, t.origin);
1578
skeleton->set_bone_pose_rotation(p_id, t.basis.get_rotation_quaternion());
1579
skeleton->set_bone_pose_scale(p_id, t.basis.get_scale());
1580
}
1581
1582
void Skeleton3DGizmoPlugin::commit_subgizmos(const EditorNode3DGizmo *p_gizmo, const Vector<int> &p_ids, const Vector<Transform3D> &p_restore, bool p_cancel) {
1583
Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
1584
ERR_FAIL_NULL(skeleton);
1585
1586
Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
1587
Node3DEditor *ne = Node3DEditor::get_singleton();
1588
1589
EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton();
1590
ur->create_action(TTR("Set Bone Transform"));
1591
if (ne->get_tool_mode() == Node3DEditor::TOOL_MODE_SELECT || ne->get_tool_mode() == Node3DEditor::TOOL_MODE_MOVE) {
1592
for (int i = 0; i < p_ids.size(); i++) {
1593
ur->add_do_method(skeleton, "set_bone_pose_position", p_ids[i], skeleton->get_bone_pose_position(p_ids[i]));
1594
ur->add_undo_method(skeleton, "set_bone_pose_position", p_ids[i], se->get_bone_original_position());
1595
}
1596
}
1597
if (ne->get_tool_mode() == Node3DEditor::TOOL_MODE_SELECT || ne->get_tool_mode() == Node3DEditor::TOOL_MODE_ROTATE) {
1598
for (int i = 0; i < p_ids.size(); i++) {
1599
ur->add_do_method(skeleton, "set_bone_pose_rotation", p_ids[i], skeleton->get_bone_pose_rotation(p_ids[i]));
1600
ur->add_undo_method(skeleton, "set_bone_pose_rotation", p_ids[i], se->get_bone_original_rotation());
1601
}
1602
}
1603
if (ne->get_tool_mode() == Node3DEditor::TOOL_MODE_SCALE) {
1604
for (int i = 0; i < p_ids.size(); i++) {
1605
// If the axis is swapped by scaling, the rotation can be changed.
1606
ur->add_do_method(skeleton, "set_bone_pose_rotation", p_ids[i], skeleton->get_bone_pose_rotation(p_ids[i]));
1607
ur->add_undo_method(skeleton, "set_bone_pose_rotation", p_ids[i], se->get_bone_original_rotation());
1608
ur->add_do_method(skeleton, "set_bone_pose_scale", p_ids[i], skeleton->get_bone_pose_scale(p_ids[i]));
1609
ur->add_undo_method(skeleton, "set_bone_pose_scale", p_ids[i], se->get_bone_original_scale());
1610
}
1611
}
1612
1613
ur->add_do_method(se, "update_joint_tree");
1614
ur->add_undo_method(se, "update_joint_tree");
1615
1616
ur->commit_action();
1617
}
1618
1619
void Skeleton3DGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) {
1620
Skeleton3D *skeleton = Object::cast_to<Skeleton3D>(p_gizmo->get_node_3d());
1621
p_gizmo->clear();
1622
1623
if (!skeleton->get_bone_count()) {
1624
return;
1625
}
1626
1627
int selected = -1;
1628
Skeleton3DEditor *se = Skeleton3DEditor::get_singleton();
1629
if (se) {
1630
selected = se->get_selected_bone();
1631
}
1632
1633
Ref<ArrayMesh> m = get_bones_mesh(skeleton, selected, p_gizmo->is_selected());
1634
p_gizmo->add_mesh(m, Ref<Material>(), Transform3D(), skeleton->register_skin(skeleton->create_skin_from_rest_transforms()));
1635
}
1636
1637
Ref<ArrayMesh> Skeleton3DGizmoPlugin::get_bones_mesh(Skeleton3D *p_skeleton, int p_selected, bool p_is_selected) {
1638
Color bone_color = EDITOR_GET("editors/3d_gizmos/gizmo_colors/skeleton");
1639
Color selected_bone_color = EDITOR_GET("editors/3d_gizmos/gizmo_colors/selected_bone");
1640
real_t bone_axis_length = EDITOR_GET("editors/3d_gizmos/gizmo_settings/bone_axis_length");
1641
int bone_shape = EDITOR_GET("editors/3d_gizmos/gizmo_settings/bone_shape");
1642
1643
LocalVector<Color> axis_colors;
1644
axis_colors.push_back(Node3DEditor::get_singleton()->get_theme_color(SNAME("axis_x_color"), EditorStringName(Editor)));
1645
axis_colors.push_back(Node3DEditor::get_singleton()->get_theme_color(SNAME("axis_y_color"), EditorStringName(Editor)));
1646
axis_colors.push_back(Node3DEditor::get_singleton()->get_theme_color(SNAME("axis_z_color"), EditorStringName(Editor)));
1647
1648
Ref<SurfaceTool> surface_tool(memnew(SurfaceTool));
1649
surface_tool->begin(Mesh::PRIMITIVE_LINES);
1650
1651
if (p_is_selected) {
1652
surface_tool->set_material(selection_materials.selected_mat);
1653
} else {
1654
selection_materials.unselected_mat->set_albedo(bone_color);
1655
surface_tool->set_material(selection_materials.unselected_mat);
1656
}
1657
1658
LocalVector<int> bones;
1659
LocalVector<float> weights;
1660
bones.resize(4);
1661
weights.resize(4);
1662
for (int i = 0; i < 4; i++) {
1663
bones[i] = 0;
1664
weights[i] = 0;
1665
}
1666
weights[0] = 1;
1667
1668
int current_bone_index = 0;
1669
Vector<int> bones_to_process = p_skeleton->get_parentless_bones();
1670
1671
while (bones_to_process.size() > current_bone_index) {
1672
int current_bone_idx = bones_to_process[current_bone_index];
1673
current_bone_index++;
1674
1675
Color current_bone_color = (current_bone_idx == p_selected) ? selected_bone_color : bone_color;
1676
1677
Vector<int> child_bones_vector;
1678
child_bones_vector = p_skeleton->get_bone_children(current_bone_idx);
1679
int child_bones_size = child_bones_vector.size();
1680
1681
for (int i = 0; i < child_bones_size; i++) {
1682
// Something wrong.
1683
if (child_bones_vector[i] < 0) {
1684
continue;
1685
}
1686
1687
int child_bone_idx = child_bones_vector[i];
1688
1689
Vector3 v0 = p_skeleton->get_bone_global_rest(current_bone_idx).origin;
1690
Vector3 v1 = p_skeleton->get_bone_global_rest(child_bone_idx).origin;
1691
Vector3 d = (v1 - v0).normalized();
1692
real_t dist = v0.distance_to(v1);
1693
1694
// Find closest axis.
1695
int closest = -1;
1696
real_t closest_d = 0.0;
1697
for (int j = 0; j < 3; j++) {
1698
real_t dp = Math::abs(p_skeleton->get_bone_global_rest(current_bone_idx).basis[j].normalized().dot(d));
1699
if (j == 0 || dp > closest_d) {
1700
closest = j;
1701
}
1702
}
1703
1704
// Draw bone.
1705
switch (bone_shape) {
1706
case 0: { // Wire shape.
1707
surface_tool->set_color(current_bone_color);
1708
bones[0] = current_bone_idx;
1709
surface_tool->set_bones(bones);
1710
surface_tool->set_weights(weights);
1711
surface_tool->add_vertex(v0);
1712
bones[0] = child_bone_idx;
1713
surface_tool->set_bones(bones);
1714
surface_tool->set_weights(weights);
1715
surface_tool->add_vertex(v1);
1716
} break;
1717
1718
case 1: { // Octahedron shape.
1719
Vector3 first;
1720
Vector3 points[6];
1721
int point_idx = 0;
1722
for (int j = 0; j < 3; j++) {
1723
Vector3 axis;
1724
if (first == Vector3()) {
1725
axis = d.cross(d.cross(p_skeleton->get_bone_global_rest(current_bone_idx).basis[j])).normalized();
1726
first = axis;
1727
} else {
1728
axis = d.cross(first).normalized();
1729
}
1730
1731
surface_tool->set_color(current_bone_color);
1732
for (int k = 0; k < 2; k++) {
1733
if (k == 1) {
1734
axis = -axis;
1735
}
1736
Vector3 point = v0 + d * dist * 0.2;
1737
point += axis * dist * 0.1;
1738
1739
bones[0] = current_bone_idx;
1740
surface_tool->set_bones(bones);
1741
surface_tool->set_weights(weights);
1742
surface_tool->add_vertex(v0);
1743
surface_tool->set_bones(bones);
1744
surface_tool->set_weights(weights);
1745
surface_tool->add_vertex(point);
1746
1747
surface_tool->set_bones(bones);
1748
surface_tool->set_weights(weights);
1749
surface_tool->add_vertex(point);
1750
bones[0] = child_bone_idx;
1751
surface_tool->set_bones(bones);
1752
surface_tool->set_weights(weights);
1753
surface_tool->add_vertex(v1);
1754
points[point_idx++] = point;
1755
}
1756
}
1757
surface_tool->set_color(current_bone_color);
1758
SWAP(points[1], points[2]);
1759
bones[0] = current_bone_idx;
1760
for (int j = 0; j < 6; j++) {
1761
surface_tool->set_bones(bones);
1762
surface_tool->set_weights(weights);
1763
surface_tool->add_vertex(points[j]);
1764
surface_tool->set_bones(bones);
1765
surface_tool->set_weights(weights);
1766
surface_tool->add_vertex(points[(j + 1) % 6]);
1767
}
1768
} break;
1769
}
1770
1771
// Axis as root of the bone.
1772
for (int j = 0; j < 3; j++) {
1773
bones[0] = current_bone_idx;
1774
surface_tool->set_color(axis_colors[j]);
1775
surface_tool->set_bones(bones);
1776
surface_tool->set_weights(weights);
1777
surface_tool->add_vertex(v0);
1778
surface_tool->set_bones(bones);
1779
surface_tool->set_weights(weights);
1780
surface_tool->add_vertex(v0 + (p_skeleton->get_bone_global_rest(current_bone_idx).basis.inverse())[j].normalized() * dist * bone_axis_length);
1781
1782
if (j == closest) {
1783
continue;
1784
}
1785
}
1786
1787
// Axis at the end of the bone children.
1788
if (i == child_bones_size - 1) {
1789
for (int j = 0; j < 3; j++) {
1790
bones[0] = child_bone_idx;
1791
surface_tool->set_color(axis_colors[j]);
1792
surface_tool->set_bones(bones);
1793
surface_tool->set_weights(weights);
1794
surface_tool->add_vertex(v1);
1795
surface_tool->set_bones(bones);
1796
surface_tool->set_weights(weights);
1797
surface_tool->add_vertex(v1 + (p_skeleton->get_bone_global_rest(child_bone_idx).basis.inverse())[j].normalized() * dist * bone_axis_length);
1798
1799
if (j == closest) {
1800
continue;
1801
}
1802
}
1803
}
1804
1805
// Add the bone's children to the list of bones to be processed.
1806
bones_to_process.push_back(child_bones_vector[i]);
1807
}
1808
}
1809
1810
return surface_tool->commit();
1811
}
1812
1813