Simplygon 9 Documentation

# 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.
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.
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 thediffuse channel, a default, bright diffuse will be used.

# Methods

Method Description
Clear Close any open file or stream, release any allocated data.
GetClass Get the name of the WavefrontImporter class.
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.
IsNull Returns true if the WavefrontImporter 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 spWavefrontImporter, and if this is the case, returns the object cast into spWavefrontImporter.

# 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.

# Syntax

// Setter
void SetExtractGroups( bool value );

// Getter
bool GetExtractGroups();

# SetExtractGroups parameters

Type Name Min Max Description
bool value Is the bool the parameter is to be set to.

# GetExtractGroups return value

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

// Setter
void SetImportFilePath( const char * value );

// Getter
spString GetImportFilePath();

# SetImportFilePath parameters

Type Name Min Max Description
const char * value The desired ImportFilePath string.

# GetImportFilePath return value

Type: spString

# 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

// Setter
void SetMaterialFilePath( const char * value );

// Getter
spString GetMaterialFilePath();

# SetMaterialFilePath parameters

Type Name Min Max Description
const char * value Is the path to the material file.

# GetMaterialFilePath return value

Type: spString

# 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

// Setter
void SetUseAlphaAsOpacity( bool value );

// Getter
bool GetUseAlphaAsOpacity();

# SetUseAlphaAsOpacity parameters

Type Name Min Max Description
bool value 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 thediffuse channel, a default, bright diffuse will be used.

# Syntax

// Setter
void SetUseFallbackDiffuse( bool value );

// Getter
bool GetUseFallbackDiffuse();

# SetUseFallbackDiffuse parameters

Type Name Min Max Description
bool value The requested value of the bool.

# GetUseFallbackDiffuse return value

Type: bool

# Methods details

# Clear

Close any open file or stream, release any allocated data.

# Syntax

void Clear();

# Parameters

Clear takes no parameters.

# GetClass

Get the name of the WavefrontImporter class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetScene

The the scene loaded from the importer.

# Syntax

spScene GetScene();

# 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.

# Syntax

bool IsA( const char * type );

# 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

# IsNull

Returns true if the WavefrontImporter object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# RunImport

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

# Syntax

bool RunImport();

# 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

static bool IsClassA( const char * type );

# 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

# 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.

# Syntax

static spWavefrontImporter SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: WavefrontImporter

← ImageDataExporter →