mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2025-01-24 18:17:21 +01:00
Backported some of the improvemnents to BoneAttachment from Godot4.
This commit is contained in:
parent
5fa6f5e5fb
commit
2d2dfb6a84
@ -30,6 +30,199 @@
|
||||
|
||||
#include "bone_attachment.h"
|
||||
|
||||
void BoneAttachment::set_bone_name(const String &p_name) {
|
||||
bone_name = p_name;
|
||||
Skeleton *sk = _get_skeleton();
|
||||
if (sk) {
|
||||
set_bone_idx(sk->find_bone(bone_name));
|
||||
}
|
||||
}
|
||||
|
||||
String BoneAttachment::get_bone_name() const {
|
||||
return bone_name;
|
||||
}
|
||||
|
||||
void BoneAttachment::set_bone_idx(const int p_idx) {
|
||||
if (is_inside_tree()) {
|
||||
_check_unbind();
|
||||
}
|
||||
|
||||
bone_idx = p_idx;
|
||||
|
||||
Skeleton *sk = _get_skeleton();
|
||||
|
||||
if (sk) {
|
||||
if (bone_idx <= -1 || bone_idx >= sk->get_bone_count()) {
|
||||
WARN_PRINT("Bone index out of range! Cannot connect BoneAttachment to node!");
|
||||
bone_idx = -1;
|
||||
} else {
|
||||
bone_name = sk->get_bone_name(bone_idx);
|
||||
}
|
||||
}
|
||||
|
||||
if (is_inside_tree()) {
|
||||
_check_bind();
|
||||
}
|
||||
|
||||
property_list_changed_notify();
|
||||
}
|
||||
|
||||
int BoneAttachment::get_bone_idx() const {
|
||||
return bone_idx;
|
||||
}
|
||||
|
||||
/*
|
||||
void BoneAttachment::set_override_pose(bool p_override) {
|
||||
override_pose = p_override;
|
||||
set_notify_local_transform(override_pose);
|
||||
set_process_internal(override_pose);
|
||||
|
||||
if (!override_pose) {
|
||||
Skeleton *sk = _get_skeleton();
|
||||
if (sk) {
|
||||
if (override_mode == OVERRIDE_MODES::MODE_GLOBAL_POSE) {
|
||||
sk->set_bone_global_pose_override(bone_idx, Transform(), 0.0, false);
|
||||
//} else if (override_mode == OVERRIDE_MODES::MODE_LOCAL_POSE) {
|
||||
// sk->set_bone_local_pose_override(bone_idx, Transform(), 0.0, false);
|
||||
}
|
||||
}
|
||||
_transform_changed();
|
||||
}
|
||||
|
||||
property_list_changed_notify();
|
||||
}
|
||||
|
||||
bool BoneAttachment::get_override_pose() const {
|
||||
return override_pose;
|
||||
}
|
||||
|
||||
void BoneAttachment::set_override_mode(int p_mode) {
|
||||
if (override_pose) {
|
||||
Skeleton *sk = _get_skeleton();
|
||||
if (sk) {
|
||||
if (override_mode == OVERRIDE_MODES::MODE_GLOBAL_POSE) {
|
||||
sk->set_bone_global_pose_override(bone_idx, Transform(), 0.0, false);
|
||||
//} else if (override_mode == OVERRIDE_MODES::MODE_LOCAL_POSE) {
|
||||
// sk->set_bone_local_pose_override(bone_idx, Transform(), 0.0, false);
|
||||
}
|
||||
}
|
||||
|
||||
override_mode = p_mode;
|
||||
_transform_changed();
|
||||
return;
|
||||
}
|
||||
override_mode = p_mode;
|
||||
}
|
||||
|
||||
int BoneAttachment::get_override_mode() const {
|
||||
return override_mode;
|
||||
}
|
||||
*/
|
||||
|
||||
void BoneAttachment::set_use_external_skeleton(bool p_use_external) {
|
||||
use_external_skeleton = p_use_external;
|
||||
|
||||
if (use_external_skeleton) {
|
||||
_check_unbind();
|
||||
_update_external_skeleton_cache();
|
||||
_check_bind();
|
||||
//_transform_changed();
|
||||
}
|
||||
|
||||
property_list_changed_notify();
|
||||
}
|
||||
|
||||
bool BoneAttachment::get_use_external_skeleton() const {
|
||||
return use_external_skeleton;
|
||||
}
|
||||
|
||||
void BoneAttachment::set_external_skeleton(NodePath p_path) {
|
||||
external_skeleton_node = p_path;
|
||||
_update_external_skeleton_cache();
|
||||
property_list_changed_notify();
|
||||
}
|
||||
|
||||
NodePath BoneAttachment::get_external_skeleton() const {
|
||||
return external_skeleton_node;
|
||||
}
|
||||
|
||||
/*
|
||||
void BoneAttachment::on_bone_pose_update(int p_bone_index) {
|
||||
if (bone_idx == p_bone_index) {
|
||||
Skeleton *sk = _get_skeleton();
|
||||
if (sk) {
|
||||
if (!override_pose) {
|
||||
if (use_external_skeleton) {
|
||||
set_global_transform(sk->global_pose_to_world_transform(sk->get_bone_global_pose(bone_idx)));
|
||||
} else {
|
||||
set_transform(sk->get_bone_global_pose(bone_idx));
|
||||
}
|
||||
} else {
|
||||
if (!_override_dirty) {
|
||||
_transform_changed();
|
||||
_override_dirty = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
String BoneAttachment::get_configuration_warning() const {
|
||||
String warnings = Spatial::get_configuration_warning();
|
||||
|
||||
if (use_external_skeleton) {
|
||||
if (external_skeleton_node_cache == 0) {
|
||||
warnings += RTR("External Skeleton3D node not set! Please set a path to an external Skeleton3D node.");
|
||||
}
|
||||
} else {
|
||||
Skeleton *parent = Object::cast_to<Skeleton>(get_parent());
|
||||
if (!parent) {
|
||||
warnings += RTR("Parent node is not a Skeleton3D node! Please use an external Skeleton3D if you intend to use the BoneAttachment3D without it being a child of a Skeleton3D node.");
|
||||
}
|
||||
}
|
||||
|
||||
if (bone_idx == -1) {
|
||||
warnings += RTR("BoneAttachment3D node is not bound to any bones! Please select a bone to attach this node.");
|
||||
}
|
||||
|
||||
return warnings;
|
||||
}
|
||||
|
||||
BoneAttachment::BoneAttachment() {
|
||||
bound = false;
|
||||
bone_idx = -1;
|
||||
//override_pose = false;
|
||||
//override_mode = 0;
|
||||
//_override_dirty = false;
|
||||
use_external_skeleton = false;
|
||||
external_skeleton_node_cache = 0;
|
||||
|
||||
//set_notify_transform(true);
|
||||
}
|
||||
|
||||
void BoneAttachment::_notification(int p_what) {
|
||||
switch (p_what) {
|
||||
case NOTIFICATION_ENTER_TREE: {
|
||||
if (use_external_skeleton) {
|
||||
_update_external_skeleton_cache();
|
||||
}
|
||||
_check_bind();
|
||||
} break;
|
||||
case NOTIFICATION_EXIT_TREE: {
|
||||
_check_unbind();
|
||||
} break;
|
||||
//case NOTIFICATION_LOCAL_TRANSFORM_CHANGED: {
|
||||
// _transform_changed();
|
||||
//} break;
|
||||
//case NOTIFICATION_INTERNAL_PROCESS: {
|
||||
// if (_override_dirty) {
|
||||
// _override_dirty = false;
|
||||
// }
|
||||
//} break;
|
||||
}
|
||||
}
|
||||
|
||||
void BoneAttachment::_validate_property(PropertyInfo &property) const {
|
||||
if (property.name == "bone_name") {
|
||||
Skeleton *parent = Object::cast_to<Skeleton>(get_parent());
|
||||
@ -52,6 +245,104 @@ void BoneAttachment::_validate_property(PropertyInfo &property) const {
|
||||
}
|
||||
}
|
||||
|
||||
void BoneAttachment::_validate_property(PropertyInfo &property) const {
|
||||
if (property.name == "bone_name") {
|
||||
// Because it is a constant function, we cannot use the _get_skeleton_3d function.
|
||||
const Skeleton *parent = nullptr;
|
||||
if (use_external_skeleton) {
|
||||
if (external_skeleton_node_cache != 0) {
|
||||
parent = Object::cast_to<Skeleton>(ObjectDB::get_instance(external_skeleton_node_cache));
|
||||
}
|
||||
} else {
|
||||
parent = Object::cast_to<Skeleton>(get_parent());
|
||||
}
|
||||
|
||||
if (parent) {
|
||||
String names;
|
||||
for (int i = 0; i < parent->get_bone_count(); i++) {
|
||||
if (i > 0) {
|
||||
names += ",";
|
||||
}
|
||||
names += parent->get_bone_name(i);
|
||||
}
|
||||
|
||||
property.hint = PROPERTY_HINT_ENUM;
|
||||
property.hint_string = names;
|
||||
} else {
|
||||
property.hint = PROPERTY_HINT_NONE;
|
||||
property.hint_string = "";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool BoneAttachment::_set(const StringName &p_path, const Variant &p_value) {
|
||||
//if (p_path == SNAME("override_pose")) {
|
||||
// set_override_pose(p_value);
|
||||
//} else if (p_path == SNAME("override_mode")) {
|
||||
// set_override_mode(p_value);
|
||||
//} else
|
||||
if (p_path == SNAME("use_external_skeleton")) {
|
||||
set_use_external_skeleton(p_value);
|
||||
} else if (p_path == SNAME("external_skeleton")) {
|
||||
set_external_skeleton(p_value);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool BoneAttachment::_get(const StringName &p_path, Variant &r_ret) const {
|
||||
//if (p_path == SNAME("override_pose")) {
|
||||
// r_ret = get_override_pose();
|
||||
//} else if (p_path == SNAME("override_mode")) {
|
||||
// r_ret = get_override_mode();
|
||||
//} else
|
||||
if (p_path == SNAME("use_external_skeleton")) {
|
||||
r_ret = get_use_external_skeleton();
|
||||
} else if (p_path == SNAME("external_skeleton")) {
|
||||
r_ret = get_external_skeleton();
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
void BoneAttachment::_get_property_list(List<PropertyInfo> *p_list) const {
|
||||
/*
|
||||
p_list->push_back(PropertyInfo(Variant::BOOL, "override_pose", PROPERTY_HINT_NONE, ""));
|
||||
if (override_pose) {
|
||||
p_list->push_back(PropertyInfo(Variant::INT, "override_mode", PROPERTY_HINT_ENUM, "Global Pose Override, Local Pose Override, Custom Pose"));
|
||||
}
|
||||
*/
|
||||
|
||||
p_list->push_back(PropertyInfo(Variant::BOOL, "use_external_skeleton", PROPERTY_HINT_NONE, ""));
|
||||
if (use_external_skeleton) {
|
||||
p_list->push_back(PropertyInfo(Variant::NODE_PATH, "external_skeleton", PROPERTY_HINT_NODE_PATH_VALID_TYPES, "Skeleton3D"));
|
||||
}
|
||||
}
|
||||
|
||||
void BoneAttachment::_bind_methods() {
|
||||
ClassDB::bind_method(D_METHOD("set_bone_name", "bone_name"), &BoneAttachment::set_bone_name);
|
||||
ClassDB::bind_method(D_METHOD("get_bone_name"), &BoneAttachment::get_bone_name);
|
||||
ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "bone_name"), "set_bone_name", "get_bone_name");
|
||||
|
||||
ClassDB::bind_method(D_METHOD("set_bone_idx", "bone_idx"), &BoneAttachment::set_bone_idx);
|
||||
ClassDB::bind_method(D_METHOD("get_bone_idx"), &BoneAttachment::get_bone_idx);
|
||||
ADD_PROPERTY(PropertyInfo(Variant::INT, "bone_idx"), "set_bone_idx", "get_bone_idx");
|
||||
|
||||
/*
|
||||
ClassDB::bind_method(D_METHOD("on_bone_pose_update", "bone_index"), &BoneAttachment::on_bone_pose_update);
|
||||
|
||||
ClassDB::bind_method(D_METHOD("set_override_pose", "override_pose"), &BoneAttachment::set_override_pose);
|
||||
ClassDB::bind_method(D_METHOD("get_override_pose"), &BoneAttachment::get_override_pose);
|
||||
ClassDB::bind_method(D_METHOD("set_override_mode", "override_mode"), &BoneAttachment::set_override_mode);
|
||||
ClassDB::bind_method(D_METHOD("get_override_mode"), &BoneAttachment::get_override_mode);
|
||||
*/
|
||||
|
||||
ClassDB::bind_method(D_METHOD("set_use_external_skeleton", "use_external_skeleton"), &BoneAttachment::set_use_external_skeleton);
|
||||
ClassDB::bind_method(D_METHOD("get_use_external_skeleton"), &BoneAttachment::get_use_external_skeleton);
|
||||
ClassDB::bind_method(D_METHOD("set_external_skeleton", "external_skeleton"), &BoneAttachment::set_external_skeleton);
|
||||
ClassDB::bind_method(D_METHOD("get_external_skeleton"), &BoneAttachment::get_external_skeleton);
|
||||
}
|
||||
|
||||
void BoneAttachment::_check_bind() {
|
||||
Skeleton *sk = Object::cast_to<Skeleton>(get_parent());
|
||||
if (sk) {
|
||||
@ -64,53 +355,107 @@ void BoneAttachment::_check_bind() {
|
||||
}
|
||||
}
|
||||
|
||||
void BoneAttachment::_check_bind() {
|
||||
Skeleton *sk = _get_skeleton();
|
||||
|
||||
if (sk && !bound) {
|
||||
if (bone_idx <= -1) {
|
||||
bone_idx = sk->find_bone(bone_name);
|
||||
}
|
||||
|
||||
if (bone_idx != -1) {
|
||||
sk->bind_child_node_to_bone(bone_idx, this);
|
||||
set_transform(sk->get_bone_global_pose(bone_idx));
|
||||
bound = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void BoneAttachment::_check_unbind() {
|
||||
if (bound) {
|
||||
Skeleton *sk = Object::cast_to<Skeleton>(get_parent());
|
||||
Skeleton *sk = _get_skeleton();
|
||||
|
||||
if (sk) {
|
||||
int idx = sk->find_bone(bone_name);
|
||||
if (idx != -1) {
|
||||
sk->unbind_child_node_from_bone(idx, this);
|
||||
|
||||
if (bone_idx != -1) {
|
||||
sk->unbind_child_node_from_bone(bone_idx, this);
|
||||
}
|
||||
}
|
||||
bound = false;
|
||||
}
|
||||
}
|
||||
|
||||
void BoneAttachment::set_bone_name(const String &p_name) {
|
||||
if (is_inside_tree()) {
|
||||
_check_unbind();
|
||||
}
|
||||
void BoneAttachment::_update_external_skeleton_cache() {
|
||||
external_skeleton_node_cache = 0;
|
||||
if (has_node(external_skeleton_node)) {
|
||||
Node *node = get_node(external_skeleton_node);
|
||||
ERR_FAIL_COND_MSG(!node, "Cannot update external skeleton cache: Node cannot be found!");
|
||||
|
||||
bone_name = p_name;
|
||||
// Make sure it's a skeleton3D
|
||||
Skeleton *sk = Object::cast_to<Skeleton>(node);
|
||||
ERR_FAIL_COND_MSG(!sk, "Cannot update external skeleton cache: Skeleton3D Nodepath does not point to a Skeleton3D node!");
|
||||
|
||||
if (is_inside_tree()) {
|
||||
_check_bind();
|
||||
external_skeleton_node_cache = node->get_instance_id();
|
||||
} else {
|
||||
if (external_skeleton_node.is_empty()) {
|
||||
BoneAttachment *parent_attachment = Object::cast_to<BoneAttachment>(get_parent());
|
||||
if (parent_attachment) {
|
||||
parent_attachment->_update_external_skeleton_cache();
|
||||
if (parent_attachment->has_node(parent_attachment->external_skeleton_node)) {
|
||||
Node *node = parent_attachment->get_node(parent_attachment->external_skeleton_node);
|
||||
ERR_FAIL_COND_MSG(!node, "Cannot update external skeleton cache: Parent's Skeleton3D node cannot be found!");
|
||||
|
||||
// Make sure it's a skeleton3D
|
||||
Skeleton *sk = Object::cast_to<Skeleton>(node);
|
||||
ERR_FAIL_COND_MSG(!sk, "Cannot update external skeleton cache: Parent Skeleton3D Nodepath does not point to a Skeleton3D node!");
|
||||
|
||||
external_skeleton_node_cache = node->get_instance_id();
|
||||
external_skeleton_node = get_path_to(node);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
String BoneAttachment::get_bone_name() const {
|
||||
return bone_name;
|
||||
Skeleton *BoneAttachment::_get_skeleton() {
|
||||
if (use_external_skeleton) {
|
||||
if (external_skeleton_node_cache != 0) {
|
||||
return Object::cast_to<Skeleton>(ObjectDB::get_instance(external_skeleton_node_cache));
|
||||
} else {
|
||||
_update_external_skeleton_cache();
|
||||
if (external_skeleton_node_cache != 0) {
|
||||
return Object::cast_to<Skeleton>(ObjectDB::get_instance(external_skeleton_node_cache));
|
||||
}
|
||||
}
|
||||
} else {
|
||||
return Object::cast_to<Skeleton>(get_parent());
|
||||
}
|
||||
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void BoneAttachment::_notification(int p_what) {
|
||||
switch (p_what) {
|
||||
case NOTIFICATION_ENTER_TREE: {
|
||||
_check_bind();
|
||||
} break;
|
||||
case NOTIFICATION_EXIT_TREE: {
|
||||
_check_unbind();
|
||||
} break;
|
||||
/*
|
||||
void BoneAttachment::_transform_changed() {
|
||||
if (!is_inside_tree()) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (override_pose) {
|
||||
Skeleton3D *sk = _get_skeleton3d();
|
||||
|
||||
ERR_FAIL_COND_MSG(!sk, "Cannot override pose: Skeleton not found!");
|
||||
ERR_FAIL_INDEX_MSG(bone_idx, sk->get_bone_count(), "Cannot override pose: Bone index is out of range!");
|
||||
|
||||
Transform3D our_trans = get_transform();
|
||||
if (use_external_skeleton) {
|
||||
our_trans = sk->world_transform_to_global_pose(get_global_transform());
|
||||
}
|
||||
|
||||
if (override_mode == OVERRIDE_MODES::MODE_GLOBAL_POSE) {
|
||||
sk->set_bone_global_pose_override(bone_idx, our_trans, 1.0, true);
|
||||
} else if (override_mode == OVERRIDE_MODES::MODE_LOCAL_POSE) {
|
||||
sk->set_bone_local_pose_override(bone_idx, sk->global_pose_to_local_pose(bone_idx, our_trans), 1.0, true);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
BoneAttachment::BoneAttachment() {
|
||||
bound = false;
|
||||
}
|
||||
|
||||
void BoneAttachment::_bind_methods() {
|
||||
ClassDB::bind_method(D_METHOD("set_bone_name", "bone_name"), &BoneAttachment::set_bone_name);
|
||||
ClassDB::bind_method(D_METHOD("get_bone_name"), &BoneAttachment::get_bone_name);
|
||||
|
||||
ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "bone_name"), "set_bone_name", "get_bone_name");
|
||||
}
|
||||
*/
|
||||
@ -35,23 +35,70 @@
|
||||
class BoneAttachment : public Spatial {
|
||||
GDCLASS(BoneAttachment, Spatial);
|
||||
|
||||
bool bound;
|
||||
String bone_name;
|
||||
|
||||
void _check_bind();
|
||||
void _check_unbind();
|
||||
|
||||
protected:
|
||||
virtual void _validate_property(PropertyInfo &property) const;
|
||||
void _notification(int p_what);
|
||||
|
||||
static void _bind_methods();
|
||||
|
||||
public:
|
||||
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);
|
||||
|
||||
String get_configuration_warning() const;
|
||||
|
||||
BoneAttachment();
|
||||
|
||||
protected:
|
||||
void _notification(int p_what);
|
||||
|
||||
void _validate_property(PropertyInfo &property) const;
|
||||
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;
|
||||
|
||||
static void _bind_methods();
|
||||
|
||||
private:
|
||||
void _check_bind();
|
||||
void _check_unbind();
|
||||
|
||||
//void _transform_changed();
|
||||
void _update_external_skeleton_cache();
|
||||
Skeleton *_get_skeleton();
|
||||
|
||||
private:
|
||||
/*
|
||||
enum OVERRIDE_MODES {
|
||||
MODE_GLOBAL_POSE,
|
||||
MODE_LOCAL_POSE,
|
||||
};
|
||||
*/
|
||||
|
||||
bool bound;
|
||||
String bone_name;
|
||||
int bone_idx;
|
||||
|
||||
//bool override_pose;
|
||||
//int override_mode;
|
||||
//bool _override_dirty;
|
||||
|
||||
bool use_external_skeleton = false;
|
||||
NodePath external_skeleton_node;
|
||||
ObjectID external_skeleton_node_cache;
|
||||
};
|
||||
|
||||
#endif // BONE_ATTACHMENT_H
|
||||
|
||||
Loading…
Reference in New Issue
Block a user