class
BinaryImporter
BinaryImporter loads the geometry data from 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 |
ImportFilePath | The main import file path. This must always be set. Some importers, such as WavefrontImporter, also have secondary files that may be set. For info regarding these secondary files, please see the documentation for the specific importer. |
Methods
Method | Description |
Clear | Close any open file or stream, release any allocated data. |
GetClass | Get the name of the BinaryImporter class. |
GetScene | The the scene loaded from the importer. |
IsA | Returns true if BinaryImporter is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the BinaryImporter object is invalid. |
RunImport | Runs the import. Note that all parameters must be setup before importing. |
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 spBinaryImporter, and if this is the case, returns the object cast into spBinaryImporter. |
Properties details
ImportFilePath
The main import file path. This must always be set. Some importers, such as WavefrontImporter, also have secondary files that may be set. For info regarding these secondary files, please see the documentation for the specific importer.
Syntax
SetImportFilePath parameters
Type | Name | Min | Max | Description |
const char * | value | | | The desired ImportFilePath string. |
GetImportFilePath return value
Type: spString
Syntax
SetImportFilePath parameters
Type | Name | Min | Max | Description |
string | value | | | The desired ImportFilePath string. |
GetImportFilePath return value
Type: string
Syntax
SetImportFilePath parameters
Name | Type | Min | Max | Description |
value | str | | | The desired ImportFilePath string. |
GetImportFilePath return value
Type: str
Methods details
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 BinaryImporter 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
GetScene
The the scene loaded from the importer.
Syntax
Parameters
GetScene takes no parameters.
Return value
Type: Scene
Syntax
Parameters
GetScene takes no parameters.
Return value
Type: Scene
Syntax
Parameters
GetScene takes no parameters.
Return value
Type: Scene
IsA
Returns true if BinaryImporter 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 BinaryImporter 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 BinaryImporter 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 BinaryImporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the BinaryImporter 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
RunImport
Runs the import. Note that all parameters must be setup before importing.
Syntax
Parameters
RunImport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunImport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunImport takes no parameters.
Return value
Type: bool
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 spBinaryImporter, and if this is the case, returns the object cast into spBinaryImporter.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: BinaryImporter
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: BinaryImporter
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: BinaryImporter