class
SceneImporter
Class for loading scene data from different file formats.
Properties
Property | Description |
ImportFilePath | The main import file path. This must always be set. |
Methods
Method | Description |
Clear | Close any open file or stream, release any allocated data. |
GetClass | Get the name of the SceneImporter class. |
GetScene | The imported scene data. |
IsA | Returns true if SceneImporter is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the SceneImporter 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 spSceneImporter, and if this is the case, returns the object cast into spSceneImporter. |
Properties details
ImportFilePath
The main import file path. This must always be set.
Syntax
SetImportFilePath parameters
Type | Name | Min | Max | Description |
const char * | value | | | The desired main import file path. |
GetImportFilePath return value
Type: spString
Syntax
SetImportFilePath parameters
Type | Name | Min | Max | Description |
string | value | | | The desired main import file path. |
GetImportFilePath return value
Type: string
Syntax
SetImportFilePath parameters
Name | Type | Min | Max | Description |
value | str | | | The desired main import file path. |
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 SceneImporter 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 imported scene data.
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 SceneImporter 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 SceneImporter 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 SceneImporter 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 SceneImporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the SceneImporter 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 spSceneImporter, and if this is the case, returns the object cast into spSceneImporter.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: SceneImporter
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: SceneImporter
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: SceneImporter