5ffed49907
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
97 lines
3.8 KiB
C++
97 lines
3.8 KiB
C++
/*************************************************************************/
|
|
/* bone_attachment_3d.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef BONE_ATTACHMENT_H
|
|
#define BONE_ATTACHMENT_H
|
|
|
|
#include "scene/3d/skeleton_3d.h"
|
|
|
|
class BoneAttachment3D : public Node3D {
|
|
GDCLASS(BoneAttachment3D, Node3D);
|
|
|
|
bool bound = false;
|
|
String bone_name;
|
|
int bone_idx = -1;
|
|
|
|
bool override_pose = false;
|
|
int override_mode = 0;
|
|
bool _override_dirty = false;
|
|
|
|
enum OVERRIDE_MODES {
|
|
MODE_GLOBAL_POSE,
|
|
MODE_LOCAL_POSE,
|
|
MODE_CUSTOM_POSE
|
|
};
|
|
|
|
bool use_external_skeleton = false;
|
|
NodePath external_skeleton_node;
|
|
ObjectID external_skeleton_node_cache;
|
|
|
|
void _check_bind();
|
|
void _check_unbind();
|
|
|
|
void _transform_changed();
|
|
void _update_external_skeleton_cache();
|
|
Skeleton3D *_get_skeleton3d();
|
|
|
|
protected:
|
|
virtual void _validate_property(PropertyInfo &property) const override;
|
|
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;
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
virtual TypedArray<String> get_configuration_warnings() const override;
|
|
|
|
void set_bone_name(const String &p_name);
|
|
String get_bone_name() const;
|
|
|
|
void set_bone_idx(const int &p_idx);
|
|
int get_bone_idx() const;
|
|
|
|
void set_override_pose(bool p_override);
|
|
bool get_override_pose() const;
|
|
void set_override_mode(int p_mode);
|
|
int get_override_mode() const;
|
|
|
|
void set_use_external_skeleton(bool p_external_skeleton);
|
|
bool get_use_external_skeleton() const;
|
|
void set_external_skeleton(NodePath p_skeleton);
|
|
NodePath get_external_skeleton() const;
|
|
|
|
virtual void on_bone_pose_update(int p_bone_index);
|
|
|
|
BoneAttachment3D();
|
|
};
|
|
|
|
#endif // BONE_ATTACHMENT_H
|