GLTFDocument

Успадковує: Resource < RefCounted < Object

Успадковано від: FBXDocument

Клас імпорту та експорту файлів glTF і з Godot.

Опис

GLTFDocument підтримує читання даних із файлу glTF, буфера або сцени Godot. Потім ці дані можна записати у файлову систему, буфер або використати для створення сцени Godot.

Усі дані сцени glTF зберігаються в класі GLTFState. GLTFDocument обробляє об’єкти стану, але сам по собі не містить даних сцени. GLTFDocument має змінні-учасники для зберігання налаштувань конфігурації експорту, таких як формат зображення, але в іншому випадку не має стану. Кілька сцен можна обробити з однаковими параметрами, використовуючи той самий об’єкт GLTFDocument і різні об’єкти GLTFState.

GLTFDocument можна розширити довільними функціями, розширивши клас GLTFDocumentExtension і зареєструвавши його в GLTFDocument через register_gltf_document_extension(). Це дозволяє імпортувати й експортувати спеціальні дані.

Посібники

Властивості

String	fallback_image_format	`"None"`
float	fallback_image_quality	`0.25`
String	image_format	`"PNG"`
float	lossy_quality	`0.75`
RootNodeMode	root_node_mode	`0`
VisibilityMode	visibility_mode	`0`

Методи

Error	append_from_buffer(bytes: PackedByteArray, base_path: String, state: GLTFState, flags: int = 0)
Error	append_from_file(path: String, state: GLTFState, flags: int = 0, base_path: String = "")
Error	append_from_scene(node: Node, state: GLTFState, flags: int = 0)
GLTFObjectModelProperty	export_object_model_property(state: GLTFState, node_path: NodePath, godot_node: Node, gltf_node_index: int) static
PackedByteArray	generate_buffer(state: GLTFState)
Node	generate_scene(state: GLTFState, bake_fps: float = 30, trimming: bool = false, remove_immutable_tracks: bool = true)
PackedStringArray	get_supported_gltf_extensions() static
GLTFObjectModelProperty	import_object_model_property(state: GLTFState, json_pointer: String) static
void	register_gltf_document_extension(extension: GLTFDocumentExtension, first_priority: bool = false) static
void	unregister_gltf_document_extension(extension: GLTFDocumentExtension) static
Error	write_to_filesystem(state: GLTFState, path: String)

Переліки

enum RootNodeMode: 🔗

RootNodeMode ROOT_NODE_MODE_SINGLE_ROOT = 0

Покладіть кореневу вершину Godot як кореневу вершину glTF, і позначте його як єдиний вузол кореневих за допомогою GODOT_single_root розширення glTF. Це буде поданий тим самим, як ROOT_NODE_MODE_KEEP_ROOT, якщо реалізація не підтримує GODOT_single_root.

RootNodeMode ROOT_NODE_MODE_KEEP_ROOT = 1

Покладіть кореневу вершину Godot як кореневу вершину файлу glTF, але не позначте його як будь-який особливий. При імпорті в Godot з'явиться додаткова коренева вершина. Це використовується тільки ванільна glTF функції. Це еквівалент поведінки в Godot 4.1 і раніше.

RootNodeMode ROOT_NODE_MODE_MULTI_ROOT = 2

Покладіть кореневу вершину Godot як ім'я сцени glTF, і додайте всіх своїх дітей як кореневих вершин файлу glTF. Це використовується тільки ванільна glTF функції. Це дозволяє уникнути додаткового кореневого вузла, але тільки ім'я кореневого вузла Godot буде збережена, оскільки він не буде збережений як вузол.

enum VisibilityMode: 🔗

VisibilityMode VISIBILITY_MODE_INCLUDE_REQUIRED = 0

Якщо сцена містить будь-які невидимі вузли, включіть їх, позначте їх як невидимі за допомогою KHR_node_visibility та вимагайте, щоб імпортери поважали їхню невидимість. Недолік: Якщо імпортер не підтримує KHR_node_visibility, файл не можна імпортувати.

VisibilityMode VISIBILITY_MODE_INCLUDE_OPTIONAL = 1

Якщо сцена містить будь-які невидимі вузли, включіть їх, позначте їх як невидимі за допомогою KHR_node_visibility та не нав'язуйте жодних вимог імпортерам. Недолік: Якщо імпортер не підтримує KHR_node_visibility, невидимі об'єкти будуть видимими.

VisibilityMode VISIBILITY_MODE_EXCLUDE = 2

Якщо сцена містить будь-які невидимі вузли, не включайте їх до експорту. Це те саме, що й у Godot 4.4 та попередніх версіях. Недолік: невидимі вузли не існуватимуть в експортованому файлі.

Описи властивостей

String fallback_image_format = "None" 🔗

void set_fallback_image_format(value: String)
String get_fallback_image_format()

Зручна назва формату резервного зображення. Використовується під час експорту файлу glTF, включаючи запис у файл та запис у байтовий масив.

Ця властивість може мати значення лише "None", "PNG" або "JPEG" і використовується лише тоді, коли image_format не має значення "None", "PNG" або "JPEG". Якщо потрібно мати кілька форматів розширених зображень, це можна зробити за допомогою класу GLTFDocumentExtension - ця властивість охоплює лише випадок використання базового резервного зображення glTF під час використання власного формату зображення.

float fallback_image_quality = 0.25 🔗

void set_fallback_image_quality(value: float)
float get_fallback_image_quality()

Якість резервного зображення, якщо таке є. Для файлів PNG це зменшує масштаб зображення в обох вимірах на цей коефіцієнт. Для файлів JPEG це якість зображення з втратами. Рекомендується низьке значення, оскільки включення кількох зображень високої якості у файл glTF зводить нанівець збільшення розміру файлу від використання ефективнішого формату зображення.

