Magnum::Trade::GltfSceneConverter class new in Git master

#include <MagnumPlugins/GltfSceneConverter/GltfSceneConverter.h>

Usage

This plugin depends on the Trade library and is built if WITH_GLTFSCENECONVERTER is enabled when building Magnum Plugins. To use as a dynamic plugin, load "GltfSceneConverter" via Corrade::PluginManager::Manager.

Additionally, if you're using Magnum as a CMake subproject, bundle the magnum-plugins repository and do the following:

set(WITH_GLTFSCENECONVERTER ON CACHE BOOL "" FORCE)
add_subdirectory(magnum-plugins EXCLUDE_FROM_ALL)

# So the dynamically loaded plugin gets built implicitly
add_dependencies(your-app MagnumPlugins::GltfSceneConverter)

To use as a static plugin or as a dependency of another plugin with CMake, put FindMagnumPlugins.cmake into your modules/ directory, request the GltfSceneConverter component of the MagnumPlugins package and link to the MagnumPlugins::GltfSceneConverter target:

find_package(MagnumPlugins REQUIRED GltfSceneConverter)

# ...
target_link_libraries(your-app PRIVATE MagnumPlugins::GltfSceneConverter)

See Downloading and building plugins, Plugin usage with CMake, Loading and using plugins and File format support for more information.

Behavior and limitations

The plugin recognizes SceneConverterFlag::Quiet, which will cause all conversion warnings to be suppressed. Both SceneConverterFlag::Quiet and SceneConverterFlag::Verbose are also translated to corresponding ImageConverterFlags and propagated to image converter plugins the converter delegates to.

Plugin-specific config

It's possible to tune various output options through configuration(). See below for all options and their default values:

[configuration]
# Copyright and generator name, written into the asset object. If empty, no
# value is written. The {0} placeholder, if present, will be replaced with
# Corrade, Magnum and Magnum Plugins version info including Git commit hashes
# if the plugin is built in Release from a non-sparse Git clone.
copyright=
generator=Magnum GltfSceneConverter {0}

# Add one or more extensionUsed and/or extensionRequired values to populate
# the extension usage and requirement arrays.

# Whether to write a *.gltf or a *.glb file. If empty, detected automatically
# based on filename extension, conversion to data defaults to a binary file.
# If a text file is selected for conversion to data, converting anything that
# involves binary buffers will currently fail.
binary=

# Name all buffer views and accessors to see what they belong to. Useful for
# debugging purposes. The option can be also enabled just for a particular
# add() operation and then disabled again to reduce the impact on file sizes.
accessorNames=false

# Allow only strictly valid glTF files. Disallows:
# - Meshes with zero vertices, zero indices or zero attributes
# - Meshes with 32-bit integer attributes
# - Image formats that don't have a corresponding glTF extension
# Magnum's GltfImporter will be able to open files with this option unset
# (unless it's own strict option is enabled), but other libraries may fail.
# The option can be also disabled just for a particular add() operation and
# then enabled again to not loosen up validation for everything at once.
strict=true

# Perform Y-flip for texture coordinates in a material texture transform. By
# default texture coordinates are Y-flipped directly in the mesh data to
# avoid the need to supply texture transformation matrix to a shader,
# enabling this will cause all texture coordinate data to be unchanged and
# instead all materials will have a Y-flipping texture transformation
# present. Note that this flag has to be enabled before beginning a file,
# changing it during conversion will have undefined behavior.
textureCoordinateYFlipInMaterial=false

# The non-standard MeshAttribute::ObjectId is by default recognized under
# this name. Change if you want to export it under a different identifier.
objectIdAttribute=_OBJECT_ID

# Implicitly, only material attributes that differ from glTF material
# defaults are written. Enable to unconditionally save all attributes present
# in given MaterialData. Attributes that are not present in given
# MaterialData are saved only if the Magnum default differs from the glTF
# default and this option doesn't affect them.
keepMaterialDefaults=false

# Whether to bundle images in buffers. If empty, images are bundled for *.glb
# files and saved externally for *.gltf files. Can be set differently for
# each add() operation.
bundleImages=

# Experimental KHR_texture_ktx support. The extension is not stabilized yet,
# thus the implementation may not reflect latest changes to the proposal.
experimentalKhrTextureKtx=false

# Image converter to use. Can be set differently for each add() operation in
# order to export different images in different formats. Formats that don't
# have any corresponding glTF image extension are allowed only with the
# strict option unset.
imageConverter=PngImageConverter

# Configuration options to propagate to the image converter. Obsolete, prefer
# to set the converter options directly through the plugin manager.
[configuration/imageConverter]

See Editing plugin-specific configuration for more information and an example showing how to edit the configuration values.

Base classes

class AbstractSceneConverter new in 2020.06

Base for scene converter plugins.

Constructors, destructors, conversion operators

GltfSceneConverter(PluginManager::AbstractManager& manager, const Containers::StringView& plugin) explicit

Plugin manager constructor.