Read and write 3D files

Detailed Description

3D I/O files principles

C3DIo is the class for reading a 3D file and obtain a C3DScene, or writing a C3DScene to a file.
A specific file format is recognized using the file extension, and the appropriate C3DParser is then called to read or write the file.
*

Reading a 3D file and get the scene

Reading a file is quite simple.

C3DIo file(filename, FILE_PARSER_LOADING);
C3DScene* scene = file.Read(&options); // &options is optional and can be removed if you don't need JT
if (!scene)
{
    file.ReportIoError();
    return;
}

You can provide some specific options using CSceneImportOptions. For example, you might need to define an FBX file.

CSceneImportOptions options;
options.GetParserOptions().SetString(FBX_IO_OPTION_PASSWORD, "My-password");
 
C3DIo file(filename, FILE_PARSER_LOADING); // if filename is an fbx file, then the password will be used by the fbx parser
C3DScene* scene = file.Read(&options);
if (!scene)
{
    file.ReportIoError();
    return;
}

Writing a scene to a file

Writing a C3DScene to a file is also easy. Here is a sample that use some specific options to export the scene.

CSceneExportOptions options;
options.flags = SCENE_EXPORT_REMOVE_CURVE | SCENE_EXPORT_TRIANGULATE | SCENE_EXPORT_MAKE_UNIQUE_NAME | SCENE_EXPORT_CONVERT_PATCH; // Flags used to prepare the scene before import
options.GetParserOptions().SetString(FBX_IO_OPTION_PASSWORD, "My-password"); // Cf. note above
 
C3DIo file(filename, FILE_PARSER_SAVING);
if (!file.Save(scene, &options))
{
    file.ReportIoError(error);
    OutputDebugString(error);
}

Retrieve the list of registered extensions

By default the SDK integrates a lot of parsers for different format.
This can be useful for displaying a dialog box for example.

The following code retrieve the 3D extensions that are recognized for reading.

CXString GetImportFilters(int& filternum)
{
    CXStringArray extArray;
    CXString filter;
    CXString allfiles;
    CXString tmp1, tmp2;
    unsigned int i=0, j, size;
 
    filternum = 0;
    filter.Empty();
 
    unsigned int extproperties = 0;
    unsigned int count;
    CFileExt *fileinfo;
    CFileExt *filesarray = fileGetRegisteredFiles(count, IMPORT_FILE|OBJECT_FILE); // EXPORT_FILE would get the file extensions for writing.
    for (i=0; i<count; i++)
    {
        fileinfo = &filesarray[i];
        
        size = fileGetExtensionArray(fileinfo->GetClass(), extArray); // A parser might register several extensions
        XASSERT(size);
 
        // Add the extension in the list
        tmp1.Empty();
        tmp2.Empty();
        for (j=0; j<size; j++)
        {
            XASSERT(extArray[j] == LowerCaseString(extArray[j]));
 
            tmp1 += '*'+extArray[j];
            tmp2 += '*'+extArray[j];
            if (j != size-1)
            {
                tmp1 += ", ";
                tmp2 += ";";
            }
 
            allfiles += extArray[j];
            allfiles += ";";
        }
 
        filter += fileinfo->GetDescription();
        filter += _T("|");
        filter += tmp2;
        filter += _T("|");
 
        filternum++;
    }
    fileFreeRegisteredFiles(filesarray, count);
 
    if (filternum > 1)
    {
        filter += _T("All recognized files");
        filter += "|";
        allfiles.Replace(_T("."), _T("*."));
        filter += allfiles; // Doesn't display file extension when too much extension are defined
        filter += "||";
        filternum++;
    }
 
    return filter;
}

C3DParser information

C3DParser usually defines some default flags and some needed flags for reading in the C3DParser::LoadDefaultOptions implementation. C3DParser::SaveDefaultOptions defines some default flags and some needed flags for writing.

For example if the parser export only triangles, it will set C3DParser::neededflags |= SCENE_EXPORT_TRIANGULATE which will make the scene being triangulated before the export.

Modules
	Implementing your own 3D parser
	Keep as much as possible information when saving a scene using Update Mode