Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow users to override SkeletonModifier3D._process_modification #91507

Merged
merged 1 commit into from
May 10, 2024
+14 −2
Merged

Allow users to override SkeletonModifier3D._process_modification #91507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/classes/SkeletonModifier3D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,19 @@
<description>
[SkeletonModifier3D] retrieves a target [Skeleton3D] by having a [Skeleton3D] parent.
If there is [AnimationMixer], modification always performs after playback process of the [AnimationMixer].
This node should be used to implement custom IK solvers, constraints, or skeleton physics
</description>
<tutorials>
</tutorials>
<methods>
<method name="_process_modification" qualifiers="virtual">
<return type="void" />
<description>
Override this virtual method to implement a custom skeleton modifier. You should do things like get the [Skeleton3D]'s current pose and apply the pose here.
[method _process_modification] must not apply [member influence] to bone poses because the [Skeleton3D] automatically applies influence to all bone poses set by the modifier.
</description>
</method>
</methods>
<members>
<member name="active" type="bool" setter="set_active" getter="is_active" default="true">
If [code]true[/code], the [SkeletonModifier3D] will be processing.
Expand Down
3 changes: 2 additions & 1 deletion scene/3d/skeleton_modifier_3d.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ void SkeletonModifier3D::process_modification() {
}

void SkeletonModifier3D::_process_modification() {
//
GDVIRTUAL_CALL(_process_modification);
}

void SkeletonModifier3D::_notification(int p_what) {
Expand All @@ -133,6 +133,7 @@ void SkeletonModifier3D::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "influence", PROPERTY_HINT_RANGE, "0,1,0.001"), "set_influence", "get_influence");

ADD_SIGNAL(MethodInfo("modification_processed"));
GDVIRTUAL_BIND(_process_modification);
}

SkeletonModifier3D::SkeletonModifier3D() {
Expand Down
1 change: 1 addition & 0 deletions scene/3d/skeleton_modifier_3d.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ class SkeletonModifier3D : public Node3D {
virtual void _set_active(bool p_active);

virtual void _process_modification();
GDVIRTUAL0(_process_modification);

public:
virtual PackedStringArray get_configuration_warnings() const override;
Expand Down
2 changes: 1 addition & 1 deletion scene/register_scene_types.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,7 @@ void register_scene_types() {
GDREGISTER_CLASS(CPUParticles3D);
GDREGISTER_CLASS(Marker3D);
GDREGISTER_CLASS(RootMotionView);
GDREGISTER_ABSTRACT_CLASS(SkeletonModifier3D);
GDREGISTER_VIRTUAL_CLASS(SkeletonModifier3D);

OS::get_singleton()->yield(); // may take time to init

Expand Down