This reference page is linked to from the following overview topics: Information and Technical Support, Differences between FBX SDK and Python FBX, List of Python FBX classes.

Detailed Description

KFbx represents an FBX file.

It is primarily used by FBX importers (KFbxImporter) and exporter (KFbxExporter) when reading or writing data from or to a disk or memory. Most users will not use the KFbx class directly but will use an instance of either KFbxImporter or KFbxExporter to read or write FBX files.

An FBX file may contain binary data or ASCII data. A good way to learn the internal structure of a FBX file is to open a FBX file saved in ASCII in a text editor.

Ex: to read a FBX file content using KFbx class directly

 // Create a KFbx object with KFbx::KFbxObjectCreate()
 // Open the file with ProjectOpen( ... ) a NULL pointer can be passed for (KFbxReader)* param
 // ProjectOpen_xxx_Section() to open a particular section
 int nbSec = FieldGetCount(); // to get the number of fields of the current section opened
    for(int i=0; i < nbSec; i++) // read all fields
    {
        // check if the field is a bloc
        if(FieldReadIsBlock()){ } ... Read sub fields recursively ... may contain other blocks and fields
        else
        {
            FieldReadBegin();   // navigate on the field
            char fieldType = FieldReadGetType(); // get the data type

            // According to the Field data type, call the appropriate read functions

                 if(fieldType == 'S') FieldReadS(...) to read a string
            else if(fieldType == 'B') FieldReadB(...) to read a bool
            else if(fieldType == 'I') FieldReadI(...) to read a int
            ... 
            FieldReadEnd(); // navigate to next field
        }
    }

 ProjectCloseSection() // close the section opened
 // repeat for another section ...
 // finally close the Project
 ProjectClose(); // or delete the KFbx object created.

Definition at line 293 of file kfbx.h.

#include <kfbx.h>

List of all members.

Classes
struct	KFbxAutoResetXRefManager
Public Member Functions
	KFbx ()
	Default constructor.
virtual	~KFbx ()
	Destructor.
virtual bool	FieldReadEmbeddedFile (KString &pFileName, KString &pRelativeFileName, const char pEmbeddedMediaDirectory="", bool pIsFileCreated=NULL)
	Read field and copy it into a file.
const double *	FieldReadArrayD (int &pCount)
	Read the whole array and return the pointer to it.
const float *	FieldReadArrayF (int &pCount)
	Read the whole array and return the pointer to it.
const int *	FieldReadArrayI (int &pCount)
	Read the whole array and return the pointer to it.
const kLongLong *	FieldReadArrayLL (int &pCount)
	Read the whole array and return the pointer to it.
const bool *	FieldReadArrayB (int &pCount)
	Read the whole array and return the pointer to it.
const kUByte *	FieldReadArrayBytes (int &pCount)
	Read the whole array and return the pointer to it.
const int *	FieldReadArray (int &pCount, const int *)
	Read the whole array and return the pointer to it.
const float *	FieldReadArray (int &pCount, const float *)
	Read the whole array and return the pointer to it.
const double *	FieldReadArray (int &pCount, const double *)
	Read the whole array and return the pointer to it.
const kLongLong *	FieldReadArray (int &pCount, const kLongLong *)
	Read the whole array and return the pointer to it.
const bool *	FieldReadArray (int &pCount, const bool *)
	Read the whole array and return the pointer to it.
const kUByte *	FieldReadArray (int &pCount, const kUByte *)
	Read the whole array and return the pointer to it.
int	GetFieldRMaxChunkSize () const
	ASCII files may limit how big you can write your raw data, forcing you to break it down into chunks.
void	FieldWriteObjectReference (const char *pName)
	Write object reference pName in the current field.
void	FieldWriteObjectReference (const char pFieldName, const char pName)
	Write object reference pName in field pFieldName.
bool	FieldWriteEmbeddedFile (KString pFileName, KString pRelativeFileName)
	Write field with file content as a value.
void	WriteComments (const char *pFieldName)
	Write comments, only effective in ASCII mode.
bool	GetHaveLoadedEmbededFile () const
	Get if the embedded file is currently loaded.
void *	GetMemoryFileInfo (kULong &pSize) const
	Get the maximum byte count written.
bool	IsBeforeVersion6 () const
	Get a internal flag to manage pre FBX version 6 data format Used for backwards compatibility.
