New and improved IK system for Skeleton3D
This PR and commit adds a new IK system for 3D with the Skeleton3D node
that adds several new IK solvers, as well as additional changes and functionality
for making bone manipulation in Godot easier.
This work was sponsored by GSoC 2020 and TwistedTwigleg
Full list of changes:
* Adds a SkeletonModification3D resource
* This resource is the base where all IK code is written and executed
* Adds a SkeletonModificationStack3D resource
* This node oversees the execution of the modifications and acts as a bridge of sorts for the modifications to the Skeleton3D node
* Adds SkeletonModification3D resources for LookAt, CCDIK, FABRIK, Jiggle, and TwoBoneIK
* Each modification is in it's own file
* Several changes to Skeletons, listed below:
* Added local_pose_override, which acts just like global_pose_override but keeps bone-child relationships intract
* So if you move a bone using local_pose_override, all of the bones that are children will also be moved. This is different than global_pose_override, which only affects the individual bone
* Internally bones keep track of their children. This removes the need of a processing list, makes it possible to update just a few select bones at a time, and makes it easier to traverse down the bone chain
* Additional functions added for converting from world transform to global poses, global poses to local poses, and all the same changes but backwards (local to global, global to world). This makes it much easier to work with bone transforms without needing to think too much about how to convert them.
* New signal added, bone_pose_changed, that can be used to tell if a specific bone changed its transform. Needed for BoneAttachment3D
* Added functions for getting the forward position of a bone
* BoneAttachment3D node refactored heavily
* BoneAttachment3D node is now completely standalone in its functionality.
* This makes the code easier and less interconnected, as well as allowing them to function properly without being direct children of Skeleton3D nodes
* BoneAttachment3D now can be set either using the index or the bone name.
* BoneAttachment3D nodes can now set the bone transform instead of just following it. This is disabled by default for compatibility
* BoneAttachment3D now shows a warning when not configured correctly
* Added rotate_to_align function in Basis
* Added class reference documentation for all changes
2020-08-03 21:22:34 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* skeleton_modification_3d_twoboneik.h */
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* This file is part of: */
|
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
|
/* https://godotengine.org */
|
|
|
|
|
/*************************************************************************/
|
2022-01-03 20:27:34 +00:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
New and improved IK system for Skeleton3D
This PR and commit adds a new IK system for 3D with the Skeleton3D node
that adds several new IK solvers, as well as additional changes and functionality
for making bone manipulation in Godot easier.
This work was sponsored by GSoC 2020 and TwistedTwigleg
Full list of changes:
* Adds a SkeletonModification3D resource
* This resource is the base where all IK code is written and executed
* Adds a SkeletonModificationStack3D resource
* This node oversees the execution of the modifications and acts as a bridge of sorts for the modifications to the Skeleton3D node
* Adds SkeletonModification3D resources for LookAt, CCDIK, FABRIK, Jiggle, and TwoBoneIK
* Each modification is in it's own file
* Several changes to Skeletons, listed below:
* Added local_pose_override, which acts just like global_pose_override but keeps bone-child relationships intract
* So if you move a bone using local_pose_override, all of the bones that are children will also be moved. This is different than global_pose_override, which only affects the individual bone
* Internally bones keep track of their children. This removes the need of a processing list, makes it possible to update just a few select bones at a time, and makes it easier to traverse down the bone chain
* Additional functions added for converting from world transform to global poses, global poses to local poses, and all the same changes but backwards (local to global, global to world). This makes it much easier to work with bone transforms without needing to think too much about how to convert them.
* New signal added, bone_pose_changed, that can be used to tell if a specific bone changed its transform. Needed for BoneAttachment3D
* Added functions for getting the forward position of a bone
* BoneAttachment3D node refactored heavily
* BoneAttachment3D node is now completely standalone in its functionality.
* This makes the code easier and less interconnected, as well as allowing them to function properly without being direct children of Skeleton3D nodes
* BoneAttachment3D now can be set either using the index or the bone name.
* BoneAttachment3D nodes can now set the bone transform instead of just following it. This is disabled by default for compatibility
* BoneAttachment3D now shows a warning when not configured correctly
* Added rotate_to_align function in Basis
* Added class reference documentation for all changes
2020-08-03 21:22:34 +00:00
|
|
|
/* */
|
|
|
|
|
/* 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. */
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
2022-07-23 21:41:51 +00:00
|
|
|
#ifndef SKELETON_MODIFICATION_3D_TWOBONEIK_H
|
|
|
|
|
#define SKELETON_MODIFICATION_3D_TWOBONEIK_H
|
New and improved IK system for Skeleton3D
This PR and commit adds a new IK system for 3D with the Skeleton3D node
that adds several new IK solvers, as well as additional changes and functionality
for making bone manipulation in Godot easier.
This work was sponsored by GSoC 2020 and TwistedTwigleg
Full list of changes:
* Adds a SkeletonModification3D resource
* This resource is the base where all IK code is written and executed
* Adds a SkeletonModificationStack3D resource
* This node oversees the execution of the modifications and acts as a bridge of sorts for the modifications to the Skeleton3D node
* Adds SkeletonModification3D resources for LookAt, CCDIK, FABRIK, Jiggle, and TwoBoneIK
* Each modification is in it's own file
* Several changes to Skeletons, listed below:
* Added local_pose_override, which acts just like global_pose_override but keeps bone-child relationships intract
* So if you move a bone using local_pose_override, all of the bones that are children will also be moved. This is different than global_pose_override, which only affects the individual bone
* Internally bones keep track of their children. This removes the need of a processing list, makes it possible to update just a few select bones at a time, and makes it easier to traverse down the bone chain
* Additional functions added for converting from world transform to global poses, global poses to local poses, and all the same changes but backwards (local to global, global to world). This makes it much easier to work with bone transforms without needing to think too much about how to convert them.
* New signal added, bone_pose_changed, that can be used to tell if a specific bone changed its transform. Needed for BoneAttachment3D
* Added functions for getting the forward position of a bone
* BoneAttachment3D node refactored heavily
* BoneAttachment3D node is now completely standalone in its functionality.
* This makes the code easier and less interconnected, as well as allowing them to function properly without being direct children of Skeleton3D nodes
* BoneAttachment3D now can be set either using the index or the bone name.
* BoneAttachment3D nodes can now set the bone transform instead of just following it. This is disabled by default for compatibility
* BoneAttachment3D now shows a warning when not configured correctly
* Added rotate_to_align function in Basis
* Added class reference documentation for all changes
2020-08-03 21:22:34 +00:00
|
|
|
|
2022-08-20 00:18:47 +00:00
|
|
|
#include "scene/3d/skeleton_3d.h"
|
|
|
|
|
#include "scene/resources/skeleton_modification_3d.h"
|
|
|
|
|
|
New and improved IK system for Skeleton3D
This PR and commit adds a new IK system for 3D with the Skeleton3D node
that adds several new IK solvers, as well as additional changes and functionality
for making bone manipulation in Godot easier.
This work was sponsored by GSoC 2020 and TwistedTwigleg
Full list of changes:
* Adds a SkeletonModification3D resource
* This resource is the base where all IK code is written and executed
* Adds a SkeletonModificationStack3D resource
* This node oversees the execution of the modifications and acts as a bridge of sorts for the modifications to the Skeleton3D node
* Adds SkeletonModification3D resources for LookAt, CCDIK, FABRIK, Jiggle, and TwoBoneIK
* Each modification is in it's own file
* Several changes to Skeletons, listed below:
* Added local_pose_override, which acts just like global_pose_override but keeps bone-child relationships intract
* So if you move a bone using local_pose_override, all of the bones that are children will also be moved. This is different than global_pose_override, which only affects the individual bone
* Internally bones keep track of their children. This removes the need of a processing list, makes it possible to update just a few select bones at a time, and makes it easier to traverse down the bone chain
* Additional functions added for converting from world transform to global poses, global poses to local poses, and all the same changes but backwards (local to global, global to world). This makes it much easier to work with bone transforms without needing to think too much about how to convert them.
* New signal added, bone_pose_changed, that can be used to tell if a specific bone changed its transform. Needed for BoneAttachment3D
* Added functions for getting the forward position of a bone
* BoneAttachment3D node refactored heavily
* BoneAttachment3D node is now completely standalone in its functionality.
* This makes the code easier and less interconnected, as well as allowing them to function properly without being direct children of Skeleton3D nodes
* BoneAttachment3D now can be set either using the index or the bone name.
* BoneAttachment3D nodes can now set the bone transform instead of just following it. This is disabled by default for compatibility
* BoneAttachment3D now shows a warning when not configured correctly
* Added rotate_to_align function in Basis
* Added class reference documentation for all changes
2020-08-03 21:22:34 +00:00
|
|
|
class SkeletonModification3DTwoBoneIK : public SkeletonModification3D {
|
|
|
|
|
GDCLASS(SkeletonModification3DTwoBoneIK, SkeletonModification3D);
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
NodePath target_node;
|
|
|
|
|
ObjectID target_node_cache;
|
|
|
|
|
|
|
|
|
|
bool use_tip_node = false;
|
|
|
|
|
NodePath tip_node;
|
|
|
|
|
ObjectID tip_node_cache;
|
|
|
|
|
|
|
|
|
|
bool use_pole_node = false;
|
|
|
|
|
NodePath pole_node;
|
|
|
|
|
ObjectID pole_node_cache;
|
|
|
|
|
|
|
|
|
|
String joint_one_bone_name = "";
|
|
|
|
|
int joint_one_bone_idx = -1;
|
|
|
|
|
String joint_two_bone_name = "";
|
|
|
|
|
int joint_two_bone_idx = -1;
|
|
|
|
|
|
|
|
|
|
bool auto_calculate_joint_length = false;
|
|
|
|
|
real_t joint_one_length = -1;
|
|
|
|
|
real_t joint_two_length = -1;
|
|
|
|
|
|
|
|
|
|
real_t joint_one_roll = 0;
|
|
|
|
|
real_t joint_two_roll = 0;
|
|
|
|
|
|
|
|
|
|
void update_cache_target();
|
|
|
|
|
void update_cache_tip();
|
|
|
|
|
void update_cache_pole();
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
bool _get(const StringName &p_path, Variant &r_ret) const;
|
|
|
|
|
bool _set(const StringName &p_path, const Variant &p_value);
|
|
|
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
virtual void _execute(real_t p_delta) override;
|
|
|
|
|
virtual void _setup_modification(SkeletonModificationStack3D *p_stack) override;
|
|
|
|
|
|
|
|
|
|
void set_target_node(const NodePath &p_target_node);
|
|
|
|
|
NodePath get_target_node() const;
|
|
|
|
|
|
|
|
|
|
void set_use_tip_node(const bool p_use_tip_node);
|
|
|
|
|
bool get_use_tip_node() const;
|
|
|
|
|
void set_tip_node(const NodePath &p_tip_node);
|
|
|
|
|
NodePath get_tip_node() const;
|
|
|
|
|
|
|
|
|
|
void set_use_pole_node(const bool p_use_pole_node);
|
|
|
|
|
bool get_use_pole_node() const;
|
|
|
|
|
void set_pole_node(const NodePath &p_pole_node);
|
|
|
|
|
NodePath get_pole_node() const;
|
|
|
|
|
|
|
|
|
|
void set_auto_calculate_joint_length(bool p_calculate);
|
|
|
|
|
bool get_auto_calculate_joint_length() const;
|
|
|
|
|
void calculate_joint_lengths();
|
|
|
|
|
|
|
|
|
|
void set_joint_one_bone_name(String p_bone_name);
|
|
|
|
|
String get_joint_one_bone_name() const;
|
|
|
|
|
void set_joint_one_bone_idx(int p_bone_idx);
|
|
|
|
|
int get_joint_one_bone_idx() const;
|
|
|
|
|
void set_joint_one_length(real_t p_length);
|
|
|
|
|
real_t get_joint_one_length() const;
|
|
|
|
|
|
|
|
|
|
void set_joint_two_bone_name(String p_bone_name);
|
|
|
|
|
String get_joint_two_bone_name() const;
|
|
|
|
|
void set_joint_two_bone_idx(int p_bone_idx);
|
|
|
|
|
int get_joint_two_bone_idx() const;
|
|
|
|
|
void set_joint_two_length(real_t p_length);
|
|
|
|
|
real_t get_joint_two_length() const;
|
|
|
|
|
|
|
|
|
|
void set_joint_one_roll(real_t p_roll);
|
|
|
|
|
real_t get_joint_one_roll() const;
|
|
|
|
|
void set_joint_two_roll(real_t p_roll);
|
|
|
|
|
real_t get_joint_two_roll() const;
|
|
|
|
|
|
|
|
|
|
SkeletonModification3DTwoBoneIK();
|
|
|
|
|
~SkeletonModification3DTwoBoneIK();
|
|
|
|
|
};
|
|
|
|
|
|
2022-07-23 21:41:51 +00:00
|
|
|
#endif // SKELETON_MODIFICATION_3D_TWOBONEIK_H
|