String image_format = "PNG" 🔗

void set_image_format(value: String)
String get_image_format()

Зручна назва формату експортованого зображення. Використовується під час експорту файлу glTF, включаючи запис у файл та запис у байтовий масив.

За замовчуванням Godot дозволяє такі параметри: "None", "PNG", "JPEG", "Lossless WebP" та "Lossy WebP". Підтримку інших форматів зображень можна додати в класах GLTFDocumentExtension. Один клас розширення може надавати кілька параметрів для використання певного формату або навіть параметр, який використовує кілька форматів одночасно.

float lossy_quality = 0.75 🔗

void set_lossy_quality(value: float)
float get_lossy_quality()

Якщо пам'ятати зображення_формат є форматом образу, це визначає якість втрати зображення. 0.0 to 1.0, де 0.0 є найнижчою якістю і 1.0 є найвищою якістю. Якість втрати 1.0 не така ж, як без втрат.

RootNodeMode root_node_mode = 0 🔗

void set_root_node_mode(value: RootNodeMode)
RootNodeMode get_root_node_mode()

Як обробити кореневий вузол під час експорту. Значення за замовчуванням та рекомендоване значення — ROOT_NODE_MODE_SINGLE_ROOT.

Примітка: Незалежно від того, як експортується файл glTF, під час імпорту тип та назву кореневого вузла можна перевизначити на вкладці налаштувань імпорту сцени.

VisibilityMode visibility_mode = 0 🔗

void set_visibility_mode(value: VisibilityMode)
VisibilityMode get_visibility_mode()

Як обробляти видимість вузлів під час експорту. Цей параметр нічого не змінює, якщо всі вузли видимі. Значення за замовчуванням та рекомендоване значення — VISIBILITY_MODE_INCLUDE_REQUIRED, яке використовує розширення KHR_node_visibility.

Описи методів

Error append_from_buffer(bytes: PackedByteArray, base_path: String, state: GLTFState, flags: int = 0) 🔗

Приймає PackedByteArray, що визначає glTF, та імпортує дані до заданого об'єкта GLTFState через параметр state.

Примітка: Параметр base_path вказує методу append_from_buffer], де шукати залежності, і може бути порожнім.

Error append_from_file(path: String, state: GLTFState, flags: int = 0, base_path: String = "") 🔗

Бере шлях до файлу glTF та імпортує дані за цим шляхом до заданого об'єкта GLTFState через параметр state.

Примітка: Параметр base_path вказує методу append_from_file(), де шукати залежності, і може бути порожнім.

Error append_from_scene(node: Node, state: GLTFState, flags: int = 0) 🔗

Візьміть вершину сцени Godot Engine і експортуйте його і його нащадків до вказаного параметра GLTFState.

GLTFObjectModelProperty export_object_model_property(state: GLTFState, node_path: NodePath, godot_node: Node, gltf_node_index: int) static 🔗

Визначає зіставлення між даним Godot node_path і відповідним покажчиком(ами) JSON об’єктної моделі glTF у згенерованому файлі glTF. Деталі цього зіставлення повертаються в об’єкті GLTFObjectModelProperty. Додаткові зіставлення можна надати через метод зворотного виклику GLTFDocumentExtension._import_object_model_property().

PackedByteArray generate_buffer(state: GLTFState) 🔗

Отримує об’єкт GLTFState через параметр state і повертає glTF PackedByteArray.

Node generate_scene(state: GLTFState, bake_fps: float = 30, trimming: bool = false, remove_immutable_tracks: bool = true) 🔗

Візьміть об'єкт GLTFState через параметр State і повертає вузол сцени Godot Engine.

Параметри параметра fix_fps наділяє пекарні_fps в State.

PackedStringArray get_supported_gltf_extensions() static 🔗

Повертає список усіх підтримуваних розширень glTF, включно з розширеннями, які підтримуються безпосередньо системою, і розширеннями, які підтримуються плагінами користувача, що реєструють класи GLTFDocumentExtension.

Примітка: якщо цей метод запущено до того, як GLTFDocumentExtension зареєстровано, його розширення не буде включено до списку. Обов’язково запускайте цей метод лише після реєстрації всіх розширень. Якщо ви запускаєте це під час запуску двигуна, зачекайте кадр перед викликом цього методу, щоб переконатися, що всі розширення зареєстровано.

GLTFObjectModelProperty import_object_model_property(state: GLTFState, json_pointer: String) static 🔗

Визначає зіставлення між заданою об’єктною моделлю glTF json_pointer і відповідним шляхом(ями) вузла Godot у згенерованій сцені Godot. Деталі цього зіставлення повертаються в об’єкті GLTFObjectModelProperty. Додаткові зіставлення можна надати через метод зворотного виклику GLTFDocumentExtension._export_object_model_property().

void register_gltf_document_extension(extension: GLTFDocumentExtension, first_priority: bool = false) static 🔗

Реєструє даний екземпляр GLTFDocumentExtension у GLTFDocument. Якщо first_priority має значення true, це розширення буде запущено першим. В іншому випадку він буде запущений останнім.

Примітка: Як і сам GLTFDocument, усі класи GLTFDocumentExtension мають бути без стану, щоб функціонувати належним чином. Якщо вам потрібно зберігати дані, використовуйте методи set_additional_data і get_additional_data у GLTFState або GLTFNode.

void unregister_gltf_document_extension(extension: GLTFDocumentExtension) static 🔗

Незареєстровані дані GLTFDocumentExtension.

Error write_to_filesystem(state: GLTFState, path: String) 🔗

Візьміть об'єкт GLTFState через параметр State і напишіть файл glTF до файлової системи.

Примітка: Розширення файлу glTF визначає, якщо це бінарний файл .glb або текстовий файл .gltf.