Skip to content

Commit

Permalink
GLTF: Add extract_path and extract_prefix settings
Browse files Browse the repository at this point in the history
Only used by the Blender importer
  • Loading branch information
aaronfranke committed Nov 5, 2024
1 parent e919ea1 commit 5ee1484
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 9 deletions.
2 changes: 2 additions & 0 deletions modules/gltf/editor/editor_scene_importer_blend.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,8 @@ Node *EditorSceneFormatImporterBlend::import_scene(const String &p_path, uint32_
state->set_import_as_skeleton_bones(true);
}
state->set_scene_name(blend_basename);
state->set_extract_path(p_path.get_base_dir());
state->set_extract_prefix(blend_basename);
err = gltf->append_from_file(sink.get_basename() + ".gltf", state, p_flags, base_dir);
if (err != OK) {
if (r_err) {
Expand Down
16 changes: 9 additions & 7 deletions modules/gltf/gltf_document.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3501,8 +3501,10 @@ void GLTFDocument::_parse_image_save_image(Ref<GLTFState> p_state, const Vector<
}
#ifdef TOOLS_ENABLED
if (Engine::get_singleton()->is_editor_hint() && handling == GLTFState::GLTFHandleBinary::HANDLE_BINARY_EXTRACT_TEXTURES) {
if (p_state->base_path.is_empty()) {
WARN_PRINT("glTF: Couldn't extract image because the base path is empty. It will be loaded directly instead, uncompressed.");
if (p_state->extract_path.is_empty()) {
WARN_PRINT("glTF: Couldn't extract image because the base and extract paths are empty. It will be loaded directly instead, uncompressed.");
} else if (p_state->extract_path.begins_with("res://.godot/imported")) {
WARN_PRINT(vformat("glTF: Extract path is in the imported directory. Image index '%d' will be loaded directly, uncompressed.", p_index));
} else {
if (p_image->get_name().is_empty()) {
WARN_PRINT(vformat("glTF: Image index '%d' did not have a name. It will be automatically given a name based on its index.", p_index));
Expand All @@ -3511,7 +3513,7 @@ void GLTFDocument::_parse_image_save_image(Ref<GLTFState> p_state, const Vector<
bool must_import = true;
Vector<uint8_t> img_data = p_image->get_data();
Dictionary generator_parameters;
String file_path = p_state->get_base_path().path_join(p_state->filename.get_basename() + "_" + p_image->get_name());
String file_path = p_state->get_extract_path().path_join(p_state->get_extract_prefix() + "_" + p_image->get_name());
file_path += p_file_extension.is_empty() ? ".png" : p_file_extension;
if (FileAccess::exists(file_path + ".import")) {
Ref<ConfigFile> config;
Expand Down Expand Up @@ -7349,7 +7351,7 @@ PackedByteArray GLTFDocument::generate_buffer(Ref<GLTFState> p_state) {
Error GLTFDocument::write_to_filesystem(Ref<GLTFState> p_state, const String &p_path) {
Ref<GLTFState> state = p_state;
ERR_FAIL_COND_V(state.is_null(), ERR_INVALID_PARAMETER);
state->base_path = p_path.get_base_dir();
state->set_base_path(p_path.get_base_dir());
state->filename = p_path.get_file();
Error err = _serialize(state);
if (err != OK) {
Expand Down Expand Up @@ -7462,7 +7464,7 @@ Error GLTFDocument::append_from_buffer(PackedByteArray p_bytes, String p_base_pa
Ref<FileAccessMemory> file_access;
file_access.instantiate();
file_access->open_custom(p_bytes.ptr(), p_bytes.size());
state->base_path = p_base_path.get_base_dir();
state->set_base_path(p_base_path.get_base_dir());
err = _parse(p_state, state->base_path, file_access);
ERR_FAIL_COND_V(err != OK, err);
for (Ref<GLTFDocumentExtension> ext : document_extensions) {
Expand All @@ -7479,7 +7481,7 @@ Error GLTFDocument::append_from_file(String p_path, Ref<GLTFState> p_state, uint
if (state == Ref<GLTFState>()) {
state.instantiate();
}
state->filename = p_path.get_file().get_basename();
state->set_filename(p_path.get_file().get_basename());
state->use_named_skin_binds = p_flags & GLTF_IMPORT_USE_NAMED_SKIN_BINDS;
state->discard_meshes_and_materials = p_flags & GLTF_IMPORT_DISCARD_MESHES_AND_MATERIALS;
state->force_generate_tangents = p_flags & GLTF_IMPORT_GENERATE_TANGENT_ARRAYS;
Expand All @@ -7493,7 +7495,7 @@ Error GLTFDocument::append_from_file(String p_path, Ref<GLTFState> p_state, uint
if (base_path.is_empty()) {
base_path = p_path.get_base_dir();
}
state->base_path = base_path;
state->set_base_path(base_path);
err = _parse(p_state, base_path, file);
ERR_FAIL_COND_V(err != OK, err);
for (Ref<GLTFDocumentExtension> ext : document_extensions) {
Expand Down
24 changes: 23 additions & 1 deletion modules/gltf/gltf_state.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,27 @@ String GLTFState::get_base_path() {
return base_path;
}

void GLTFState::set_base_path(String p_base_path) {
void GLTFState::set_base_path(const String &p_base_path) {
base_path = p_base_path;
if (extract_path.is_empty()) {
extract_path = p_base_path;
}
}

String GLTFState::get_extract_path() {
return extract_path;
}

void GLTFState::set_extract_path(const String &p_extract_path) {
extract_path = p_extract_path;
}

String GLTFState::get_extract_prefix() {
return extract_prefix;
}

void GLTFState::set_extract_prefix(const String &p_extract_prefix) {
extract_prefix = p_extract_prefix;
}

String GLTFState::get_filename() const {
Expand All @@ -407,6 +426,9 @@ String GLTFState::get_filename() const {

void GLTFState::set_filename(const String &p_filename) {
filename = p_filename;
if (extract_prefix.is_empty()) {
extract_prefix = p_filename.get_basename();
}
}

Variant GLTFState::get_additional_data(const StringName &p_extension_name) {
Expand Down
10 changes: 9 additions & 1 deletion modules/gltf/gltf_state.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ class GLTFState : public Resource {

protected:
String base_path;
String extract_path;
String extract_prefix;
String filename;
Dictionary json;
int major_version = 0;
Expand Down Expand Up @@ -186,7 +188,13 @@ class GLTFState : public Resource {
void set_scene_name(String p_scene_name);

String get_base_path();
void set_base_path(String p_base_path);
void set_base_path(const String &p_base_path);

String get_extract_path();
void set_extract_path(const String &p_extract_path);

String get_extract_prefix();
void set_extract_prefix(const String &p_extract_prefix);

String get_filename() const;
void set_filename(const String &p_filename);
Expand Down

0 comments on commit 5ee1484

Please sign in to comment.