void	SetIsBeforeVersion6 (bool pIsBeforeVersion6)
	Set a internal flag to manage pre FBX version 6 data format Used for backwards compatibility.
Project Global
The term "Project" here is an abstract name chosen to represent a group of data ex: a file, a stream, a memory buffer, etc.
bool	ProjectOpen (void pAddress, kULong pMaxLength, KFbxReader pReader, bool pCheckCRC=false, bool pOpenMainSection=true, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Open a project already in Memory.
bool	ProjectOpen (const char pName, KFbxReader pReader, bool pCheckCRC=false, bool pOpenMainSection=true, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Open a project.
bool	ProjectOpen (KFile pFile, KFbxReader pReader, bool pCheckCRC=false, bool pOpenMainSection=true, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Open a project on the specified KFile.
bool	ProjectOpenDirect (const char pName, KFbxReader pReader, bool pCheckCRC=false, bool pOpenMainSection=true, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Open project file without necessarily an .fbx extension.
bool	ProjectCreate (void pAddress, kUInt pSize, KFbxWriter pWriter, bool pBinary, bool pEncrypted, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Create a project in Memory.
bool	ProjectCreate (const char pName, KFbxWriter pWriter, bool pBinary, bool pEncrypted, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Create a project.
bool	ProjectCreateDirect (const char pName, KFbxWriter pWriter, bool pBinary, bool pEncrypted, KFbxFileHeaderInfo *pFileHeaderInfo=NULL)
	Create a project without necessary an .fbx extension.
bool	ProjectCreateEmpty (const char pName, KFbxWriter pWriter, int pVersion, bool pBinary, bool pEncrypted)
	Create a project, without writing out the header (yet)
bool	ProjectWrite_BeginFileHeader ()
	Write FBX signature at the top of the file, prepare file for writing header information.
bool	ProjectWrite_BeginExtendedHeader ()
	Open up the 'extended header'.
bool	ProjectWrite_WriteExtendedHeader (const KFbxFileHeaderInfo *pExtendedHeader)
	Write the contents of the extended header.
bool	ProjectWrite_EndExtendedHeader ()
	Close the extended header.
bool	ProjectWrite_EndFileHeader ()
	Close up the header, prepare file for payload write.
bool	ProjectClose (void *pData=0, kULong pSize=0)
	Close the project.
void	ProjectSetXRefManager (const KFbxXRefManager *)
	Provide the XRef Manager to use to create the .fbm folder.
const KFbxXRefManager *	ProjectGetXRefManager () const
	Get the XRef Manager to use.
bool	ProjectCreateEmbeddedFolder (const KFbxXRefManager &pXRefManager, KString &pCreatedFolder, const char *pUserDefinedFolder=NULL)
	Select (and create) a folder to store embedded files (the .fbm file folder).
void	SetEmbedded (bool pValue)
	On store event, use this function to tell if we are embedding.
void	SetEmbeddingExtractionFolder (const char *pExtractionFolder)
	Explicitly set the embedding extraction folder.
const char *	GetEmbeddingExtractionFolder ()
	Retrieve the current folder destination where the embedded files will be extracted.
bool	IsEmbedded () const
	Check if file is embedded or not.
bool	IsBinary () const
	Check if file is binary or ASCII.
bool	IsEncrypted () const
	Return if binary file is encrypted.
bool	CheckCRC ()
	Check CRC code.
kUInt32	GetFileVersionNumber () const
	Return the file version number.
FBX 7 Format specific functions.
The FBX 7 format can compress internal arrays to make the file smaller. The writer may decide not to compress all arrays, or it may even decide not to compress anyway. Flags are written in the file to help the FBX7 reader to know if a decompression is required, on a per-array basis. The following functions address specific topics of the FBX 7 file format.
bool	Fbx7Support () const
void	Fbx7Support (bool pSupport)
	Set the flag state to tell the parser to handle FBX7 files.
bool	CompressArrays () const
void	CompressArrays (bool pCompress)
	Set the flag state.
int	CompressMinimumSize () const
void	CompressMinimumSize (int pSize)
	Set the compression minimum size.
int	CompressLevel () const
void	CompressLevel (int pLevel)
	Set the compression level.
Directory related functions used to get or set file path information.
const char *	GetFilename () const
	Get project file name.
KString	GetDataDirectory (bool pAutoCreate=true)
	Get project data directory name.
KString	GetMediaDirectory (bool pCreate=false, const char *pUserDefinedFolder=NULL)
	Get the current embedded folder used by this object.
KString	GetContainerTemplateDirectory (const char *pTemplateName, bool pCreate)
	Get the full path of the directory to extract the template file.
char *	GetRelativePath (const char *pPath)
	Get the path relative to project directory.
char *	GetRelativeFilePath (const char *pFilePath)
	Get the file path relative to project directory.
char *	GetFullPath (const char *pRelativePath)
	Get the full path of path relative to project directory.
char *	GetFullFilePath (const char *pRelativeFilePath)
	Get the full file path of path relative to project directory.
char *	GetTmpProjectName (const char *pName) const
	Get the temporary project name.
bool	SwapFromTmpProject (const char pName, char pError=NULL)
	Swap from temporary project.
Read related functions used to get information of a field or a group of fields.
Can be used to get the field content data or to navigate from field to field.
void	FieldReadResetPosition ()
	Reset the field read position.
int	FieldGetCount () const
	Get the number of fields.
const char *	FieldGetName (int pFieldIndex) const
	Get the name of field indexed pFieldIndex.
int	FieldGetInstanceCount (const char *pFieldName) const
	Get number of instance field pFieldName has.
bool	FieldReadBegin (int pFieldIndex, int pInstance)
	Start to read field instance referred by field indexed pFieldIndex, instance indexed pInstance.
bool	FieldReadBegin (const char *pFieldName)
	Start to read field pFieldName.
bool	FieldReadBegin (const char *pFieldName, int pInstance)
	Start to read field instance referred field pFieldName, instance indexed pInstance.
void	FieldReadEnd ()
	Stop to read the current field.
bool	FieldReadIsBlock ()
	Return if current field is a block.
bool	FieldReadBlockBegin ()
	Start to read a field block.
void	FieldReadBlockEnd ()
	Stop to read a field block.
int	FieldReadGetCount () const
	Return the number of read field.
int	FieldReadGetRemain () const
	Return the number of field remaining to be read.
char	FieldReadGetType () const
	Return current field value type.
char	FieldReadCH ()
	Return current field value as a char.
char	FieldReadCH (const char *pFieldName, char pDefault=0)
	Return field pFieldName's value as a char.
const char *	FieldReadC ()
	Return current field value as a char pointer.
const char *	FieldReadC (const char pFieldName, const char pDefault="")
	Return field pFieldName's value as a char pointer.
const char *	FieldReadS ()
	Return current field value as a string (a char pointer).
const char *	FieldReadS (const char pFieldName, const char pDefault="")
	Return field pFieldName's value as a char pointer.
bool	FieldReadB ()
	Return current field value as an bool.
bool	FieldReadB (const char *pFieldName, bool pDefault=false)
	Return field pFieldName's value as an integer.
int	FieldReadI ()
	Return current field value as an integer.
int	FieldReadI (const char *pFieldName, int pDefault=0)
	Return field pFieldName's value as an integer.
kLongLong	FieldReadLL ()
	Return current field value as an integer.
kLongLong	FieldReadLL (const char *pFieldName, kLongLong pDefault=0)
	Return field pFieldName's value as an integer.
float	FieldReadF ()
	Return current field value as a float.
float	FieldReadF (const char *pFieldName, float pDefault=0)
	Return field pFieldName's value as a float.
double	FieldReadD ()
	Return current field value as a double.
double	FieldReadD (const char *pFieldName, double pDefault=0)
	Return field pFieldName's value as a double.
KTime	FieldReadT (const char *pFieldName)
	Return field pFieldName's value as a time value.
KTime	FieldReadT ()
	Return field pFieldName's value as a time value.
KTimeSpan	FieldReadTS (const char *pFieldName)
	Return field pFieldName's value as a timespan value.
KTimeSpan	FieldReadTS ()
	Return field pFieldName's value as a timespan value.
void	FieldReadFn (float *pValue, kUInt pn)
	Return current field value as a n floats array.
void	FieldRead3F (float *pValue)
	Return current field value as a 3 floats array.
void	FieldRead4F (float *pValue)
	Return current field value as a 4 floats array.
void	FieldReadFn (const char pFieldName, float pValue, const float *pDefault, kUInt pn)
	Return field pFieldName's value as n floats array.
void	FieldRead3F (const char pFieldName, float pValue, const float *pDefault=NULL)
	Return field pFieldName's value as 4 floats array.
void	FieldRead4F (const char pFieldName, float pValue, const float *pDefault=NULL)
	Return field pFieldName's value as 3 floats array.
void	FieldReadDn (double *pValue, kUInt pn)
	Return current field value as a n doubles array.
void	FieldRead3D (double *pValue)
	Return current field value as a 3 doubles array.
void	FieldRead4D (double *pValue)
	Return current field value as a 4 doubles array.
void	FieldReadDn (const char pFieldName, double pValue, const double *pDefault, kUInt pn)
	Return field pFieldName's value as n doubles array.
void	FieldRead3D (const char pFieldName, double pValue, const double *pDefault=NULL)
	Return field pFieldName's value as 4 doubles array.
void	FieldRead4D (const char pFieldName, double pValue, const double *pDefault=NULL)
	Return field pFieldName's value as 3 doubles array.
void *	FieldReadR (int *pByteSize)
	Return current field value as raw data.
void *	FieldReadR (const char pFieldName, int pByteSize)
	Return field pFieldName's value as raw data.
FBX SDK 2009.3 and later
kByte	FieldReadByte ()
	Return field pFieldName's value as byte.
kByte	FieldReadByte (const char *pFieldName, kByte pDefault=0)
	Return field pFieldName's value as a byte value.
kUByte	FieldReadUByte ()
	Return field pFieldName's value as unsigned byte.
kUByte	FieldReadUByte (const char *pFieldName, kUByte pDefault=0)
	Return field pFieldName's value as an unsigned byte value.
kShort	FieldReadShort ()
	Return field pFieldName's value as short.
kShort	FieldReadShort (const char *pFieldName, kShort pDefault=0)
	Return field pFieldName's value as a short value.
kUShort	FieldReadUShort ()
	Return field pFieldName's value as unsigned short.
kUShort	FieldReadUShort (const char *pFieldName, kUShort pDefault=0)
	Return field pFieldName's value as an unsigned short value.
unsigned int	FieldReadUI ()
	Return field pFieldName's value as unsigned integer.
unsigned int	FieldReadUI (const char *pFieldName, unsigned int pDefault=0)
	Return field pFieldName's value as an unsigned int as a value.
kULongLong	FieldReadULL ()
	Return field pFieldName's value as 64 bit unsigned integer.
kULongLong	FieldReadULL (const char *pFieldName, kULongLong pDefault=0)
	Return field pFieldName's value as an 64 bit unsigned int as a value.
const kByte *	FieldReadArraySBytes (int &pCount)
	Read the whole array and return the pointer to it.
const kShort *	FieldReadArrayShort (int &pCount)
	Read the whole array and return the pointer to it.
const kUShort *	FieldReadArrayUShort (int &pCount)
	Read the whole array and return the pointer to it.
const unsigned int *	FieldReadArrayUI (int &pCount)
	Read the whole array and return the pointer to it.
const kULongLong *	FieldReadArrayULL (int &pCount)
	Read the whole array and return the pointer to it.
const kByte *	FieldReadArray (int &pCount, const kByte *)
	Read the whole array and return the pointer to it.
const kShort *	FieldReadArray (int &pCount, const kShort *)
	Read the whole array and return the pointer to it.
const kUShort *	FieldReadArray (int &pCount, const kUShort *)
	Read the whole array and return the pointer to it.
const unsigned int *	FieldReadArray (int &pCount, const unsigned int *)
	Read the whole array and return the pointer to it.
const kULongLong *	FieldReadArray (int &pCount, const kULongLong *)
	Read the whole array and return the pointer to it.
void	FieldWriteByte (kByte pValue)
	Write field value as byte.
void	FieldWriteByte (const char *pFieldName, kByte pValue)
	Write field pFieldName field with a byte value.
void	FieldWriteUByte (kUByte pValue)
	Write field value as unsigned byte.
void	FieldWriteUByte (const char *pFieldName, kUByte pValue)
	Write field pFieldName field with an unsigned byte value.
void	FieldWriteShort (kShort pValue)
	Write field value as short.
void	FieldWriteShort (const char *pFieldName, kShort pValue)
	Write field pFieldName field with a short value.
void	FieldWriteUShort (kUShort pValue)
	Write field value as unsigned short.
void	FieldWriteUShort (const char *pFieldName, kUShort pValue)
	Write field pFieldName field with an unsigned short value.
void	FieldWriteUI (unsigned int pValue)
	Write field value as an unsigned integer.
void	FieldWriteUI (const char *pFieldName, unsigned int pValue)
	Write field pFieldName field with an unsigned int as a value.
void	FieldWriteULL (kULongLong pValue)
	Write field value as 64 bit unsigned integer.
void	FieldWriteULL (const char *pFieldName, kULongLong pValue)
	Write field pFieldName field with an 64 bit unsigned int as a value.
void	FieldWriteArraySBytes (int n, const kByte *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayShort (int n, const kShort *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayUShort (int n, const kUShort *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayUI (int n, const unsigned int *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayULL (int n, const kULongLong *pValue, int pSize=1, int pStride=0)
	Write array to file.
Write related functions used to write information of a field or a group of fields.
Can be used to write the field content data or to navigate from field to field.
void	FieldWriteBegin (const char *pFieldName)
	Start to write a field called pFieldName.
void	FieldWriteEnd ()
	Stop to write the current field.
void	FieldWriteBlockBegin ()
	Start to write a field block.
void	FieldWriteObjectBegin (const char pObjectType, const char pName, const char *pSubType=NULL)
	Start to write an object reference field.
void	FieldWriteObjectEnd ()
	Stop to write an object reference field.
void	FieldWriteBlockBegin (const char *pFileName)
	Start to write a field block in file pFileName.
void	FieldWriteBlockEnd ()
	Stop to write a block of field.
void	FieldWriteCH (char pValue)
	Write field value as a char.
void	FieldWriteCH (const char *pFieldName, char pValue)
	Write field pFieldName field with a char as a value.
void	FieldWriteC (const char *pValue)
	Write field value as char pointer pValue.
void	FieldWriteC (const char pFieldName, const char pValue)
	Write field pFieldName with a char pointer as a value.
void	FieldWriteS (const char *pValue)
	Write field value as KString pValue.
void	FieldWriteS (const KString &pValue)
	Write field value as KString pValue.
void	FieldWriteS (const char pFieldName, const char pValue)
	Write field pFieldName field with a KString as a value.
void	FieldWriteS (const char *pFieldName, const KString &pValue)
	Write field pFieldName field with a KString as a value.
void	FieldWriteB (bool pValue)
	Write field value as bool.
void	FieldWriteB (const char *pFieldName, bool pValue)
	Write field pFieldName field with a bool value.
void	FieldWriteI (int pValue)
	Write field value as integer.
void	FieldWriteI (const char *pFieldName, int pValue)
	Write field pFieldName field with an int as a value.
void	FieldWriteLL (kLongLong pValue)
	Write field value as 64 bit integer.
void	FieldWriteLL (const char *pFieldName, kLongLong pValue)
	Write field pFieldName field with an 64 bit int as a value.
void	FieldWriteF (float pValue)
	Write field value as float.
void	FieldWriteF (const char *pFieldName, float pValue)
	Write field pFieldName field with a float as a value.
void	FieldWriteD (double pValue)
	Write field value as double.
void	FieldWriteD (const char *pFieldName, double pValue)
	Write field pFieldName field with a double as a value.
void	FieldWriteT (KTime pTime)
	Write field value as time value.
void	FieldWriteT (const char *pFieldName, KTime pValue)
	Write field pFieldName field with a time as a value.
void	FieldWriteTS (KTimeSpan pTimeSpan)
	Write field value as timespan value.
void	FieldWriteTS (const char *pFieldName, KTimeSpan pValue)
	Write field pFieldName field with a timespan as a value.
void	FieldWriteFn (const float *pValue, kUInt pn)
	Write field value as an array of n floats (nF vector).
void	FieldWriteFn (const char pFieldName, const float pValue, kUInt pn)
	Write field pFieldName field with a array of n floats as a value.
void	FieldWrite3F (const float *pValue)
	Write field value as an array of 3 floats (3F vector).
void	FieldWrite3F (const char pFieldName, const float pValue)
	Write field pFieldName field with a array of 3 floats as a value.
void	FieldWrite4F (const float *pValue)
	Write field value as an array of 4 floats (4F vector).
void	FieldWrite4F (const char pFieldName, const float pValue)
	Write field pFieldName field with a array of 4 floats as a value.
void	FieldWriteDn (const double *pValue, kUInt pn)
	Write field value as an array of n doubles (nD vector).
void	FieldWriteDn (const char pFieldName, const double pValue, kUInt pn)
	Write field pFieldName field with a array of n doubles as a value.
void	FieldWrite3D (const double *pValue)
	Write field value as an array of 3 doubles (3D vector).
void	FieldWrite3D (const char pFieldName, const double pValue)
	Write field pFieldName field with a array of 3 doubles as a value.
void	FieldWrite4D (const double *pValue)
	Write field value as an array of 4 doubles (4D vector).
void	FieldWrite4D (const char pFieldName, const double pValue)
	Write field pFieldName field with a array of 4 doubles as a value.
void	FieldWriteArrayD (int n, const double *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayF (int n, const float *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayI (int n, const int *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayLL (int n, const kLongLong *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayB (int n, const bool *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteArrayBytes (int n, const kUByte *pValue, int pSize=1, int pStride=0)
	Write array to file.
void	FieldWriteR (const void *pRawData, int pByteSize)
	Write field value as a raw data.
void	FieldWriteR (const char pFieldName, const void pRawData, int pByteSize)
	Write field pFieldName field with raw data as a value.
Static Public Member Functions
static KFbx *	KFbxObjectCreate ()
	Creation function for this KFbx class.
Project related functions used to navigate on particular
sections.
static void	ProjectConvertVersionNumber (int pVersion, int &pMajor, int &pMinor, int &pRevision)
	Split a version number into major, minor and revision numbers.
bool	ProjectOpenMainSection ()
	Open the main section of a project.
int	ProjectGetExtensionSectionCount () const
	Get the number of extension sections of a project.
bool	ProjectOpenExtensionSection (int pExtensionSectionIndex)
	Open an extension section of a project.
bool	ProjectCreateExtensionSection (bool pOverwriteLastExtensionSection=false)
	Create an extension section in a project, not allowed in ASCII and encrypted modes.
void	ProjectCloseSection ()
	Close current section.
int	ProjectGetCurrentSection () const
	Get current section.
int	ProjectGetCurrentSectionMode () const
	Get current section mode.
int	ProjectGetCurrentSectionVersion () const
	Get current section version.
int	ProjectGetSectionVersion (int pSection) const
	Get the version number of a section.
bool	IsPasswordProtected () const
	Check the password protection flag.
bool	CheckPassword (const char *pPassword)
	Set password protection flag to `false` if the argument matches the password stored in the section.
bool	WritePassword (const char *pPassword)
	Encrypt and store password in a section.
Error related functions to get some information when an error occur
following a read or write operation.
enum	EError { eFileCorrupted, eFileVersionNotSupportedYet, eFileVersionNotSupportedAnymore, eFileNotOpened, eFileNotCreated, eDirectoryNotCreated, eCrcCheckFailed, eNonExistingSection, eOperationCanceled, eCountError, eInvalidData, eWriteError, eReadError, eErrorCount }
	Error code. More...
KError &	GetError ()
	Retrieve error object.
EError	GetLastErrorID () const
	Get last error code.
const char *	GetLastErrorString () const
	Get last error code.

eFileCorrupted	A file don't have a valid format of data. Search for all occurrences
eFileVersionNotSupportedYet	A file version is over the latest file version supported. Search for all occurrences
eFileVersionNotSupportedAnymore	A file version is obsolete. ex: 4.0 Search for all occurrences
eFileNotOpened	A file fail to open. Search for all occurrences
eFileNotCreated	A file can't be created. Search for all occurrences
eDirectoryNotCreated	A directory can't be created. Search for all occurrences
eCrcCheckFailed	A check of the CRC fail. Search for all occurrences
eNonExistingSection	The section was not found. Search for all occurrences
eOperationCanceled	The current operation is canceled. Search for all occurrences
eCountError	Wrong number of data found. Search for all occurrences
eInvalidData	An invalid data found. Search for all occurrences
eWriteError	A write error. Search for all occurrences
eReadError	A read error. Search for all occurrences
eErrorCount	Number of error enum values. Search for all occurrences

bool ProjectOpen	(	void *	pAddress,
		kULong	pMaxLength,
		KFbxReader *	pReader,
		bool	pCheckCRC = `false`,
		bool	pOpenMainSection = `true`,
		KFbxFileHeaderInfo *	pFileHeaderInfo = `NULL`
	)

pAddress
pMaxLength
pReader
pCheckCRC
pOpenMainSection
pFileHeaderInfo

bool ProjectOpen	(	const char *	pName,
		KFbxReader *	pReader,
		bool	pCheckCRC = `false`,
		bool	pOpenMainSection = `true`,
		KFbxFileHeaderInfo *	pFileHeaderInfo = `NULL`
	)

bool ProjectOpen	(	KFile *	pFile,
		KFbxReader *	pReader,
		bool	pCheckCRC = `false`,
		bool	pOpenMainSection = `true`,
		KFbxFileHeaderInfo *	pFileHeaderInfo = `NULL`
	)

bool ProjectOpenDirect	(	const char *	pName,
		KFbxReader *	pReader,
		bool	pCheckCRC = `false`,
		bool	pOpenMainSection = `true`,
		KFbxFileHeaderInfo *	pFileHeaderInfo = `NULL`
	)

bool ProjectCreate	(	void *	pAddress,
		kUInt	pSize,
		KFbxWriter *	pWriter,
		bool	pBinary,
		bool	pEncrypted,
		KFbxFileHeaderInfo *	pFileHeaderInfo = `NULL`
	)

bool ProjectCreateDirect	(	const char *	pName,
		KFbxWriter *	pWriter,
		bool	pBinary,
		bool	pEncrypted,
		KFbxFileHeaderInfo *	pFileHeaderInfo = `NULL`
	)

bool ProjectCreateEmpty	(	const char *	pName,
		KFbxWriter *	pWriter,
		int	pVersion,
		bool	pBinary,
		bool	pEncrypted
	)

bool ProjectClose	(	void **	pData = `0`,
		kULong *	pSize = `0`
	)

pAddress
pSize
pWriter
pBinary
pEncrypted
pFileHeaderInfo

pName
pWriter
pBinary
pEncrypted
pFileHeaderInfo

pName
pWriter
pBinary
pEncrypted
pFileHeaderInfo

pName
pWriter
pVersion
pBinary
pEncrypted

bool ProjectCreateEmbeddedFolder	(	const KFbxXRefManager &	pXRefManager,
		KString &	pCreatedFolder,
		const char *	pUserDefinedFolder = `NULL`
	)

pXRefManager
pCreatedFolder
pUserDefinedFolder	User defined "working folder"

static void ProjectConvertVersionNumber	(	int	pVersion,
		int &	pMajor,
		int &	pMinor,
		int &	pRevision
	)		`[static]`

pVersion	Version number to split.
pMajor	Integer to receive major version number.
pMinor	Integer to receive minor version number.
pRevision	Integer to receive revision version number.

KString GetMediaDirectory	(	bool	pCreate = `false`,
		const char *	pUserDefinedFolder = `NULL`
	)

pCreate	Whether create the media or not if no such folder is found
pUserDefinedFolder	User define working folder

KString GetContainerTemplateDirectory	(	const char *	pTemplateName,
		bool	pCreate
	)

bool SwapFromTmpProject	(	const char *	pName,
		char *	pError = `NULL`
	)

bool FieldReadBegin	(	const char *	pFieldName,
		int	pInstance
	)

char FieldReadCH	(	const char *	pFieldName,
		char	pDefault = `0`
	)

KFbx Class Reference

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Project related functions used to navigate on particular

Error related functions to get some information when an error occur

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

const char* FieldReadC	(	const char *	pFieldName,
		const char *	pDefault = `""`
	)

const char* FieldReadS	(	const char *	pFieldName,
		const char *	pDefault = `""`
	)

bool FieldReadB	(	const char *	pFieldName,
		bool	pDefault = `false`
	)

int FieldReadI	(	const char *	pFieldName,
		int	pDefault = `0`
	)

kLongLong FieldReadLL	(	const char *	pFieldName,
		kLongLong	pDefault = `0`
	)

float FieldReadF	(	const char *	pFieldName,
		float	pDefault = `0`
	)

double FieldReadD	(	const char *	pFieldName,
		double	pDefault = `0`
	)

void FieldReadFn	(	const char *	pFieldName,
		float *	pValue,
		const float *	pDefault,
		kUInt	pn
	)

void FieldRead3F	(	const char *	pFieldName,
		float *	pValue,
		const float *	pDefault = `NULL`
	)

void FieldRead4F	(	const char *	pFieldName,
		float *	pValue,
		const float *	pDefault = `NULL`
	)