Blender V5.3
blender::bke::FileHandlerType Struct Reference

#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

Detailed Description

Definition at line 25 of file BKE_file_handler.hh.

Member Function Documentation

◆ filter_glob_from_extensions()

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().

◆ filter_supported_paths()

Vector< int64_t > blender::bke::FileHandlerType::filter_supported_paths ( const Span< std::string > paths) const

◆ get_default_filename()

◆ label_with_extensions()

std::string blender::bke::FileHandlerType::label_with_extensions ( ) const

Member Data Documentation

◆ export_operator

char blender::bke::FileHandlerType::export_operator[OP_MAX_TYPENAME]

◆ file_extensions

Vector<std::string> blender::bke::FileHandlerType::file_extensions

◆ file_extensions_str

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.

◆ idname

◆ import_operator

◆ label

◆ poll_drop

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().

◆ rna_ext

ExtensionRNA blender::bke::FileHandlerType::rna_ext

RNA integration.

Definition at line 47 of file BKE_file_handler.hh.


The documentation for this struct was generated from the following files: