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
| Property | Description |
|---|
| EmbedReferences | Flag to control if referenced textures should be embedded in binary blob or referenced by path to external files. |
| ExportCascadedScenes | Flag to control if cascaded scenes should be included in the export (note that not all file formats support this). (Inherited from GraphicsExporter) |
| ExportFilePath | The main export file path. This is the main file being written to, and must always be set. (Inherited from GraphicsExporter) |
| 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. (Inherited from GraphicsExporter) |
Methods
| Method | Description |
|---|
| 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) |
| RunExport | Runs the export. Note that all required parameters must be setup before exporting. (Inherited from GraphicsExporter) |
| SetScene | The scene to export. (Inherited from GraphicsExporter) |
| SetSelectionSet | The selection set (of nodes from the scene) to export. (Inherited from GraphicsExporter) |
Static methods
| Method | Description |
|---|
| 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) |
Properties details
EmbedReferences
Flag to control if referenced textures should be embedded in binary blob or referenced by path to external files.
Syntax
SetEmbedReferences parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Embed flag. |
GetEmbedReferences return value
Type: bool
Syntax
SetEmbedReferences parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Embed flag. |
GetEmbedReferences return value
Type: bool
Syntax
SetEmbedReferences parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | Embed flag. |
GetEmbedReferences return value
Type: bool
ExportCascadedScenes
Flag to control if cascaded scenes should be included in the export (note that not all file formats support this).
Syntax
SetExportCascadedScenes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Export cascaded scenes flag. |
GetExportCascadedScenes return value
Type: bool
Syntax
SetExportCascadedScenes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Export cascaded scenes flag. |
GetExportCascadedScenes return value
Type: bool
Syntax
SetExportCascadedScenes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | Export cascaded scenes flag. |
GetExportCascadedScenes return value
Type: bool
ExportFilePath
The main export file path. This is the main file being written to, and must always be set.
Syntax
SetExportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired file path. |
GetExportFilePath return value
Type: spString
Syntax
SetExportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired file path. |
GetExportFilePath return value
Type: string
Syntax
SetExportFilePath parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired file path. |
GetExportFilePath return value
Type: str
Name
The name of the GLTFExporter object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
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.
Syntax
SetPrimaryTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | The name of the primary texcoord level. |
GetPrimaryTexCoordName return value
Type: spString
Syntax
SetPrimaryTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | The name of the primary texcoord level. |
GetPrimaryTexCoordName return value
Type: string
Syntax
SetPrimaryTexCoordName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | The name of the primary texcoord level. |
GetPrimaryTexCoordName return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetClass
Get the name of the GLTFExporter class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
IsA
Returns true if GLTFExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if GLTFExporter is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if GLTFExporter is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if GLTFExporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the GLTFExporter object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the GLTFExporter object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the GLTFExporter object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the GLTFExporter object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
RunExport
Runs the export. Note that all required parameters must be setup before exporting.
Syntax
Parameters
RunExport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunExport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunExport takes no parameters.
Return value
Type: bool
SetScene
The scene to export.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | scene | | | The desired scene object. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | scene | | | The desired scene object. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| scene | Scene | | | The desired scene object. |
SetSelectionSet
The selection set (of nodes from the scene) to export.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | exportSelectionSetID | | | The desired selection set id to use. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | exportSelectionSetID | | | The desired selection set id to use. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| exportSelectionSetID | int | | | The desired selection set id to use. |
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: GLTFExporter
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: GLTFExporter
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: GLTFExporter
