Merge pull request #110336 from TokageItLab/constraint-mod-node

Add option to `BoneConstraint3D` to make reference target allow to set `Node3D`

Author: Repiteo

doc/classes/BoneConstraint3D.xml

@@ -52,6 +52,21 @@
 				This bone will be only referenced and not modified by this modifier.
 			</description>
 		</method>
+		<method name="get_reference_node" qualifiers="const">
+			<return type="NodePath" />
+			<param index="0" name="index" type="int" />
+			<description>
+				Returns the reference node path of the setting at [param index].
+				This node will be only referenced and not modified by this modifier.
+			</description>
+		</method>
+		<method name="get_reference_type" qualifiers="const">
+			<return type="int" enum="BoneConstraint3D.ReferenceType" />
+			<param index="0" name="index" type="int" />
+			<description>
+				Returns the reference target type of the setting at [param index]. See also [enum ReferenceType].
+			</description>
+		</method>
 		<method name="get_setting_count" qualifiers="const">
 			<return type="int" />
 			<description>
@@ -100,6 +115,23 @@
 				This bone will be only referenced and not modified by this modifier.
 			</description>
 		</method>
+		<method name="set_reference_node">
+			<return type="void" />
+			<param index="0" name="index" type="int" />
+			<param index="1" name="node" type="NodePath" />
+			<description>
+				Sets the reference node path of the setting at [param index] to [param node].
+				This node will be only referenced and not modified by this modifier.
+			</description>
+		</method>
+		<method name="set_reference_type">
+			<return type="void" />
+			<param index="0" name="index" type="int" />
+			<param index="1" name="type" type="int" enum="BoneConstraint3D.ReferenceType" />
+			<description>
+				Sets the reference target type of the setting at [param index] to [param type]. See also [enum ReferenceType].
+			</description>
+		</method>
 		<method name="set_setting_count">
 			<return type="void" />
 			<param index="0" name="count" type="int" />
@@ -108,4 +140,13 @@
 			</description>
 		</method>
 	</methods>
+	<constants>
+		<constant name="REFERENCE_TYPE_BONE" value="0" enum="ReferenceType">
+			The reference target is a bone. In this case, the reference target spaces is local space.
+		</constant>
+		<constant name="REFERENCE_TYPE_NODE" value="1" enum="ReferenceType">
+			The reference target is a [Node3D]. In this case, the reference target spaces is model space.
+			In other words, the reference target's coordinates are treated as if it were placed directly under [Skeleton3D] which parent of the [BoneConstraint3D].
+		</constant>
+	</constants>
 </class>

doc/classes/ConvertTransformModifier3D.xml

@@ -14,6 +14,7 @@
 		- Extract reference pose absolutely and add it to the apply bone's pose.
 		[b]Not Relative + Not Additive:[/b]
 		- Extract reference pose absolutely and the apply bone's pose is replaced with it.
+		[b]Note:[/b] Relative option is available only in the case [method BoneConstraint3D.get_reference_type] is [constant BoneConstraint3D.REFERENCE_TYPE_BONE]. See also [enum BoneConstraint3D.ReferenceType].
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/CopyTransformModifier3D.xml

@@ -14,6 +14,7 @@
 		- Extract reference pose absolutely and add it to the apply bone's pose.
 		[b]Not Relative + Not Additive:[/b]
 		- Extract reference pose absolutely and the apply bone's pose is replaced with it.
+		[b]Note:[/b] Relative option is available only in the case [method BoneConstraint3D.get_reference_type] is [constant BoneConstraint3D.REFERENCE_TYPE_BONE]. See also [enum BoneConstraint3D.ReferenceType].
 	</description>
 	<tutorials>
 	</tutorials>

scene/3d/aim_modifier_3d.cpp

