Class Description

Class to import an FBX file into SDK objects.

Normally this class is used as is. But for very special needs a user can override Initialize() for special purpose.

An importer will select the appropriate reader to a particular file. Ex: When an importer must import an FBX 7 file, the importer will ask for all registered readers if an FBX 7 file reader is available, then if a reader is found, the importer will create the specialized FBX 7 reader and read the file. This way, an importer can "read" many different type of files like FBX 5/6/7, 3DS, Obj, Dxf, Collada, etc.

See also:: FbxReader

Typical workflow for using the FbxImporter class:

create a SDKManager
create an IOSettings object
create an empty scene
create an importer
initialize the importer with a file name and IOSettings
set numerous states, take information, defining how the importer will behave

call FbxImporter::Import() with an empty scene

 ex:
 // create a SdkManager
 FbxManager *lSdkManager = FbxManager::Create();

 // create an IOSettings object
 FbxIOSettings * ios = FbxIOSettings::Create(lSdkManager, IOSROOT );

 // set some IOSettings options 
 ios->SetBoolProp(IMP_FBX_MATERIAL, true);
 ios->SetBoolProp(IMP_FBX_TEXTURE,  true);

 // create an empty scene
 FbxScene* lScene = FbxScene::Create(lSdkManager,"");

 // Create an importer.
 FbxImporter* lImporter = FbxImporter::Create(lSdkManager, "");

 // Initialize the importer by providing a filename and the IOSettings to use
 lImporter->Initialize("C:\\myfile.fbx", -1, ios);

 // Import the scene.
 lImporter->Import(lScene); 

 // Destroy the importer.
 lImporter->Destroy();

Remarks:: According to the file suffix, a specialized reader will be created internally. Ex: for .fbx files a FBX Reader, for .3ds files, a 3ds reader, etc. Supported files formats: FBX 5/6/7 Binary & ASCII, Collada, DXF, OBJ, 3DS

Examples:: Common/Common.cxx, ExportScene05/main.cxx, MyOwnWriterReader/MyOwnWriterReader.cxx, MyOwnWriterReader/MyOwnWriterReader.h, UI_Examples/Common/ImportExport.cxx, UI_Examples/SceneTreeView/SDK_Utility.cxx, and ViewScene/SceneContext.h.

Definition at line 90 of file fbximporter.h.

Inheritance diagram for FbxImporter:

List of all members.

Import Functions
enum	EStreamOptionsGeneration { eParseFile, eDoNotParseFile }
	Stream options identifiers. More...
virtual bool	Initialize (const char pFileName, const int pFileFormat=-1, FbxIOSettings pIOSettings=NULL)
	Initialize object.
virtual bool	Initialize (FbxStream pStream, void pStreamData=NULL, const int pFileFormat=-1, FbxIOSettings *pIOSettings=NULL)
	Initialize object.
void	GetFileVersion (int &pMajor, int &pMinor, int &pRevision)
	Get the FBX version number of the FBX file.
bool	GetDefaultRenderResolution (FbxString &pCamName, FbxString &pResolutionMode, double &pW, double &pH)
	Get the default rendering resolution if present in the file header.
FbxIOFileHeaderInfo *	GetFileHeaderInfo ()
	Get the complete file header information.
bool	GetImportOptions (EStreamOptionsGeneration pStreamOptionsGeneration=eParseFile)
	Read the currently opened file header to retrieve information related to takes.
bool	GetImportOptions (FbxIO *pFbxObject)
	Read the currently opened file header to retrieve information related to takes.
bool	Import (FbxDocument *pDocument, bool pNonBlocking=false)
	Import the currently opened file into a scene.
bool	IsImporting (bool &pImportResult)
	Check if the importer is currently importing.
float	GetProgress (FbxString *pStatus=NULL)
	Get the progress status in non-blocking mode.
void	SetProgressCallback (FbxProgressCallback pCallback, void *pArgs=NULL)
	Register a callback function for progress reporting in single thread mode.
void	SetEmbeddingExtractionFolder (const char *pExtractFolder)
	Explicitly set the embedding extraction folder.
const char *	GetEmbeddingExtractionFolder ()
	Retrieve the current folder destination where the embedded files will be extracted.
FbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
void	SetIOSettings (FbxIOSettings *pIOSettings)
	Set the IOSettings pointer.
void	SetPassword (char *pPassword)
	Set the password.
Animation Stack Description Access
See also: FbxAnimStack
int	GetAnimStackCount ()
	Get the number of available animation stacks in the file.
FbxTakeInfo *	GetTakeInfo (int pIndex)
	Get the take information about an available take.
FbxString	GetActiveAnimStackName ()
	Return the active animation stack name.
Scene Description Access
FbxDocumentInfo *	GetSceneInfo ()
	Get the scene info.
File Format
int	GetFileFormat ()
	Returns the index of the reader (FbxReader) associated with the file format.
bool	IsFBX ()

eParseFile	Search for all occurrences
eDoNotParseFile	Search for all occurrences

virtual bool Initialize	(	const char *	pFileName,
		const int	pFileFormat = `-1`,
		FbxIOSettings *	pIOSettings = `NULL`
	)		`[virtual]`

pFileName	Name of file to access.
pFileFormat	file format identifier User does not need to specify it by default. if not specified, plugin will detect the file format according to file suffix automatically.
pIOSettings	client IOSettings, if not specified, a default IOSettings will be created

virtual bool Initialize	(	FbxStream *	pStream,
		void *	pStreamData = `NULL`,
		const int	pFileFormat = `-1`,
		FbxIOSettings *	pIOSettings = `NULL`
	)		`[virtual]`

pStream	stream to access.
pStreamData	user-defined stream data.
pFileFormat	file format identifier User does not need to specify it by default. if not specified, plugin will request the file format from the stream automatically.
pIOSettings	client IOSettings, if not specified, a default IOSettings will be created

void GetFileVersion	(	int &	pMajor,
		int &	pMinor,
		int &	pRevision
	)

pMajor	Version major number.
pMinor	Version minor number.
pRevision	Version revision number.

bool GetDefaultRenderResolution	(	FbxString &	pCamName,
		FbxString &	pResolutionMode,
		double &	pW,
		double &	pH
	)

pCamName	Returned name of the camera.
pResolutionMode	Returned resolution mode.
pW	Returned width.
pH	Returned height.

bool Import	(	FbxDocument *	pDocument,
		bool	pNonBlocking = `false`
	)

pDocument	Document to fill with file content.
pNonBlocking	If true, the import process will be executed in a new thread, allowing it to be non-blocking. To determine if the import finished, refer to the function IsImporting().

pCallback	Pointer of the callback function.
pArgs	pointer to the arguments passed to the callback function.

void SetProgressCallback	(	FbxProgressCallback	pCallback,
		void *	pArgs = `NULL`
	)

Class Description

Import Functions

Animation Stack Description Access

Scene Description Access

File Format

Member Enumeration Documentation

Member Function Documentation