Skip to content
On this page

class WavefrontImporter

OBJ scene importer

Properties

PropertyDescription
ExtractGroupsThe 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.
ImportFilePathThe 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)
MaterialFilePathThe 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.
NameThe name of the WavefrontImporter object. (Inherited from Object)
UseAlphaAsOpacityThe 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.
UseFallbackDiffuseThe UseFallbackDiffuse boolean. If set to true and the material is missing the diffuse channel, a default, bright diffuse will be used.

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
ClearClose any open file or stream, release any allocated data. (Inherited from GraphicsImporter)
GetClassGet the name of the WavefrontImporter class. (Inherited from Object)
GetSceneThe the scene loaded from the importer. (Inherited from GraphicsImporter)
IsAReturns true if WavefrontImporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the WavefrontImporter object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the WavefrontImporter object is valid. (Inherited from Object)
NonNullReturns true if the WavefrontImporter object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the WavefrontImporter object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunRuns the import process. Note that all parameters must be setup before importing. (Inherited from GraphicsImporter)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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

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.

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 details

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 WavefrontImporter class. (Inherited from Object)

GetScene

The the scene loaded from the importer.

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)

Run

Runs the import process. Note that all parameters must be setup before importing.

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)

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)