@@ -37,7 +37,7 @@ bool AimModifier3D::_set(const StringName &p_path, const Variant &p_value) {
 	if (path.begins_with("settings/")) {
 		int which = path.get_slicec('/', 1).to_int();
 		String what = path.get_slicec('/', 2);
-		ERR_FAIL_INDEX_V(which, settings.size(), false);
+		ERR_FAIL_INDEX_V(which, (int)settings.size(), false);
 
 		if (what == "forward_axis") {
 			set_forward_axis(which, static_cast<BoneAxis>((int)p_value));
@@ -60,7 +60,7 @@ bool AimModifier3D::_get(const StringName &p_path, Variant &r_ret) const {
 	if (path.begins_with("settings/")) {
 		int which = path.get_slicec('/', 1).to_int();
 		String what = path.get_slicec('/', 2);
-		ERR_FAIL_INDEX_V(which, settings.size(), false);
+		ERR_FAIL_INDEX_V(which, (int)settings.size(), false);
 
 		if (what == "forward_axis") {
 			r_ret = (int)get_forward_axis(which);
@@ -80,7 +80,7 @@ bool AimModifier3D::_get(const StringName &p_path, Variant &r_ret) const {
 void AimModifier3D::_get_property_list(List<PropertyInfo> *p_list) const {
 	BoneConstraint3D::get_property_list(p_list);
 
-	for (int i = 0; i < settings.size(); i++) {
+	for (uint32_t i = 0; i < settings.size(); i++) {
 		String path = "settings/" + itos(i) + "/";
 		int rotation_usage = is_using_euler(i) ? PROPERTY_USAGE_DEFAULT : PROPERTY_USAGE_NONE;
 
@@ -93,7 +93,7 @@ void AimModifier3D::_get_property_list(List<PropertyInfo> *p_list) const {
 
 PackedStringArray AimModifier3D::get_configuration_warnings() const {
 	PackedStringArray warnings = BoneConstraint3D::get_configuration_warnings();
-	for (int i = 0; i < settings.size(); i++) {
+	for (uint32_t i = 0; i < settings.size(); i++) {
 		if (is_using_euler(i) && get_axis_from_bone_axis(get_forward_axis(i)) == get_primary_rotation_axis(i)) {
 			warnings.push_back(vformat(RTR("Forward axis and primary rotation axis must not be parallel in setting %s."), itos(i)));
 		}
@@ -103,57 +103,57 @@ PackedStringArray AimModifier3D::get_configuration_warnings() const {
 }
 
 void AimModifier3D::_validate_setting(int p_index) {
-	settings.write[p_index] = memnew(AimModifier3DSetting);
+	settings[p_index] = memnew(AimModifier3DSetting);
 }
 
 void AimModifier3D::set_forward_axis(int p_index, BoneAxis p_axis) {
-	ERR_FAIL_INDEX(p_index, settings.size());
+	ERR_FAIL_INDEX(p_index, (int)settings.size());
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	setting->forward_axis = p_axis;
 	update_configuration_warnings();
 }
 
 SkeletonModifier3D::BoneAxis AimModifier3D::get_forward_axis(int p_index) const {
-	ERR_FAIL_INDEX_V(p_index, settings.size(), BONE_AXIS_PLUS_Y);
+	ERR_FAIL_INDEX_V(p_index, (int)settings.size(), BONE_AXIS_PLUS_Y);
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	return setting->forward_axis;
 }
 
 void AimModifier3D::set_use_euler(int p_index, bool p_enabled) {
-	ERR_FAIL_INDEX(p_index, settings.size());
+	ERR_FAIL_INDEX(p_index, (int)settings.size());
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	setting->use_euler = p_enabled;
 	notify_property_list_changed();
 	update_configuration_warnings();
 }
 
 bool AimModifier3D::is_using_euler(int p_index) const {
-	ERR_FAIL_INDEX_V(p_index, settings.size(), false);
+	ERR_FAIL_INDEX_V(p_index, (int)settings.size(), false);
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	return setting->use_euler;
 }
 
 void AimModifier3D::set_primary_rotation_axis(int p_index, Vector3::Axis p_axis) {
-	ERR_FAIL_INDEX(p_index, settings.size());
+	ERR_FAIL_INDEX(p_index, (int)settings.size());
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	setting->primary_rotation_axis = p_axis;
 	update_configuration_warnings();
 }
 
 Vector3::Axis AimModifier3D::get_primary_rotation_axis(int p_index) const {
-	ERR_FAIL_INDEX_V(p_index, settings.size(), Vector3::AXIS_X);
+	ERR_FAIL_INDEX_V(p_index, (int)settings.size(), Vector3::AXIS_X);
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	return setting->primary_rotation_axis;
 }
 
 void AimModifier3D::set_use_secondary_rotation(int p_index, bool p_enabled) {
-	ERR_FAIL_INDEX(p_index, settings.size());
+	ERR_FAIL_INDEX(p_index, (int)settings.size());
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	setting->use_secondary_rotation = p_enabled;
 }
 
 bool AimModifier3D::is_using_secondary_rotation(int p_index) const {
-	ERR_FAIL_INDEX_V(p_index, settings.size(), false);
+	ERR_FAIL_INDEX_V(p_index, (int)settings.size(), false);
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 	return setting->use_secondary_rotation;
 }
@@ -171,16 +171,28 @@ void AimModifier3D::_bind_methods() {
 	ADD_ARRAY_COUNT("Settings", "setting_count", "set_setting_count", "get_setting_count", "settings/");
 }
 
-void AimModifier3D::_process_constraint(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, int p_reference_bone, float p_amount) {
+void AimModifier3D::_process_constraint_by_bone(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, int p_reference_bone, float p_amount) {
 	if (p_apply_bone == p_reference_bone) {
 		ERR_PRINT_ONCE_ED(vformat("In setting %s, the reference bone must not be same with the apply bone.", itos(p_index)));
 		return;
 	}
+	Vector3 reference_origin = p_skeleton->get_bone_global_pose(p_reference_bone).origin;
+	_process_aim(p_index, p_skeleton, p_apply_bone, reference_origin, p_amount);
+}
 
+void AimModifier3D::_process_constraint_by_node(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, const NodePath &p_reference_node, float p_amount) {
+	Node3D *nd = Object::cast_to<Node3D>(get_node_or_null(p_reference_node));
+	if (!nd) {
+		return;
+	}
+	Vector3 reference_origin = nd->get_global_transform_interpolated().origin - p_skeleton->get_global_transform_interpolated().origin;
+	_process_aim(p_index, p_skeleton, p_apply_bone, reference_origin, p_amount);
+}
+
+void AimModifier3D::_process_aim(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, Vector3 p_target, float p_amount) {
 	AimModifier3DSetting *setting = static_cast<AimModifier3DSetting *>(settings[p_index]);
 
 	// Prepare forward_vector and rest.
-	Vector3 reference_origin = p_skeleton->get_bone_global_pose(p_reference_bone).origin;
 	Transform3D src_bone_rest = p_skeleton->get_bone_rest(p_apply_bone);
 	Transform3D bone_rest_space;
 	int parent_bone = p_skeleton->get_bone_parent(p_apply_bone);
@@ -190,7 +202,7 @@ void AimModifier3D::_process_constraint(int p_index, Skeleton3D *p_skeleton, int
 		bone_rest_space = p_skeleton->get_bone_global_pose(parent_bone);
 		bone_rest_space.translate_local(src_bone_rest.origin);
 	}
-	Vector3 forward_vector = bone_rest_space.basis.get_rotation_quaternion().xform_inv(reference_origin - bone_rest_space.origin);
+	Vector3 forward_vector = bone_rest_space.basis.get_rotation_quaternion().xform_inv(p_target - bone_rest_space.origin);
 	if (forward_vector.is_zero_approx()) {
 		return;
 	}

scene/3d/aim_modifier_3d.h

@@ -51,7 +51,9 @@ class AimModifier3D : public BoneConstraint3D {
 
 	static void _bind_methods();
 
-	virtual void _process_constraint(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, int p_reference_bone, float p_amount) override;
+	virtual void _process_constraint_by_bone(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, int p_reference_bone, float p_amount) override;
+	virtual void _process_constraint_by_node(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, const NodePath &p_reference_node, float p_amount) override;
+	virtual void _process_aim(int p_index, Skeleton3D *p_skeleton, int p_apply_bone, Vector3 p_target, float p_amount);
 	virtual void _validate_setting(int p_index) override;
 
 public: