Skip to content
On this page

class GLTFExporter

glTF geometry exporter capable of exporting both glTF and GLB files determined by output path extension. Textures and binary blob files for glTF export will be placed alongside the glTF file and have names prefixed by the output file name. Note that any normal textures for the scene must be in tangent space, as generated by a normal caster with SetGenerateTangentSpaceNormals set to true.

Properties

PropertyDescription
CompressDisplacementMicromapIf compress any exported displacement micromap.
DisplacementMicromapMinimumPSNRWhen exporting compressed displacement micromap, this value represents the minimum allowed peak signal-to-noise-ratio. Typical values range: 30.0 - 50.0, with lower values giving better compression, at worse quality.
ExportCascadedScenesFlag to control if cascaded scenes should be included in the export (note that not all file formats support this). (Inherited from GraphicsExporter)
ExportFilePathThe main export file path. This is the main file being written to, and must always be set. (Inherited from GraphicsExporter)
ExportMicromapsIf compatible attribute tessellation data exists in the scene, export this data as micromaps. Scalar displacement is exported as-is, vector displacement is converted to scalar displacement for compatibility with the micromap file format.
ForceTriangleExportFlag to force exporters that are capable of exporting quads using the information in the QuadFlags GeometryData field to ignore the quad flags and convert everything to triangles. (Inherited from GraphicsExporter)
NameThe name of the GLTFExporter object. (Inherited from Object)
PrimaryTexCoordNameThe name of the texcoord level to use as primary level in case the file format only supports a single texture coordinate layer. If the primary level name is not set, the first found level will be used as primary level. (Inherited from GraphicsExporter)
ReferenceExportModeExport mode for referenced external files in the scene, such as references to textures. File formats which do not support external references will ignore the setting and always embed the data. (Inherited from GraphicsExporter)

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClassGet the name of the GLTFExporter class. (Inherited from Object)
IsAReturns true if GLTFExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the GLTFExporter object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the GLTFExporter object is valid. (Inherited from Object)
NonNullReturns true if the GLTFExporter object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the GLTFExporter object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunRuns the export. Note that all parameters must be setup before importing. (Inherited from GraphicsExporter)
SetSceneThe scene to export. (Inherited from GraphicsExporter)
SetSelectionSetThe selection set (of nodes from the scene) to export. (Inherited from GraphicsExporter)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spGLTFExporter, and if this is the case, returns the object cast into spGLTFExporter. (Inherited from Object)

Properties details

CompressDisplacementMicromap

If compress any exported displacement micromap.

DisplacementMicromapMinimumPSNR

When exporting compressed displacement micromap, this value represents the minimum allowed peak signal-to-noise-ratio. Typical values range: 30.0 - 50.0, with lower values giving better compression, at worse quality.

ExportCascadedScenes

Flag to control if cascaded scenes should be included in the export (note that not all file formats support this).

ExportFilePath

The main export file path. This is the main file being written to, and must always be set.

ExportMicromaps

If compatible attribute tessellation data exists in the scene, export this data as micromaps. Scalar displacement is exported as-is, vector displacement is converted to scalar displacement for compatibility with the micromap file format.

ForceTriangleExport

Flag to force exporters that are capable of exporting quads using the information in the QuadFlags GeometryData field to ignore the quad flags and convert everything to triangles.

Name

The name of the GLTFExporter object. (Inherited from Object)

PrimaryTexCoordName

The name of the texcoord level to use as primary level in case the file format only supports a single texture coordinate layer. If the primary level name is not set, the first found level will be used as primary level.

ReferenceExportMode

Export mode for referenced external files in the scene, such as references to textures. File formats which do not support external references will ignore the setting and always embed the data.

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

GetClass

Get the name of the GLTFExporter class. (Inherited from Object)

IsA

Returns true if GLTFExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)

IsNull

Returns true if the GLTFExporter object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the GLTFExporter object is valid. (Inherited from Object)

NonNull

Returns true if the GLTFExporter object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the GLTFExporter object to the log. (Inherited from Object)

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Run

Runs the export. Note that all parameters must be setup before importing.

SetScene

The scene to export.

SetSelectionSet

The selection set (of nodes from the scene) to export.

Static methods details

IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spGLTFExporter, and if this is the case, returns the object cast into spGLTFExporter. (Inherited from Object)