This reference page is linked to from the following overview topics: FBX SDK 2012, Your First FBX SDK Program, Importing and Exporting a Scene, I/O Settings, Importing a Scene, FBX SDK Object Model, FBX Objects, List of Python FBX classes.

Detailed 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:: KFbxReader

Typical workflow for using the KFbxImporter 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 KFbxImporter::Import() with an empty scene

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

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

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

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

 // Create an importer.
 KFbxImporter* lImporter = KFbxImporter::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, UIExamples/Common/ImportExport.cxx, UIExamples/SceneTreeView/SDK_Utility.cxx, ViewScene/InitScene.cxx, and ViewScene/main.cxx.

Definition at line 139 of file kfbximporter.h.

#include <kfbximporter.h>

Inheritance diagram for KFbxImporter:

[legend]

List of all members.

Public Member Functions
void	ParseForGlobalSettings (bool pState)
	Set a flag to parse or not the GlobalSettings data section when the importer is initialized.
void	ParseForStatistics (bool pState)
	Set a flag to parse or not in a FBX file the Summary data section or the Definition data section when the importer is initialized.
bool	GetAxisInfo (KFbxAxisSystem pAxisSystem, KFbxSystemUnit pSystemUnits)
	Get FBX file Axis information and FBX file System units.
bool	GetStatistics (KFbxStatistics *pStatistics)
	Get FBX file Statistics informations.
bool	GetFrameRate (KTime::ETimeMode &pTimeMode)
	Get FBX file time mode read from GlobalSettings in FBX 6.n and FBX 7.n.
bool	Import (KFbxDocument pDocument, KFbx pFbxObject)
Protected Member Functions
void	GetImportOptionsInfo ()
	KFbxImporter (KFbxSdkManager &pManager, char const *pName)
virtual void	Destruct (bool pRecursive, bool pDependents)
void	Reset ()
bool	FileOpen (KFile *pFile=NULL)
void	FileClose ()
bool	IsNativeExtension ()
Protected Attributes
KFbxImporterImp *	mImp
KFile *	mFile
bool	mImportOptionsDone
KArrayTemplate< KFbxTakeInfo * >	mTakeInfo
KFbxDocumentInfo *	mSceneInfo
KString	mActiveAnimStackName
int	mMajorVersion
int	mMinorVersion
int	mRevisionVersion
KFbxFileHeaderInfo *	mHeaderInfo
KFbxIOSettings *	mIOSettings
bool	mClientIOSettings
Friends
void	ImportThread (void *)
Import Functions
enum	EStreamOptionsGeneration { eSTREAMOPTIONS_PARSE_FILE, eSTREAMOPTIONS_FAST, eSTREAMOPTIONS_COUNT }
	Stream options identifiers. More...
virtual bool	Initialize (const char pFileName, const int pFileFormat=-1, KFbxIOSettings pIOSettings=NULL)
	Initialize object.
virtual bool	Initialize (KFile pFile, const int pFileFormat=-1, KFbxIOSettings pIOSettings=NULL)
	Initialize object.
virtual KFile *	GetFile ()
	Get the file, if any.
void	GetFileVersion (int &pMajor, int &pMinor, int &pRevision)
	Get the FBX version number of the FBX file.
bool	GetDefaultRenderResolution (KString &pCamName, KString &pResolutionMode, double &pW, double &pH)
	Get the default rendering resolution if present in the file header.
KFbxFileHeaderInfo *	GetFileHeaderInfo ()
	Get the complete file header information.
bool	GetImportOptions (EStreamOptionsGeneration pStreamOptionsGeneration=eSTREAMOPTIONS_PARSE_FILE)
	Read the currently opened file header to retrieve information related to takes.
bool	GetImportOptions (KFbx *pFbxObject)
	Read the currently opened file header to retrieve information related to takes.
bool	Import (KFbxDocument *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 (KString &pStatus)
	Get the progress status in non-blocking mode.
void	SetProgressCallback (KFbxProgressCallback pHandler)
	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.
KFbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
void	SetIOSettings (KFbxIOSettings *pIOSettings)
	Set the IOSettings pointer.
void	SetPassword (char *pPassword)
	Set the password.
Animation Stack Description Access
See also: KFbxAnimStack
int	GetAnimStackCount ()
	Get the number of available animation stacks in the file.
KFbxTakeInfo *	GetTakeInfo (int pIndex)
	Get the take information about an available take.
KString	GetActiveAnimStackName ()
	Return the active animation stack name.
Scene Description Access
KFbxDocumentInfo *	GetSceneInfo ()
	Get the scene info.
File Format
int	GetFileFormat ()
	Returns the index of the reader (FbxReader) associated with the file format.
bool	IsFBX ()

eSTREAMOPTIONS_PARSE_FILE	Search for all occurrences
eSTREAMOPTIONS_FAST	Search for all occurrences
eSTREAMOPTIONS_COUNT	Search for all occurrences

KFbxImporter	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

virtual bool Initialize	(	const char *	pFileName,
		const int	pFileFormat = `-1`,
		KFbxIOSettings *	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	(	KFile *	pFile,
		const int	pFileFormat = `-1`,
		KFbxIOSettings *	pIOSettings = `NULL`
	)		`[virtual]`

pFile	file to access. Ownership is transfered to this object.
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

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

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

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

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

bool Import	(	KFbxDocument *	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().

bool GetAxisInfo	(	KFbxAxisSystem *	pAxisSystem,
		KFbxSystemUnit *	pSystemUnits
	)

pAxisSystem	pointer to a KFbxAxisSystem object
pSystemUnits	pointer to a KFbxSystemUnit object

virtual void Destruct	(	bool	pRecursive,
		bool	pDependents
	)		`[protected, virtual]`

KFbxImporter Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Import Functions

Animation Stack Description Access

Scene Description Access

File Format

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation