Skip to content

Commit

Permalink
Supplement the case of scene instantiation for "Editable Children"
Browse files Browse the repository at this point in the history 
This is a follow-up to godotengine#65011.

For scenes with **Editable Children** enabled, the main scene will record
more information and resource mapping will be valid for multiple nodes.
  • Loading branch information
@Rindbee
Rindbee committed Oct 23, 2023
1 parent 8c25a98 commit 216ec91
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 27 deletions.
68 changes: 42 additions & 26 deletions scene/resources/packed_scene.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,18 +74,33 @@ static Array _sanitize_node_pinned_properties(Node *p_node) {
return pinned;
}

Ref<Resource> SceneState::get_remap_resource(const Ref<Resource> &p_resource, HashMap<Ref<Resource>, Ref<Resource>> &remap_cache, const Ref<Resource> &p_fallback, Node *p_for_scene) {
Ref<Resource> SceneState::get_remap_resource(const Ref<Resource> &p_resource, HashMap<Node *, HashMap<Ref<Resource>, Ref<Resource>>> &remap_cache, const Ref<Resource> &p_fallback, Node *p_for_scene) {
ERR_FAIL_COND_V(p_resource.is_null(), Ref<Resource>());

Ref<Resource> remap_resource;
bool reuse_uid = true;

// Find the shared copy of the source resource.
HashMap<Ref<Resource>, Ref<Resource>>::Iterator R = remap_cache.find(p_resource);
HashMap<Ref<Resource>, Ref<Resource>>::Iterator R = remap_cache[p_for_scene].find(p_resource);
if (R) {
remap_resource = R->value;
} else if (p_fallback.is_valid() && p_fallback->is_local_to_scene() && p_fallback->get_class() == p_resource->get_class()) {
// Simply copy the data from the source resource to update the fallback resource that was previously set.
if (R->value->get_local_scene() == p_for_scene) {
return R->value;
}
reuse_uid = false; // A different copy is required.
}

bool reuse_fallback = p_fallback.is_valid() && p_fallback->is_local_to_scene() && p_fallback->get_class() == p_resource->get_class();

if (reuse_fallback) {
// The fallback resource can only be mapped at most once when it is valid.
for (const KeyValue<Ref<Resource>, Ref<Resource>> &E : remap_cache[p_for_scene]) {
if (E.value == p_fallback) {
reuse_fallback = false;
break;
}
}
}

if (reuse_fallback) { // Simply copy the data from the source resource to update the fallback resource that was previously set.
p_fallback->reset_state(); // May want to reset state.

List<PropertyInfo> pi;
Expand All @@ -110,17 +125,20 @@ Ref<Resource> SceneState::get_remap_resource(const Ref<Resource> &p_resource, Ha
p_fallback->set(E.name, value);
}

p_fallback->set_scene_unique_id(p_resource->get_scene_unique_id()); // Get the id from the main scene, in case the id changes again when saving the scene.
if (reuse_uid) {
p_fallback->set_scene_unique_id(p_resource->get_scene_unique_id()); // Get the id from the main scene, in case the id changes again when saving the scene.
}

remap_cache[p_resource] = p_fallback;
remap_resource = p_fallback;
remap_cache[p_for_scene][p_resource] = p_fallback;
return p_fallback;
} else { // A copy of the source resource is required to overwrite the previous one.
Ref<Resource> local_dupe = p_resource->duplicate_for_local_scene(p_for_scene, remap_cache);
remap_cache[p_resource] = local_dupe;
remap_resource = local_dupe;
Ref<Resource> local_dupe = p_resource->duplicate_for_local_scene(p_for_scene, remap_cache[p_for_scene]);
if (reuse_uid) {
local_dupe->set_scene_unique_id(p_resource->get_scene_unique_id());
}
remap_cache[p_for_scene][p_resource] = local_dupe;
return local_dupe;
}

return remap_resource;
}

Node *SceneState::instantiate(GenEditState p_edit_state) const {
Expand Down Expand Up @@ -161,6 +179,7 @@ Node *SceneState::instantiate(GenEditState p_edit_state) const {
bool gen_node_path_cache = p_edit_state != GEN_EDIT_STATE_DISABLED && node_path_cache.is_empty();

HashMap<Ref<Resource>, Ref<Resource>> resources_local_to_scene;
HashMap<Node *, HashMap<Ref<Resource>, Ref<Resource>>> resources_local_to_sub_scene; // Record the mappings in sub-scenes.

LocalVector<DeferredNodePathProperties> deferred_node_paths;

Expand Down Expand Up @@ -283,7 +302,6 @@ Node *SceneState::instantiate(GenEditState p_edit_state) const {
const NodeData::Property *nprops = &n.properties[0];

Dictionary missing_resource_properties;
HashMap<Ref<Resource>, Ref<Resource>> resources_local_to_sub_scene; // Record the mappings in the sub-scene.

for (int j = 0; j < nprop_count; j++) {
bool valid;
Expand Down Expand Up @@ -328,8 +346,8 @@ Node *SceneState::instantiate(GenEditState p_edit_state) const {
Ref<Resource> res = value;
if (res.is_valid()) {
if (res->is_local_to_scene()) {
if (n.instance >= 0) { // For the root node of a sub-scene, treat it as part of the sub-scene.
value = get_remap_resource(res, resources_local_to_sub_scene, node->get(snames[nprops[j].name]), node);
if (n.type == TYPE_INSTANTIATED) { // For the (root) nodes of sub-scenes, treat them as parts of the sub-scenes.
value = get_remap_resource(res, resources_local_to_sub_scene, node->get(snames[nprops[j].name]), node->get_scene_file_path().is_empty() ? node->get_owner() : node);
} else {
HashMap<Ref<Resource>, Ref<Resource>>::Iterator E = resources_local_to_scene.find(res);
Node *base = i == 0 ? node : ret_nodes[0];
Expand Down Expand Up @@ -384,12 +402,6 @@ Node *SceneState::instantiate(GenEditState p_edit_state) const {
if (!missing_resource_properties.is_empty()) {
node->set_meta(META_MISSING_RESOURCES, missing_resource_properties);
}

for (KeyValue<Ref<Resource>, Ref<Resource>> &E : resources_local_to_sub_scene) {
if (E.value->get_local_scene() == node) {
E.value->setup_local_to_scene(); // Setup may be required for the resource to work properly.
}
}
}

//name
Expand Down Expand Up @@ -503,12 +515,16 @@ Node *SceneState::instantiate(GenEditState p_edit_state) const {
}
}

for (KeyValue<Ref<Resource>, Ref<Resource>> &E : resources_local_to_scene) {
if (E.value->get_local_scene() == ret_nodes[0]) {
E.value->setup_local_to_scene();
for (KeyValue<Node *, HashMap<Ref<Resource>, Ref<Resource>>> &E : resources_local_to_sub_scene) {
for (KeyValue<Ref<Resource>, Ref<Resource>> &R : E.value) {
R.value->setup_local_to_scene(); // Setup may be required for the resource to work properly.
}
}

for (KeyValue<Ref<Resource>, Ref<Resource>> &E : resources_local_to_scene) {
E.value->setup_local_to_scene();
}

//do connections

int cc = connections.size();
Expand Down
2 changes: 1 addition & 1 deletion scene/resources/packed_scene.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ class SceneState : public RefCounted {
};

static void set_disable_placeholders(bool p_disable);
static Ref<Resource> get_remap_resource(const Ref<Resource> &p_resource, HashMap<Ref<Resource>, Ref<Resource>> &remap_cache, const Ref<Resource> &p_fallback, Node *p_for_scene);
static Ref<Resource> get_remap_resource(const Ref<Resource> &p_resource, HashMap<Node *, HashMap<Ref<Resource>, Ref<Resource>>> &remap_cache, const Ref<Resource> &p_fallback, Node *p_for_scene);

int find_node_by_path(const NodePath &p_node) const;
Variant get_property_value(int p_node, const StringName &p_property, bool &found) const;
Expand Down

0 comments on commit 216ec91

Please sign in to comment.