class
BinaryExporter
BinaryExporter stores the geometry data into a binary file, that is specific for Simplygon. Please note that the binary file is only intended for temporary storage, and that no compatibility between versions of Simplygon is guaranteed.
Properties
Property | Description |
ExportFilePath | The main export file path. This is the main file being written to, and must always be set. |
PrimaryTexCoordName | The name of the texcoord level to use as primary level in case the file formatonly supports a single texture coordinate layer. If the primary level name is notset, the first found level will be used as primary level. |
Methods
Method | Description |
GetClass | Get the name of the BinaryExporter class. |
IsA | Returns true if BinaryExporter is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the BinaryExporter object is invalid. |
RunExport | Runs the export. Note that all required parameters must be setup before exporting. |
SetScene | The scene to export. |
SetSelectionSet | The selection set (of nodes from 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. |
SafeCast | SafeCast makes sure the input object is of a class that can be cast into spBinaryExporter, and if this is the case, returns the object cast into spBinaryExporter. |
Properties details
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
PrimaryTexCoordName
The name of the texcoord level to use as primary level in case the file formatonly supports a single texture coordinate layer. If the primary level name is notset, 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
GetClass
Get the name of the BinaryExporter class.
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 BinaryExporter is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if BinaryExporter 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 BinaryExporter 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 BinaryExporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the BinaryExporter object is invalid.
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
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.
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 spBinaryExporter, and if this is the case, returns the object cast into spBinaryExporter.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: BinaryExporter
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: BinaryExporter
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: BinaryExporter