From aa2c3da63aaf4bde75585f8a3108af3ffeefc5e6 Mon Sep 17 00:00:00 2001
From: "Silc Lizard (Tokage) Renew"
<61938263+TokageItLab@users.noreply.github.com>
Date: Tue, 27 May 2025 05:34:04 +0900
Subject: [PATCH] Implement ModifierBoneTarget3D which can be target of the
other mods
---
doc/classes/ModifierBoneTarget3D.xml | 20 ++++++
editor/icons/ModifierBoneTarget3D.svg | 1 +
scene/3d/modifier_bone_target_3d.cpp | 98 +++++++++++++++++++++++++++
scene/3d/modifier_bone_target_3d.h | 52 ++++++++++++++
scene/register_scene_types.cpp | 2 +
5 files changed, 173 insertions(+)
create mode 100644 doc/classes/ModifierBoneTarget3D.xml
create mode 100644 editor/icons/ModifierBoneTarget3D.svg
create mode 100644 scene/3d/modifier_bone_target_3d.cpp
create mode 100644 scene/3d/modifier_bone_target_3d.h
diff --git a/doc/classes/ModifierBoneTarget3D.xml b/doc/classes/ModifierBoneTarget3D.xml
new file mode 100644
index 00000000000..9201ad93de0
--- /dev/null
+++ b/doc/classes/ModifierBoneTarget3D.xml
@@ -0,0 +1,20 @@
+
+
+
+ А node that dynamically copies the 3D transform of a bone in its parent [Skeleton3D].
+
+
+ This node selects a bone in a [Skeleton3D] and attaches to it. This means that the [ModifierBoneTarget3D] node will dynamically copy the 3D transform of the selected bone.
+ The functionality is similar to [BoneAttachment3D], but this node adopts the [SkeletonModifier3D] cycle and is intended to be used as another [SkeletonModifier3D]'s target.
+
+
+
+
+
+ The index of the attached bone.
+
+
+ The name of the attached bone.
+
+
+
diff --git a/editor/icons/ModifierBoneTarget3D.svg b/editor/icons/ModifierBoneTarget3D.svg
new file mode 100644
index 00000000000..4a4ec562e73
--- /dev/null
+++ b/editor/icons/ModifierBoneTarget3D.svg
@@ -0,0 +1 @@
+
diff --git a/scene/3d/modifier_bone_target_3d.cpp b/scene/3d/modifier_bone_target_3d.cpp
new file mode 100644
index 00000000000..5169e143ae8
--- /dev/null
+++ b/scene/3d/modifier_bone_target_3d.cpp
@@ -0,0 +1,98 @@
+/**************************************************************************/
+/* modifier_bone_target_3d.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 "modifier_bone_target_3d.h"
+
+void ModifierBoneTarget3D::_validate_bone_names() {
+ // Prior bone name.
+ if (!bone_name.is_empty()) {
+ set_bone_name(bone_name);
+ } else if (bone != -1) {
+ set_bone(bone);
+ }
+}
+
+void ModifierBoneTarget3D::set_bone_name(const String &p_bone_name) {
+ bone_name = p_bone_name;
+ Skeleton3D *sk = get_skeleton();
+ if (sk) {
+ set_bone(sk->find_bone(bone_name));
+ }
+}
+
+String ModifierBoneTarget3D::get_bone_name() const {
+ return bone_name;
+}
+
+void ModifierBoneTarget3D::set_bone(int p_bone) {
+ bone = p_bone;
+ Skeleton3D *sk = get_skeleton();
+ if (sk) {
+ if (bone <= -1 || bone >= sk->get_bone_count()) {
+ WARN_PRINT("Bone index out of range!");
+ bone = -1;
+ } else {
+ bone_name = sk->get_bone_name(bone);
+ }
+ }
+}
+
+int ModifierBoneTarget3D::get_bone() const {
+ return bone;
+}
+
+void ModifierBoneTarget3D::_validate_property(PropertyInfo &p_property) const {
+ if (p_property.name == "influence") {
+ p_property.usage = PROPERTY_USAGE_READ_ONLY;
+ }
+}
+
+void ModifierBoneTarget3D::_bind_methods() {
+ ClassDB::bind_method(D_METHOD("set_bone_name", "bone_name"), &ModifierBoneTarget3D::set_bone_name);
+ ClassDB::bind_method(D_METHOD("get_bone_name"), &ModifierBoneTarget3D::get_bone_name);
+ ClassDB::bind_method(D_METHOD("set_bone", "bone"), &ModifierBoneTarget3D::set_bone);
+ ClassDB::bind_method(D_METHOD("get_bone"), &ModifierBoneTarget3D::get_bone);
+
+ ADD_PROPERTY(PropertyInfo(Variant::STRING, "bone_name", PROPERTY_HINT_ENUM_SUGGESTION, ""), "set_bone_name", "get_bone_name");
+ ADD_PROPERTY(PropertyInfo(Variant::INT, "bone", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR), "set_bone", "get_bone");
+}
+
+void ModifierBoneTarget3D::_process_modification(double p_delta) {
+ if (!is_inside_tree()) {
+ return;
+ }
+
+ Skeleton3D *skeleton = get_skeleton();
+ if (!skeleton || bone < 0 || bone >= skeleton->get_bone_count()) {
+ return;
+ }
+
+ set_transform(skeleton->get_bone_global_pose(bone));
+}
diff --git a/scene/3d/modifier_bone_target_3d.h b/scene/3d/modifier_bone_target_3d.h
new file mode 100644
index 00000000000..02a9e24e494
--- /dev/null
+++ b/scene/3d/modifier_bone_target_3d.h
@@ -0,0 +1,52 @@
+/**************************************************************************/
+/* modifier_bone_target_3d.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. */
+/**************************************************************************/
+
+#pragma once
+
+#include "scene/3d/skeleton_modifier_3d.h"
+
+class ModifierBoneTarget3D : public SkeletonModifier3D {
+ GDCLASS(ModifierBoneTarget3D, SkeletonModifier3D);
+
+ String bone_name;
+ int bone = -1;
+
+protected:
+ void _validate_property(PropertyInfo &p_property) const;
+ virtual void _validate_bone_names() override;
+ static void _bind_methods();
+ virtual void _process_modification(double p_delta) override;
+
+public:
+ void set_bone_name(const String &p_bone_name);
+ String get_bone_name() const;
+ void set_bone(int p_bone);
+ int get_bone() const;
+};
diff --git a/scene/register_scene_types.cpp b/scene/register_scene_types.cpp
index 0992ecf272a..c4d8b553f1e 100644
--- a/scene/register_scene_types.cpp
+++ b/scene/register_scene_types.cpp
@@ -231,6 +231,7 @@
#include "scene/3d/look_at_modifier_3d.h"
#include "scene/3d/marker_3d.h"
#include "scene/3d/mesh_instance_3d.h"
+#include "scene/3d/modifier_bone_target_3d.h"
#include "scene/3d/multimesh_instance_3d.h"
#include "scene/3d/node_3d.h"
#include "scene/3d/occluder_instance_3d.h"
@@ -642,6 +643,7 @@ void register_scene_types() {
GDREGISTER_CLASS(GPUParticlesAttractorVectorField3D);
GDREGISTER_CLASS(CPUParticles3D);
GDREGISTER_CLASS(Marker3D);
+ GDREGISTER_CLASS(ModifierBoneTarget3D);
GDREGISTER_CLASS(RootMotionView);
GDREGISTER_VIRTUAL_CLASS(SkeletonModifier3D);
GDREGISTER_CLASS(RetargetModifier3D);