#pragma once #include "scene/animation/animation_player.h" #include "core/io/resource.h" #include "scene/3d/skeleton_3d.h" #include struct GraphEvaluationContext { AnimationPlayer *animation_player = nullptr; Skeleton3D *skeleton_3d = nullptr; }; struct AnimationData { enum TrackType : uint8_t { TYPE_VALUE, // Set a value in a property, can be interpolated. TYPE_POSITION_3D, // Position 3D track, can be compressed. TYPE_ROTATION_3D, // Rotation 3D track, can be compressed. TYPE_SCALE_3D, // Scale 3D track, can be compressed. TYPE_BLEND_SHAPE, // Blend Shape track, can be compressed. TYPE_METHOD, // Call any method on a specific node. TYPE_BEZIER, // Bezier curve. TYPE_AUDIO, TYPE_ANIMATION, }; struct TrackValue { Animation::Track *track = nullptr; TrackType type = TYPE_ANIMATION; }; struct PositionTrackValue : public TrackValue { int bone_idx = -1; Vector3 position = Vector3(0, 0, 0); PositionTrackValue() { type = TYPE_POSITION_3D; } }; struct RotationTrackValue : public TrackValue { int bone_idx = -1; Quaternion rotation = Quaternion(0, 0, 0, 1); RotationTrackValue() { type = TYPE_ROTATION_3D; } }; struct ScaleTrackValue : public TrackValue { int bone_idx = -1; Vector3 scale; ScaleTrackValue() { type = TYPE_SCALE_3D; } }; AnimationData() = default; ~AnimationData() { _clear_values(); } void set_value(Animation::TypeHash thash, TrackValue *value) { if (!track_values.has(thash)) { track_values.insert(thash, value); } else { track_values[thash] = value; } } void clear() { _clear_values(); } AHashMap track_values; // Animation::Track to TrackValue protected: void _clear_values() { for (KeyValue &K : track_values) { memdelete(K.value); } } }; struct SyncTrack { }; class SyncedAnimationNode : public Resource { GDCLASS(SyncedAnimationNode, Resource); friend class SyncedAnimationGraph; public: struct NodeTimeInfo { double length = 0.0; double position = 0.0; double sync_position = 0.0; double delta = 0.0; double sync_delta = 0.0; Animation::LoopMode loop_mode = Animation::LOOP_NONE; SyncTrack sync_track; }; NodeTimeInfo node_time_info; struct InputPort { StringName name; SyncedAnimationNode *node; }; Vector input_port; StringName name; virtual ~SyncedAnimationNode() = default; virtual void initialize(GraphEvaluationContext &context) {} virtual void activate_inputs(Vector> input_nodes) { // By default, all inputs nodes are activated. for (Ref node: input_nodes) { node->active = true; } } virtual void calculate_sync_track(Vector> input_nodes) { // By default, use the SyncTrack of the first input. if (input_nodes.size() > 0) { node_time_info.sync_track = input_nodes[0]->node_time_info.sync_track; } } virtual void update_time(double p_delta) { node_time_info.delta = p_delta; node_time_info.position += p_delta; if (node_time_info.position > node_time_info.length) { switch (node_time_info.loop_mode) { case Animation::LOOP_NONE: { node_time_info.position = node_time_info.length; break; } case Animation::LOOP_LINEAR: { assert(node_time_info.length > 0.0); while (node_time_info.position > node_time_info.length) { node_time_info.position -= node_time_info.length; } break; } case Animation::LOOP_PINGPONG: { assert(false && !"Not yet implemented."); break; } } } } virtual void evaluate(GraphEvaluationContext &context, const Vector &input_datas, AnimationData &output_data) { // By default, use the AnimationData of the first input. if (input_datas.size() > 0) { output_data = *input_datas[0]; } } bool active = false; bool set_input_node(const StringName &socket_name, SyncedAnimationNode *node); virtual void get_input_names(Vector &inputs) const {} int get_node_input_index(const StringName &port_name) const { Vector inputs; get_input_names(inputs); return inputs.find(port_name); } int get_node_input_count() const { Vector inputs; get_input_names(inputs); return inputs.size(); } }; class AnimationSamplerNode : public SyncedAnimationNode { GDCLASS(AnimationSamplerNode, SyncedAnimationNode); public: StringName animation_name; private: Ref animation; void initialize(GraphEvaluationContext &context) override; void evaluate(GraphEvaluationContext &context, const Vector &inputs, AnimationData &output) override; }; class OutputNode : public SyncedAnimationNode { public: void get_input_names(Vector &inputs) const override { inputs.push_back("Input"); } }; class AnimationBlend2Node : public SyncedAnimationNode { public: void get_input_names(Vector &inputs) const override { inputs.push_back("Input0"); inputs.push_back("Input1"); } }; struct BlendTreeConnection { const Ref source_node = nullptr; const Ref target_node = nullptr; const StringName target_port_name = ""; }; /** * @class BlendTreeBuilder * Helper class that is used to build runtime blend trees and also to validate connections. */ struct BlendTreeBuilder { struct NodeConnectionInfo { int parent_node_index = -1; HashSet input_subtree_node_indices; // Contains all nodes down to the tree leaves that influence this node. LocalVector connected_child_node_index_at_port; // Contains for each input port the index of the node that is connected to it. NodeConnectionInfo() = default; explicit NodeConnectionInfo(const SyncedAnimationNode *node) { parent_node_index = -1; for (int i = 0; i < node->get_node_input_count(); i++) { connected_child_node_index_at_port.push_back(-1); } } void _print_subtree() const { String result = vformat("subtree node indices (%d): ", input_subtree_node_indices.size()); bool is_first = true; for (int index : input_subtree_node_indices) { if (is_first) { result += vformat("%d", index); is_first = false; } else { result += vformat(", %d", index); } } print_line(result); } void apply_node_mapping(LocalVector node_index_mapping) { if (parent_node_index != -1) { parent_node_index = node_index_mapping[parent_node_index]; } // Map connected node indices for (unsigned int j = 0; j < connected_child_node_index_at_port.size(); j++) { int connected_node_index = connected_child_node_index_at_port[j]; connected_child_node_index_at_port[j] = node_index_mapping.find(connected_node_index); } // Map connected subtrees HashSet old_indices = input_subtree_node_indices; input_subtree_node_indices.clear(); for (int old_index: old_indices) { input_subtree_node_indices.insert(node_index_mapping.find(old_index)); } } }; Vector> nodes; // All added nodes LocalVector node_connection_info; Vector connections; BlendTreeBuilder() { Ref output_node; output_node.instantiate(); output_node->name = "Output"; add_node(output_node); } Ref get_output_node() const { return nodes[0]; } int get_node_index(const Ref &node) const { for (int i = 0; i < nodes.size(); i++) { if (nodes[i] == node) { return i; } } return -1; } void add_node(const Ref &node) { nodes.push_back(node); node_connection_info.push_back(NodeConnectionInfo(node.ptr())); } void sort_nodes_and_references() { LocalVector sorted_node_indices = get_sorted_node_indices(); LocalVector index_mapping; for (int i : sorted_node_indices) { index_mapping.push_back(sorted_node_indices.find(i)); } Vector> sorted_nodes; Vector old_node_connection_info = node_connection_info; for (unsigned int i = 0; i < sorted_node_indices.size(); i++) { int node_index = sorted_node_indices[i]; sorted_nodes.push_back(nodes[node_index]); node_connection_info[i] = old_node_connection_info[node_index]; } nodes = sorted_nodes; for (NodeConnectionInfo& connection_info: node_connection_info) { connection_info.apply_node_mapping(sorted_node_indices); } } LocalVector get_sorted_node_indices() { LocalVector result; sort_nodes_recursive(0, result); result.reverse(); return result; } void sort_nodes_recursive(int node_index, LocalVector &result) { for (int input_node_index : node_connection_info[node_index].connected_child_node_index_at_port) { sort_nodes_recursive(input_node_index, result); } result.push_back(node_index); } void add_index_and_update_subtrees_recursive(int node, int node_parent) { if (node_parent == -1) { return; } node_connection_info[node_parent].input_subtree_node_indices.insert(node); for (int index : node_connection_info[node].input_subtree_node_indices) { node_connection_info[node_parent].input_subtree_node_indices.insert(index); } add_index_and_update_subtrees_recursive(node_parent, node_connection_info[node_parent].parent_node_index); } bool add_connection(const Ref &source_node, const Ref &target_node, const StringName &target_port_name) { if (!is_connection_valid(source_node, target_node, target_port_name)) { return false; } int source_node_index = get_node_index(source_node); int target_node_index = get_node_index(target_node); int target_input_port_index = target_node->get_node_input_index(target_port_name); node_connection_info[source_node_index].parent_node_index = target_node_index; node_connection_info[target_node_index].connected_child_node_index_at_port[target_input_port_index] = source_node_index; add_index_and_update_subtrees_recursive(source_node_index, target_node_index); return true; } bool is_connection_valid(const Ref &source_node, const Ref &target_node, StringName target_port_name) { int source_node_index = get_node_index(source_node); if (source_node_index == -1) { print_error("Cannot connect nodes: source node not found."); return false; } if (node_connection_info[source_node_index].parent_node_index != -1) { print_error("Cannot connect node: source node already has a parent."); return false; } int target_node_index = get_node_index(target_node); if (target_node_index == -1) { print_error("Cannot connect nodes: target node not found."); return false; } if (target_node == get_output_node() && connections.size() > 0) { print_error("Cannot add connection to output node: output node is already connected"); return false; } Vector target_inputs; target_node->get_input_names(target_inputs); if (!target_inputs.has(target_port_name)) { print_error("Cannot connect nodes: target port not found."); return false; } int target_input_port_index = target_node->get_node_input_index(target_port_name); if (node_connection_info[target_node_index].connected_child_node_index_at_port[target_input_port_index] != -1) { print_error("Cannot connect node: target port already connected"); return false; } if (node_connection_info[source_node_index].input_subtree_node_indices.has(target_node_index)) { print_error("Cannot connect node: connection would create loop."); return false; } return true; } }; class SyncedBlendTree : public SyncedAnimationNode { Vector> tree_nodes; Vector> tree_node_subgraph; Vector tree_connections; Vector> nodes; struct NodeRuntimeData { Vector> input_nodes; Vector input_data; AnimationData *output_data = nullptr; }; LocalVector _node_runtime_data; BlendTreeBuilder tree_builder; bool tree_initialized = false; void setup_tree() { nodes.clear(); _node_runtime_data.clear(); tree_builder.sort_nodes_and_references(); // Add nodes and allocate runtime data for (int i = 0; i < tree_builder.nodes.size(); i++) { Ref node = tree_builder.nodes[i]; nodes.push_back(node); NodeRuntimeData node_runtime_data; for (int ni = 0; ni < node->get_node_input_count(); ni++) { node_runtime_data.input_data.push_back(nullptr); } node_runtime_data.output_data = nullptr; _node_runtime_data.push_back(node_runtime_data); } // Populate runtime data (only now is this.nodes populated to retrieve the nodes) for (int i = 0; i < nodes.size(); i++) { Ref node = nodes[i]; NodeRuntimeData& node_runtime_data = _node_runtime_data[i]; for (int port_index = 0; port_index < node->get_node_input_count(); port_index++) { node_runtime_data.input_nodes.push_back(nodes[tree_builder.node_connection_info[i].connected_child_node_index_at_port[port_index]]); } } tree_initialized = true; } public: SyncedBlendTree() { Ref output_node; output_node.instantiate(); output_node->name = "Output"; nodes.push_back(output_node); } Ref get_output_node() { return nodes[0]; } int get_node_index(const Ref node) { for (int i = 0; i < nodes.size(); i++) { if (nodes[i] == node) { return i; } } return -1; } void add_node(const Ref &node) { if (tree_initialized) { print_error("Cannot add node to BlendTree: BlendTree already initialized."); return; } tree_builder.add_node(node); } bool add_connection(const Ref &source_node, const Ref &target_node, const StringName &target_port_name) { if (tree_initialized) { print_error("Cannot add connection to BlendTree: BlendTree already initialized."); return false; } return tree_builder.add_connection(source_node, target_node, target_port_name); } // overrides from SyncedAnimationNode void initialize(GraphEvaluationContext &context) override { for (Ref node : nodes) { node->initialize(context); } } void activate_inputs(Vector> input_nodes) override { nodes[0]->active = true; for (int i = 0; i < nodes.size(); i++) { Ref node = nodes[i]; if (!node->active) { continue; } NodeRuntimeData& node_runtime_data = _node_runtime_data[i]; node_runtime_data.output_data = memnew(AnimationData); node->activate_inputs(node_runtime_data.input_nodes); } } void calculate_sync_track(Vector> input_nodes) override { for (int i = nodes.size() - 1; i > 0; i--) { Ref node = nodes[i]; if (!node->active) { continue; } NodeRuntimeData& node_runtime_data = _node_runtime_data[i]; node_runtime_data.output_data = memnew(AnimationData); node->calculate_sync_track(node_runtime_data.input_nodes); } } void update_time(double p_delta) override { for (int i = 0; i < nodes.size(); i++) { Ref node = nodes[i]; if (!node->active) { continue; } NodeRuntimeData& node_runtime_data = _node_runtime_data[i]; node_runtime_data.output_data = memnew(AnimationData); node->update_time(node_runtime_data.input_nodes); } } void evaluate(GraphEvaluationContext &context, const Vector &input_datas, AnimationData &output_data) override { } };