class SceneExporter
Class for saving scene data to different file formats depending on the extension of the set file name.
Properties
| Property | Description |
|---|
| EmbedReferences | Flag to control if output file formats that support embedding referenced resources (like textures) should do so. |
| ExportCascadedScenes | Flag to control if cascaded scenes should be included in the export. |
| ExportFilePath | The main export file path. This must always be set. |
| Name | The name of the SceneExporter object. (Inherited from Object) |
| PrimaryTexCoordName | The primary texture coordinate layer name. Used by file formats that only support one texture coordinate layer (like .obj) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Close any open file or stream, release any allocated data. |
| GetClass | Get the name of the SceneExporter class. (Inherited from Object) |
| IsA | Returns true if SceneExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the SceneExporter object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the SceneExporter object is valid. (Inherited from Object) |
| NonNull | Returns true if the SceneExporter object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the SceneExporter object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunExport | Runs the export. Note that all parameters must be setup before importing. |
| SetScene | The scene to export. |
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 spSceneExporter, and if this is the case, returns the object cast into spSceneExporter. (Inherited from Object) |
Properties details
EmbedReferences
Flag to control if output file formats that support embedding referenced resources (like textures) should do so.
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.
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 must always be set.
Syntax
SetExportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired main export file path. |
GetExportFilePath return value
Type: spString
Syntax
SetExportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired main export file path. |
GetExportFilePath return value
Type: string
Syntax
SetExportFilePath parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired main export file path. |
GetExportFilePath return value
Type: str
Name
The name of the SceneExporter 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 primary texture coordinate layer name. Used by file formats that only support one texture coordinate layer (like .obj)
Syntax
SetPrimaryTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired primary texture coordinate layer name. |
GetPrimaryTexCoordName return value
Type: spString
Syntax
SetPrimaryTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired primary texture coordinate layer name. |
GetPrimaryTexCoordName return value
Type: string
Syntax
SetPrimaryTexCoordName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired primary texture coordinate layer name. |
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
Clear
Close any open file or stream, release any allocated data.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the SceneExporter 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 SceneExporter 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 SceneExporter 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 SceneExporter 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 SceneExporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the SceneExporter 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 SceneExporter 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 SceneExporter 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 SceneExporter 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 parameters must be setup before importing.
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 | value | | | The scene object to export. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene object to export. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | The scene object 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)
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 spSceneExporter, and if this is the case, returns the object cast into spSceneExporter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: SceneExporter
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: SceneExporter
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: SceneExporter
