class WavefrontImporter
OBJ scene importer
Properties
| Property | Description |
|---|
| ExtractGroups | The ExtractGroups boolean. If true, each group within the wavefront file is extracted into a separate geometry data object, that is named as the group. If false, the whole file is imported into one geometry data, and groups are ignored. |
| 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. (Inherited from GraphicsImporter) |
| MaterialFilePath | The material file path. If the path is not set, it is assumed to equal the path of the main obj file, but with the extension '.mtl' instead of '.obj'. If no material file is found or specified, materials that are found in the Wavefront file is added using default material settings to the material table. |
| Name | The name of the WavefrontImporter object. (Inherited from Object) |
| UseAlphaAsOpacity | The UseAlphaAsOpacity boolean. If set, then if the material has a map_d texture definition, and that texture is RGBA, the material will use the alpha channel rather than the color (R) to specify the opacity. |
| UseFallbackDiffuse | The UseFallbackDiffuse boolean. If set to true and the material is missing the diffuse channel, a default, bright diffuse will be used. |
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. (Inherited from GraphicsImporter) |
| GetClass | Get the name of the WavefrontImporter class. (Inherited from Object) |
| GetScene | The the scene loaded from the importer. (Inherited from GraphicsImporter) |
| IsA | Returns true if WavefrontImporter is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the WavefrontImporter object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the WavefrontImporter object is valid. (Inherited from Object) |
| NonNull | Returns true if the WavefrontImporter object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the WavefrontImporter object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunImport | Runs the import. Note that all parameters must be setup before importing. (Inherited from GraphicsImporter) |
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 spWavefrontImporter, and if this is the case, returns the object cast into spWavefrontImporter. (Inherited from Object) |
Properties details
The ExtractGroups boolean. If true, each group within the wavefront file is extracted into a separate geometry data object, that is named as the group. If false, the whole file is imported into one geometry data, and groups are ignored.
Syntax
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Is the bool the parameter is to be set to. |
Type: bool
Syntax
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Is the bool the parameter is to be set to. |
Type: bool
Syntax
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | Is the bool the parameter is to be set to. |
Type: bool
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
MaterialFilePath
The material file path. If the path is not set, it is assumed to equal the path of the main obj file, but with the extension '.mtl' instead of '.obj'. If no material file is found or specified, materials that are found in the Wavefront file is added using default material settings to the material table.
Syntax
SetMaterialFilePath parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | Is the path to the material file. |
GetMaterialFilePath return value
Type: spString
Syntax
SetMaterialFilePath parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | Is the path to the material file. |
GetMaterialFilePath return value
Type: string
Syntax
SetMaterialFilePath parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | Is the path to the material file. |
GetMaterialFilePath return value
Type: str
Name
The name of the WavefrontImporter 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
UseAlphaAsOpacity
The UseAlphaAsOpacity boolean. If set, then if the material has a map_d texture definition, and that texture is RGBA, the material will use the alpha channel rather than the color (R) to specify the opacity.
Syntax
SetUseAlphaAsOpacity parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Is the bool the parameter is to be set to. |
GetUseAlphaAsOpacity return value
Type: bool
Syntax
SetUseAlphaAsOpacity parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | Is the bool the parameter is to be set to. |
GetUseAlphaAsOpacity return value
Type: bool
Syntax
SetUseAlphaAsOpacity parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | Is the bool the parameter is to be set to. |
GetUseAlphaAsOpacity return value
Type: bool
UseFallbackDiffuse
The UseFallbackDiffuse boolean. If set to true and the material is missing the diffuse channel, a default, bright diffuse will be used.
Syntax
SetUseFallbackDiffuse parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The requested value of the bool. |
GetUseFallbackDiffuse return value
Type: bool
Syntax
SetUseFallbackDiffuse parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The requested value of the bool. |
GetUseFallbackDiffuse return value
Type: bool
Syntax
SetUseFallbackDiffuse parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The requested value of the bool. |
GetUseFallbackDiffuse return value
Type: bool
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 WavefrontImporter 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
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 WavefrontImporter 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 WavefrontImporter 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 WavefrontImporter 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 WavefrontImporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the WavefrontImporter 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 WavefrontImporter 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 WavefrontImporter 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 WavefrontImporter 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. |
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. (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 spWavefrontImporter, and if this is the case, returns the object cast into spWavefrontImporter. (Inherited from Object)
