FBX C++ API Reference
ExportDocument/main.cxx
/****************************************************************************************
Copyright (C) 2015 Autodesk, Inc.
All rights reserved.
Use of this software is subject to the terms of the Autodesk license agreement
provided at the time of installation or download, or which otherwise accompanies
this software in either electronic or hard copy form.
****************************************************************************************/
//
// The document created in this example is a container for objects.
// The document includes two sub-documents to contain materials and lights separately.
//
// The example illustrates how to:
// 1) create document and export
// 2) create objects that connect to document directly
// 3) create sub-document
// 4) create materials and textures, connect texture to material
// 5) create lights
// 6) export a document in a .FBX file (ASCII mode)
//
#include <fbxsdk.h>
#ifdef IOS_REF
#undef IOS_REF
#define IOS_REF (*(pManager->GetIOSettings()))
#endif
#define SAMPLE_FILENAME "ExportDocument.fbx"
bool CreateDocument(FbxManager* pManager, FbxDocument* pDocument);
void CreateMatDocument(FbxManager* pManager, FbxDocument* pMatDocument);
void CreateLightDocument(FbxManager* pManager, FbxDocument* pLightDocument);
FbxNode* CreatePlane(FbxManager* pManager, const char* pName);
FbxSurfacePhong* CreateMaterial(FbxManager* pManager);
FbxTexture* CreateTexture(FbxManager* pManager);
FbxNode* CreateLight(FbxManager* pManager, FbxLight::EType pType);
void InitializeSdkObjects(FbxManager*& pManager)
{
//The first thing to do is to create the FBX Manager which is the object allocator for almost all the classes in the SDK
pManager = FbxManager::Create();
if( !pManager )
{
FBXSDK_printf("Error: Unable to create FBX Manager!\n");
exit(1);
}
else FBXSDK_printf("Autodesk FBX SDK version %s\n", pManager->GetVersion());
//Create an IOSettings object. This object holds all import/export settings.
pManager->SetIOSettings(ios);
}
void DestroySdkObjects(FbxManager* pManager, bool pExitStatus)
{
//Delete the FBX Manager. All the objects that have been allocated using the FBX Manager and that haven't been explicitly destroyed are also automatically destroyed.
if( pManager ) pManager->Destroy();
if( pExitStatus ) FBXSDK_printf("Program Success!\n");
}
// Export document, the format is ascii by default
bool SaveDocument(FbxManager* pManager, FbxDocument* pDocument, const char* pFilename, int pFileFormat=-1, bool pEmbedMedia=false)
{
int lMajor, lMinor, lRevision;
bool lStatus = true;
// Create an exporter.
FbxExporter* lExporter = FbxExporter::Create(pManager, "");
if( pFileFormat < 0 || pFileFormat >= pManager->GetIOPluginRegistry()->GetWriterFormatCount() )
{
// Write in fall back format if pEmbedMedia is true
pFileFormat = pManager->GetIOPluginRegistry()->GetNativeWriterFormat();
if (!pEmbedMedia)
{
//Try to export in ASCII if possible
int lFormatIndex, lFormatCount = pManager->GetIOPluginRegistry()->GetWriterFormatCount();
for (lFormatIndex=0; lFormatIndex<lFormatCount; lFormatIndex++)
{
if (pManager->GetIOPluginRegistry()->WriterIsFBX(lFormatIndex))
{
FbxString lDesc =pManager->GetIOPluginRegistry()->GetWriterFormatDescription(lFormatIndex);
const char *lASCII = "ascii";
if (lDesc.Find(lASCII)>=0)
{
pFileFormat = lFormatIndex;
break;
}
}
}
}
}
// Set the export states. By default, the export states are always set to
// true except for the option eEXPORT_TEXTURE_AS_EMBEDDED. The code below
// shows how to change these states.
IOS_REF.SetBoolProp(EXP_FBX_MATERIAL, true);
IOS_REF.SetBoolProp(EXP_FBX_TEXTURE, true);
IOS_REF.SetBoolProp(EXP_FBX_EMBEDDED, pEmbedMedia);
IOS_REF.SetBoolProp(EXP_FBX_ANIMATION, true);
IOS_REF.SetBoolProp(EXP_FBX_GLOBAL_SETTINGS, true);
// Initialize the exporter by providing a filename.
if(lExporter->Initialize(pFilename, pFileFormat, pManager->GetIOSettings()) == false)
{
FBXSDK_printf("Call to FbxExporter::Initialize() failed.\n");
FBXSDK_printf("Error returned: %s\n\n", lExporter->GetStatus().GetErrorString());
return false;
}
FbxManager::GetFileFormatVersion(lMajor, lMinor, lRevision);
FBXSDK_printf("FBX version number for this version of the FBX SDK is %d.%d.%d\n\n", lMajor, lMinor, lRevision);
// Export the scene.
lStatus = lExporter->Export(pDocument);
// Destroy the exporter.
lExporter->Destroy();
return lStatus;
}
int main(int argc, char** argv)
{
FbxManager* lSdkManager = NULL;
FbxDocument* lDocument = NULL;
bool lResult = false;
// Prepare the FBX SDK.
InitializeSdkObjects(lSdkManager);
// create the main document
lDocument = FbxDocument::Create(lSdkManager, "RootDoc");
// The example can take an output file name as an argument.
const char* lSampleFileName = NULL;
for( int i = 1; i < argc; ++i )
{
if( FBXSDK_stricmp(argv[i], "-test") == 0 ) continue;
else if( !lSampleFileName ) lSampleFileName = argv[i];
}
if( !lSampleFileName ) lSampleFileName = SAMPLE_FILENAME;
// Create the scene.
lResult = CreateDocument(lSdkManager, lDocument);
if( lResult )
{
//Save the document
lResult = SaveDocument(lSdkManager, lDocument, lSampleFileName);
if( !lResult ) FBXSDK_printf("\n\nAn error occurred while saving the document...\n");
}
else FBXSDK_printf("\n\nAn error occurred while creating the document...\n");
// Destroy all objects created by the FBX SDK.
DestroySdkObjects(lSdkManager, lResult);
return 0;
}
bool CreateDocument(FbxManager* pManager, FbxDocument* pDocument)
{
int lCount;
// create document info
FbxDocumentInfo* lDocInfo = FbxDocumentInfo::Create(pManager,"DocInfo");
lDocInfo->mTitle = "Example document";
lDocInfo->mSubject = "Illustrates the creation of FbxDocument with geometries, materials and lights.";
lDocInfo->mAuthor = "ExportDocument.exe sample program.";
lDocInfo->mRevision = "rev. 1.0";
lDocInfo->mKeywords = "Fbx document";
lDocInfo->mComment = "no particular comments required.";
// add the documentInfo
pDocument->SetDocumentInfo(lDocInfo);
// NOTE: Objects created directly in the SDK Manager are not visible
// to the disk save routines unless they are manually connected to the
// documents (see below). Ideally, one would directly use the FbxScene/FbxDocument
// during the creation of objects so they are automatically connected and become visible
// to the disk save routines.
FbxNode* lPlane = CreatePlane(pManager, "Plane");
// add the geometry to the main document.
pDocument->AddRootMember(lPlane);
lCount = pDocument->GetRootMemberCount(); // lCount = 1: only the lPlane
lCount = pDocument->GetMemberCount(); // lCount = 3: the FbxNode - lPlane; FbxMesh belongs to lPlane; Material that connect to lPlane
// Create sub document to contain materials.
FbxDocument* lMatDocument = FbxDocument::Create(pManager,"Material");
CreateMatDocument(pManager, lMatDocument);
// Connect the light sub document to main document
pDocument->AddMember(lMatDocument);
// Create sub document to contain lights
FbxDocument* lLightDocument = FbxDocument::Create(pManager,"Light");
CreateLightDocument(pManager, lLightDocument);
// Connect the light sub document to main document
pDocument->AddMember(lLightDocument);
lCount = pDocument->GetMemberCount(); // lCount = 5 : 3 add two sub document
// document can contain animation. Please refer to other sample about how to set animation
pDocument->CreateAnimStack("PlanAnim");
lCount = pDocument->GetRootMemberCount(); // lCount = 1: only the lPlane
lCount = pDocument->GetMemberCount(); // lCount = 7: 5 add AnimStack and AnimLayer
lCount = pDocument->GetMemberCount<FbxDocument>(); // lCount = 2
return true;
}
// Create material sub document
void CreateMatDocument(FbxManager* pManager, FbxDocument* pMatDocument)
{
// create document info
FbxDocumentInfo* lDocInfo = FbxDocumentInfo::Create(pManager,"DocInfo");
lDocInfo->mTitle = "Sub document for materials";
lDocInfo->mSubject = "Illustrates the creation of sub-FbxDocument with materials.";
lDocInfo->mAuthor = "ExportDocument.exe sample program.";
lDocInfo->mRevision = "rev. 1.0";
lDocInfo->mKeywords = "Fbx material document";
lDocInfo->mComment = "no particular comments required.";
// add the documentInfo
pMatDocument->SetDocumentInfo(lDocInfo);
// add material object to the sub document
pMatDocument->AddMember(CreateMaterial(pManager));
}
// Create light sub document
void CreateLightDocument(FbxManager* pManager, FbxDocument* pLightDocument)
{
// create document info
FbxDocumentInfo* lDocInfo = FbxDocumentInfo::Create(pManager,"DocInfo");
lDocInfo->mTitle = "Sub document for lights";
lDocInfo->mSubject = "Illustrates the creation of sub-FbxDocument with lights.";
lDocInfo->mAuthor = "ExportDocument.exe sample program.";
lDocInfo->mRevision = "rev. 1.0";
lDocInfo->mKeywords = "Fbx light document";
lDocInfo->mComment = "no particular comments required.";
// add the documentInfo
pLightDocument->SetDocumentInfo(lDocInfo);
// add light objects to the sub document
pLightDocument->AddMember(CreateLight(pManager, FbxLight::eSpot));
pLightDocument->AddMember(CreateLight(pManager, FbxLight::ePoint));
}
// Create a plane mesh.
FbxNode* CreatePlane(FbxManager* pManager, const char* pName)
{
int i;
FbxMesh* lMesh = FbxMesh::Create(pManager,pName);
FbxVector4 lControlPoint0(-50, 0, 50);
FbxVector4 lControlPoint1(50, 0, 50);
FbxVector4 lControlPoint2(50, 100, 50);
FbxVector4 lControlPoint3(-50, 100, 50);
FbxVector4 lNormalZPos(0, 0, 1);
// Create control points.
lMesh->InitControlPoints(4);
FbxVector4* lControlPoints = lMesh->GetControlPoints();
lControlPoints[0] = lControlPoint0;
lControlPoints[1] = lControlPoint1;
lControlPoints[2] = lControlPoint2;
lControlPoints[3] = lControlPoint3;
// We want to have one normal for each vertex (or control point),
// so we set the mapping mode to eByControlPoint.
FbxGeometryElementNormal* lElementNormal= lMesh->CreateElementNormal();
// Set the normal values for every control point.
lElementNormal->GetDirectArray().Add(lNormalZPos);
lElementNormal->GetDirectArray().Add(lNormalZPos);
lElementNormal->GetDirectArray().Add(lNormalZPos);
lElementNormal->GetDirectArray().Add(lNormalZPos);
// Array of polygon vertices.
int lPolygonVertices[] = { 0, 1, 2, 3 };
// Create UV for Diffuse channel.
FbxGeometryElementUV* lUVDiffuseElement = lMesh->CreateElementUV( "DiffuseUV");
FBX_ASSERT( lUVDiffuseElement != NULL);
FbxVector2 lVectors0(0, 0);
FbxVector2 lVectors1(1, 0);
FbxVector2 lVectors2(1, 1);
FbxVector2 lVectors3(0, 1);
lUVDiffuseElement->GetDirectArray().Add(lVectors0);
lUVDiffuseElement->GetDirectArray().Add(lVectors1);
lUVDiffuseElement->GetDirectArray().Add(lVectors2);
lUVDiffuseElement->GetDirectArray().Add(lVectors3);
//Now we have set the UVs as eIndexToDirect reference and in eByPolygonVertex mapping mode
//we must update the size of the index array.
lUVDiffuseElement->GetIndexArray().SetCount(4);
// Create polygons. Assign texture and texture UV indices.
// all faces of the cube have the same texture
lMesh->BeginPolygon(-1, -1, -1, false);
for(i = 0; i < 4; i++)
{
// Control point index
lMesh->AddPolygon(lPolygonVertices[i]);
// update the index array of the UVs that map the texture to the face
lUVDiffuseElement->GetIndexArray().SetAt(i, i);
}
lMesh->EndPolygon ();
// create a FbxNode
FbxNode* lNode = FbxNode::Create(pManager,pName);
// set the node attribute
lNode->SetNodeAttribute(lMesh);
// set the shading mode to view texture
// rotate the plane
lNode->LclRotation.Set(FbxVector4(90, 0, 0));
// Set material mapping.
FbxGeometryElementMaterial* lMaterialElement = lMesh->CreateElementMaterial();
if( !lMesh->GetElementMaterial( 0))
return NULL;
// add material to the node.
// the material can't in different document with the geometry node or in sub-document
// we create a simple material here which belong to main document
FbxString lMaterialName = "material_for_plane";
FbxString lShadingName = "Phong";
FbxSurfacePhong* lMaterial = FbxSurfacePhong::Create(pManager, lMaterialName.Buffer());
lMaterial->Diffuse.Set(FbxDouble3(1.0, 1.0, 0));
lMaterial->DiffuseFactor.Set(1.);
lNode->AddMaterial(lMaterial);
// We are in eByPolygon, so there's only need for index (a plane has 1 polygon).
lMaterialElement->GetIndexArray().SetCount(lMesh->GetPolygonCount());
// Set the Index to the material
for(i=0; i<lMesh->GetPolygonCount(); ++i)
lMaterialElement->GetIndexArray().SetAt(i,0);
// return the FbxNode
return lNode;
}
// Create a texture
FbxTexture* CreateTexture(FbxManager* pManager)
{
FbxFileTexture* lTexture = FbxFileTexture::Create(pManager,"");
// Resource file must be in the application's directory.
FbxString lTexPath = lPath + "\\Crate.jpg";
// Set texture properties.
lTexture->SetFileName(lTexPath.Buffer());
lTexture->SetName("Diffuse Texture");
lTexture->SetSwapUV(false);
lTexture->SetTranslation(0.0, 0.0);
lTexture->SetScale(1.0, 1.0);
lTexture->SetRotation(0.0, 0.0);
return lTexture;
}
// Create material.
// FBX scene must connect materials FbxNode, otherwise materials will not be exported.
// FBX document don't need connect materials to FbxNode, it can export standalone materials.
FbxSurfacePhong* CreateMaterial(FbxManager* pManager)
{
FbxString lMaterialName = "material";
FbxString lShadingName = "Phong";
FbxDouble3 lBlack(0.0, 0.0, 0.0);
FbxDouble3 lRed(1.0, 0.0, 0.0);
FbxDouble3 lDiffuseColor(0.75, 0.75, 0.0);
FbxSurfacePhong* lMaterial = FbxSurfacePhong::Create(pManager, lMaterialName.Buffer());
// Generate primary and secondary colors.
lMaterial->Emissive .Set(lBlack);
lMaterial->Ambient .Set(lRed);
lMaterial->AmbientFactor .Set(1.);
// Add texture for diffuse channel
lMaterial->Diffuse .ConnectSrcObject(CreateTexture(pManager));
lMaterial->DiffuseFactor .Set(1.);
lMaterial->TransparencyFactor .Set(0.4);
lMaterial->ShadingModel .Set(lShadingName);
lMaterial->Shininess .Set(0.5);
lMaterial->Specular .Set(lBlack);
lMaterial->SpecularFactor .Set(0.3);
return lMaterial;
}
// Create light.
FbxNode* CreateLight(FbxManager* pManager, FbxLight::EType pType)
{
FbxString lLightName;
FbxDouble val;
switch (pType)
{
lLightName = "SpotLight";
break;
lLightName = "PointLight";
break;
lLightName = "DirectionalLight";
break;
default:
break;
}
FbxLight* lFbxLight = FbxLight::Create(pManager, lLightName.Buffer());
lFbxLight->LightType.Set(pType);
// parameters for spot light
if (pType == FbxLight::eSpot)
{
lFbxLight->InnerAngle.Set(40.0);
val = lFbxLight->InnerAngle.Get(); // val = 40
lFbxLight->OuterAngle.Set(40);
val = lFbxLight->OuterAngle.Get(); // val = 40
}
//
// Light Color...
//
FbxDouble3 lColor;
lColor[0] = 0.0;
lColor[1] = 1.0;
lColor[2] = 0.5;
lFbxLight->Color.Set(lColor);
FbxDouble3 val3 = lFbxLight->Color.Get(); // val3 = (0, 1, 0.5)
//
// Light Intensity...
//
lFbxLight->Intensity.Set(100.0);
val = lFbxLight->Intensity.Get(); // val = 100
// create a FbxNode
FbxNode* lNode = FbxNode::Create(pManager,lLightName+"Node");
// set the node attribute
lNode->SetNodeAttribute(lFbxLight);
lNode->LclTranslation.Set(FbxDouble3(20, 30, 100));
val3 = lNode->LclTranslation.Get(); // val3 = (20, 30, 100)
return lNode;
}