GltfDocument

public string FallbackImageFormat { get; set; }

Удобное для пользователя, имя резервного формата изображения. Используется при экспорте файла glTF, включая запись в файл и запись в массив байтов. Это свойство может быть только одним из "None", "PNG" или "JPEG" и используется только тогда, когда GltfDocument.ImageFormat не является одним из "None", "PNG" или "JPEG". Если требуется иметь несколько форматов изображений с расширением, это можно сделать с помощью класса GltfDocumentExtension — это свойство охватывает только вариант использования предоставления базового резервного изображения glTF при использовании пользовательского формата изображения.

public float FallbackImageQuality { get; set; }

Качество резервного изображения, если таковое имеется. Для файлов PNG это уменьшает изображение по обоим измерениям на этот коэффициент. Для файлов JPEG это качество изображения с потерями. Рекомендуется низкое значение, поскольку включение нескольких высококачественных изображений в файл glTF сводит на нет выигрыш в размере файла за счет использования более эффективного формата изображения.

public string ImageFormat { get; set; }

Удобное для пользователя название формата экспортируемого изображения. Используется при экспорте файла glTF, включая запись в файл и запись в массив байтов. По умолчанию Reckfell допускает следующие параметры: «None», «PNG», «JPEG», «Беспотерянный ВебП» и «Потерянный ВебП». Поддержка дополнительных форматов изображений может быть добавлена в классы GltfDocumentExtension. Один класс расширения может предоставлять несколько параметров для конкретного используемого формата или даже параметр, который использует несколько форматов одновременно.

public float LossyQuality { get; set; }

Если GltfDocument.ImageFormat — это формат изображения с потерями (lossy), это определяет качество изображения с потерями. В диапазоне от 0.0 до 1.0, где 0.0 — самое низкое качество, а 1.0 — самое высокое качество. Качество с потерями 1.0 не то же самое, что и без потерь.

public GltfDocument.RootNodeModeEnum RootNodeMode { get; set; }

Как обрабатывать корневой узел во время экспорта. Значение по умолчанию и рекомендуемое значение — GltfDocument.RootNodeModeEnum.SingleRoot. Примечание: Независимо от того, как экспортируется файл glTF, при импорте тип и имя корневого узла можно переопределить на вкладке настроек импорта сцены.

public GltfDocument.TextureMapModeEnum TextureMapMode { get; set; }

Как обрабатывать текстурные карты во время импорта. Значение по умолчанию и рекомендуемое значение — GltfDocument.TextureMapModeEnum.RemapToStandardMaterial, которое автоматически переназначает карты текстур из гибкой системы текстурных карт glTF на более специфические слоты текстурных карт в классе StandardMaterial3D Reckfell. В качестве альтернативы можно использовать GltfDocument.TextureMapModeEnum.DoNotRemap для сохранения исходных текстурных карт из файла glTF, что может быть желательно при использовании файла glTF с пользовательскими шейдерами, но может отображаться некорректно со встроенными материалами Reckfell.

public GltfDocument.VisibilityModeEnum VisibilityMode { get; set; }

Как работать с видимостью узлов во время экспорта. Эта настройка ничего не делает, если все узлы видны. Значение по умолчанию и рекомендуемое значение — GltfDocument.VisibilityModeEnum.IncludeRequired, которое использует расширение KHR_node_visibility.

public Error AppendFromBuffer(byte[] bytes, string basePath, GltfState state, uint flags = 0);

Принимает byte[], определяющий glTF, и импортирует данные в заданный объект GltfState через параметр state. Примечание: base_path сообщает GltfDocument.AppendFromBuffer, где найти зависимости, и может быть пустым.

public Error AppendFromBuffer(ReadOnlySpan<byte> bytes, string basePath, GltfState state, uint flags);

Принимает byte[], определяющий glTF, и импортирует данные в заданный объект GltfState через параметр state. Примечание: base_path сообщает GltfDocument.AppendFromBuffer, где найти зависимости, и может быть пустым.

public Error AppendFromFile(string path, GltfState state, uint flags = 0, string basePath = "");

Читает glTF/GLB в GltfState с разрешением зависимостей относительно basePath. Само дерево Entity ещё не создаётся: после Error.Ok вызовите GenerateScene. Для независимой загрузки используйте новый state. Не является универсальным загрузчиком FBX, Blender или проекта Reckfell.

public Error AppendFromScene(Entity node, GltfState state, uint flags = 0);

Преобразует переданный корень Entity и его потомков в данные GltfState. Файл не записывает и исходное дерево не освобождает. Для независимого экспорта создавайте новый state, затем вызывайте WriteToFilesystem. Успешное преобразование не гарантирует перенос ShaderMaterial и игровых возможностей.

public static GltfObjectModelProperty ExportObjectModelProperty(GltfState state, EntityPath entityPath, Entity reckfellNode, int gltfNodeIndex);

Определяет график между данным Reckfell entity_path и соответствующий ЦГОКМ Object Модель JSON Указатель(и) в генерируемом файле glTF. Подробности этого картирования возвращены в GltfObjectModelProperty Дополнительные карты могут быть получены через GltfDocumentExtension._ImportObjectModelProperty Метод обратного вызова.

public byte[] GenerateBuffer(GltfState state);

Принимает объект GltfState через параметр state и возвращает glTF byte[].

public Entity GenerateScene(GltfState state, float bakeFps = 30f, bool trimming = false, bool removeImmutableTracks = true);

Создаёт дерево Entity из подготовленного GltfState. Дерево не добавляется в EntityTree автоматически; присоедините его явно или освободите через Free. Параметр bakeFps заменяет частоту запекания в state. Создание анимаций зависит также от данных и настроек state.

public static string[] GetSupportedGltfExtensions();

Возвращает список всех поддерживаемых расширений glTF, включая расширения, поддерживаемые непосредственно движком, и расширения, поддерживаемые пользовательскими плагинами, регистрирующими классы GltfDocumentExtension. Примечание: Если этот метод запущен до регистрации GLTFDocumentExtension, его расширения не будут включены в список. Обязательно запускайте этот метод только после регистрации всех расширений. Если вы запускаете его при запуске движка, рассмотрите возможность ожидания кадра перед вызовом этого метода, чтобы убедиться, что все расширения зарегистрированы.

public static GltfObjectModelProperty ImportObjectModelProperty(GltfState state, string jsonPointer);

Определяет картирование между данным gITF Object Модель json_pointer и соответствующий путь (пути) узла Reckfell в генерируемой сцене. GltfObjectModelProperty Дополнительные карты могут быть получены через GltfDocumentExtension._ExportObjectModelProperty Метод обратного вызова.

public static void RegisterGltfDocumentExtension(GltfDocumentExtension extension, bool firstPriority = false);

Регистрирует заданный экземпляр GltfDocumentExtension с GLTFDocument. Если first_priority равен true, это расширение будет запущено первым. В противном случае оно будет запущено последним. Примечание: Как и сам GLTFDocument, все классы GLTFDocumentExtension должны быть без состояния для правильной работы. Если вам нужно сохранить данные, используйте методы set_additional_data и get_additional_data в GltfState или GltfNode.

public static void UnregisterGltfDocumentExtension(GltfDocumentExtension extension);

Отменяет регистрацию указанного экземпляра GltfDocumentExtension.

public Error WriteToFilesystem(GltfState state, string path);

Сериализует подготовленный GltfState и пишет glTF-файл. Используйте .glb для двоичного контейнера, .gltf для JSON с зависимостями. Родительская папка должна существовать. Возможна запись нескольких файлов; ошибка не выполняет автоматический откат частичного результата.