|
Blender V5.3
|
#include <BKE_file_handler.hh>
Public Member Functions | |
| Vector< int64_t > | filter_supported_paths (const Span< std::string > paths) const |
| std::string | get_default_filename (StringRefNull name) |
| std::string | label_with_extensions () const |
| std::optional< std::string > | filter_glob_from_extensions () const |
Public Attributes | |
| char | idname [OP_MAX_TYPENAME] |
| char | label [OP_MAX_TYPENAME] |
| char | import_operator [OP_MAX_TYPENAME] |
| char | export_operator [OP_MAX_TYPENAME] |
| char | file_extensions_str [FH_MAX_FILE_EXTENSIONS_STR] |
| bool(*) | poll_drop (const bContext *C, FileHandlerType *file_handle_type) |
| Vector< std::string > | file_extensions |
| ExtensionRNA | rna_ext |
Definition at line 25 of file BKE_file_handler.hh.
| std::optional< std::string > blender::bke::FileHandlerType::filter_glob_from_extensions | ( | ) | const |
Return a string usable as 'glob filter' containing all the supported extensions (e.g. "*.usd;*.usda;*.usdc;*.usdz"), or std::nullopt if no extensions are defined.
Definition at line 205 of file file_handler.cc.
References file_extensions, and blender::StringRef::StringRef().
Referenced by blender::ed::object::collection_importer_add_invoke(), and blender::ui::draw_import_properties().
| Vector< int64_t > blender::bke::FileHandlerType::filter_supported_paths | ( | const Span< std::string > | paths | ) | const |
Return a vector of indices in #paths of file paths supported by the file handler.
Definition at line 111 of file file_handler.cc.
References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::BLI_path_extension(), blender::BLI_strcaseeq(), lexit::Vector< T >::end(), file_extensions, and blender::Span< T >::index_range().
Referenced by blender::file_handler_import_operator_write_ptr().
| std::string blender::bke::FileHandlerType::get_default_filename | ( | StringRefNull | name | ) |
Generate a default file name for use with this file handler.
Definition at line 131 of file file_handler.cc.
References blender::blender::StringRefBase::begin(), blender::BLI_path_extension_ensure(), blender::BLI_path_make_safe_filename(), blender::StringRefNull::c_str(), DATA_, blender::blender::StringRefBase::end(), file_extensions, FILE_MAXFILE, blender::gpu::shader::parser::filename(), blender::blender::StringRefBase::is_empty(), and blender::STRNCPY().
Referenced by blender::ed::object::collection_exporter_export(), and blender::ui::template_collection_exporters().
| std::string blender::bke::FileHandlerType::label_with_extensions | ( | ) | const |
Return label with the supported file extensions appended, e.g. "Alembic (.abc)".
Definition at line 170 of file file_handler.cc.
References BLT_I18NCONTEXT_OPERATOR_DEFAULT, CTX_IFACE_, blender::bke::extensions_common_prefix(), blender::bke::extensions_group_is_collapsible(), file_extensions, blender::Span< T >::first(), label, blender::Span< T >::size(), and blender::Span< T >::slice().
Referenced by blender::bke::tests::expect_label_with_extensions().
| char blender::bke::FileHandlerType::export_operator[OP_MAX_TYPENAME] |
Export operator name.
Definition at line 33 of file BKE_file_handler.hh.
Referenced by blender::ed::object::collection_exporter_add_exec(), blender::ed::object::collection_exporter_export(), and blender::ui::template_collection_exporters().
| Vector<std::string> blender::bke::FileHandlerType::file_extensions |
List of file extensions supported by the file handler.
Definition at line 44 of file BKE_file_handler.hh.
Referenced by blender::bke::tests::expect_label_with_extensions(), blender::bke::file_handlers_poll_file_drop(), filter_glob_from_extensions(), filter_supported_paths(), get_default_filename(), and label_with_extensions().
| char blender::bke::FileHandlerType::file_extensions_str[FH_MAX_FILE_EXTENSIONS_STR] |
Formatted string of file extensions supported by the file handler, each extension should start with a . and be separated by ;. For Example: ".blend;.ble".
Definition at line 38 of file BKE_file_handler.hh.
| char blender::bke::FileHandlerType::idname[OP_MAX_TYPENAME] |
Unique name.
Definition at line 27 of file BKE_file_handler.hh.
Referenced by blender::ed::object::collection_exporter_add_exec(), blender::ed::object::collection_importer_add_ensure(), blender::file_handler_import_operator_write_ptr(), and blender::rna_def_file_handler().
| char blender::bke::FileHandlerType::import_operator[OP_MAX_TYPENAME] |
Import operator name.
Definition at line 31 of file BKE_file_handler.hh.
Referenced by blender::ed::object::collection_importer_add_ensure(), blender::ed::object::collection_importer_import_exec(), blender::drop_import_file_poll_file_handlers(), blender::file_handler_import_operator_write_ptr(), and blender::ui::template_collection_importer().
| char blender::bke::FileHandlerType::label[OP_MAX_TYPENAME] |
For UI text.
Definition at line 29 of file BKE_file_handler.hh.
Referenced by blender::blo_do_versions_403(), blender::ed::object::collection_exporter_add_exec(), blender::bke::tests::expect_label_with_extensions(), label_with_extensions(), blender::ui::template_collection_exporters(), and blender::ui::template_collection_importer().
| bool(*) blender::bke::FileHandlerType::poll_drop(const bContext *C, FileHandlerType *file_handle_type) |
Check if file handler can be used on file drop.
Definition at line 41 of file BKE_file_handler.hh.
Referenced by blender::bke::file_handlers_poll_file_drop().
| ExtensionRNA blender::bke::FileHandlerType::rna_ext |
RNA integration.
Definition at line 47 of file BKE_file_handler.hh.