KFbxReader Class Reference

This reference page is linked to from the following overview topics: Customizing File Formats with FBX SDK I/O Plug-ins, Customizing the FBX SDK, List of Python FBX classes, Customizing File Formats.

---

Search for all occurrences

---

Detailed Description

Base class of other readers used internally.

This class provides the interfaces for reading files.

The role of the reader is to effectively "read" specific file data vs the role of the importer is to select a specific reader and launch the reading of a file through that reader.

See also:

KFbxImporter

ex:

• KFbxReaderFbx can read FBX 5 format files
• KFbxReaderFbx6 can read FBX 6 format files
• KFbxReaderFbx7 can read FBX 7 format files
• KFbxReaderCollada can read Collada files
• KFbxReaderDxf can read Dxf files
• ... etc.

A SDK user should - normally - not use this class, except if a custom reader must be created for plug-in extension, then KFbxReader must be the base class for the new custom reader in that particular situation.

Examples:

MyOwnWriterReader/MyOwnReader.cxx, MyOwnWriterReader/MyOwnReader.h, MyOwnWriterReader/MyOwnWriterReader.cxx, and MyOwnWriterReader/MyOwnWriterReader.h.

Definition at line 64 of file kfbxreader.h.

#include <kfbxreader.h>

List of all members.

Public Types
enum	EError {   eFILE_CORRUPTED, eFILE_VERSION_NOT_SUPPORTED_YET, eFILE_VERSION_NOT_SUPPORTED_ANYMORE, eFILE_NOT_OPENED,   eFILE_NOT_CREATED, eWRONG_PASSWORD, eINVALID_DOCUMENT_HANDLE, eDOCUMENT_NOT_SUPPORTED,   eUNRESOLVED_EXTERNAL_REFERENCES, eUNIDENTIFIED_ERROR, eERROR_COUNT }
	Error identifiers. More...
enum	KInfoRequest { eInfoExtension, eInfoDescriptions, eReserved1 = 0xFBFB }
	Information type to request. More...
enum	EFileOpenSpecialFlags { ParseForGlobalSettings = 1, ParseForStatistics = 2 }
	Flags for reading parts of file. More...
typedef KFbxReader *(*	CreateFuncType )(KFbxSdkManager &pManager, KFbxImporter &pImporter, int pSubID, int pPluginID)
typedef void(*	IOSettingsFillerFuncType )(KFbxIOSettings &pIOS)
typedef void *(*	GetInfoFuncType )(KInfoRequest pRequest, int pReaderTypeId)
Public Member Functions
	KFbxReader (KFbxSdkManager &pManager, int pID)
	Constructor.
virtual	~KFbxReader ()
	Destructor.
virtual void	GetVersion (int &pMajor, int &pMinor, int &pRevision)
	Returns the file version.
virtual bool	FileOpen (char *pFileName)=0
	Opens the file with default flag.
virtual bool	FileOpen (KFile *pFile)
	Opens the file with KFile handle.
virtual bool	FileClose ()=0
	Closes the file stream.
virtual bool	IsFileOpen ()=0
	Checks if the file stream is open.
virtual bool	GetReadOptions (bool pParseFileAsNeeded=true)=0
	Returns file stream options.
virtual bool	Read (KFbxDocument *pDocument)=0
	Reads file with stream options.
virtual void	PluginReadParameters (KFbxObject &pParams)
	Reads extension plug-ins name, version and parameters, so that we can remember if a plug-in was used during export.
virtual bool	FileOpen (char *pFileName, EFileOpenSpecialFlags pFlags)
	Opens the file with specific EFileOpenSpecialFlags.
virtual bool	GetAxisInfo (KFbxAxisSystem *pAxisSystem, KFbxSystemUnit *pSystemUnits)
	Returns the system axis information and file system units from the file.
virtual bool	GetStatistics (KFbxStatistics *pStats)
	Returns statistics from the file.
virtual bool	GetFrameRate (KTime::ETimeMode &pTimeMode)
	Get FBX file time mode read from GlobalSettings in FBX 6.n and FBX 7.n.
virtual KFbxDocumentInfo *	GetSceneInfo ()
	Returns the scene info from the file.
virtual KArrayTemplate < KFbxTakeInfo * > *	GetTakeInfo ()
	Returns the list of take infos from the file.
virtual bool	GetDefaultRenderResolution (KString &pCamName, KString &pResolutionMode, double &pW, double &pH)
	If default camera resolution is OK, returns information about the resolution of the render.
bool	IsGenuine ()
	Judges if the format of the file is was created by an Autodesk plug-in.
KError &	GetError ()
	Retrieves error objects.
EError	GetLastErrorID () const
	Returns the ID of the last error that occurred when the file was read.
const char *	GetLastErrorString () const
	Returns the error string that describes the last error that occurred when the file was read.
void	GetMessage (KString &pMessage) const
	Returns a warning message that describes what occurred when the file was read.
KString &	GetMessage ()
	Returns a warning message that describes what occurred when the file was read.
void	ClearMessage ()
	Clears the warning message string.
virtual KFbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
virtual void	SetIOSettings (KFbxIOSettings *pIOSettings)
	Set the IOSettings pointer to be used for this reader instance.
virtual void	SetProgressHandler (KFbxProgress *pProgress)
	Pass a progress handler to the reader.
virtual void	SetEmbeddingExtractionFolder (const char *pExtractFolder)
Protected Member Functions
void	SetDefaultRenderResolution (const char *pCamName, const char *pResolutionMode, double pW, double pH)
	Set resolution information for default camera.
void	PluginsReadBegin (KFbxScene &pScene)
	A callback function called by FBX before the FBX scene is read.
void	PluginsRead (const char *pName, const char *pVersion)
	A callback function before read any FBX object.
void	PluginsReadEnd (KFbxScene &pScene)
	A callback function called by FBX after read the FBX scene.
KFbxReader &	operator= (KFbxReader const &)
virtual bool	CheckDuplicateNodeNames (KFbxNode *pRootNode, KString &pDuplicateNodeNameList)
	Check if there is any node under pRootNode that have the same name in pDuplicateNodeNameList.
Protected Attributes
KFbxSdkManager &	mManager
	FBX SDK manager.
KDefaultRenderResolution *	mData
	Resolution data for the active camera.
Friends
struct	KFbxReaderFbx7Impl

---

Member Typedef Documentation

typedef KFbxReader*(* CreateFuncType)(KFbxSdkManager &pManager, KFbxImporter &pImporter, int pSubID, int pPluginID)

Search for all occurrences

Helper typedef for passing KFbxReader creator function as argument (used internally)

Definition at line 112 of file kfbxreader.h.

typedef void(* IOSettingsFillerFuncType)(KFbxIOSettings &pIOS)

Search for all occurrences

Helper typedef for passing KFbxIOSettings creator function as argument (used internally)

Definition at line 115 of file kfbxreader.h.

typedef void*(* GetInfoFuncType)(KInfoRequest pRequest, int pReaderTypeId)

Search for all occurrences

Helper typedef for passing KInfoRequest function as argument (used internally)

Definition at line 118 of file kfbxreader.h.

---

Member Enumeration Documentation

enum EError

Search for all occurrences

Error identifiers.

Enumerator:

eFILE_CORRUPTED	Search for all occurrences
eFILE_VERSION_NOT_SUPPORTED_YET	Search for all occurrences
eFILE_VERSION_NOT_SUPPORTED_ANYMORE	Search for all occurrences
eFILE_NOT_OPENED	Search for all occurrences
eFILE_NOT_CREATED	Search for all occurrences
eWRONG_PASSWORD	Search for all occurrences
eINVALID_DOCUMENT_HANDLE	Search for all occurrences
eDOCUMENT_NOT_SUPPORTED	Search for all occurrences
eUNRESOLVED_EXTERNAL_REFERENCES	Search for all occurrences
eUNIDENTIFIED_ERROR	Search for all occurrences
eERROR_COUNT	Search for all occurrences

Definition at line 79 of file kfbxreader.h.

    {
        eFILE_CORRUPTED,
        eFILE_VERSION_NOT_SUPPORTED_YET,
        eFILE_VERSION_NOT_SUPPORTED_ANYMORE,
        eFILE_NOT_OPENED,
        eFILE_NOT_CREATED,
        eWRONG_PASSWORD,
        eINVALID_DOCUMENT_HANDLE,
        eDOCUMENT_NOT_SUPPORTED,
        eUNRESOLVED_EXTERNAL_REFERENCES,
        eUNIDENTIFIED_ERROR,
        eERROR_COUNT
    } EError;

enum KInfoRequest

Search for all occurrences

Information type to request.

Remarks:

Used internally to get reader file information.

Enumerator:

eInfoExtension	To get the file ext for a reader ex: "FBX". Search for all occurrences
eInfoDescriptions	To get the file description for a reader ex: "Autodesk FBX (*.fbx)". Search for all occurrences
eReserved1	Search for all occurrences

Definition at line 97 of file kfbxreader.h.

                      {
        eInfoExtension,     
        eInfoDescriptions,  
        eReserved1 = 0xFBFB,
    };

enum EFileOpenSpecialFlags

Search for all occurrences

Flags for reading parts of file.

Remarks:

Used internally when an importer is initialized to get some information very fast.

Enumerator:

ParseForGlobalSettings	Used for reading the Global settings section when an importer is initialized. Search for all occurrences
ParseForStatistics	Used for reading a group of statistics when an importer is initialized. Search for all occurrences

Definition at line 106 of file kfbxreader.h.

                               {
        ParseForGlobalSettings = 1, 
        ParseForStatistics = 2      
    };

---

Constructor & Destructor Documentation

KFbxReader	(	KFbxSdkManager &	pManager,
		int	pID
	)

Constructor.

Parameters:

pManager	The KFbxSdkManager Object.
pID	Id for current reader.

virtual ~KFbxReader

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void GetVersion	(	int &	pMajor,
		int &	pMinor,
		int &	pRevision
	)		[inline, virtual]

Search for all occurrences

Returns the file version.

Parameters:

pMajor	Major version.
pMinor	Minor version.
pRevision	Revision version.

Examples:

MyOwnWriterReader/MyOwnReader.h.

Definition at line 125 of file kfbxreader.h.

{ pMajor = pMinor = pRevision = 0; }

virtual bool FileOpen

(

char *

pFileName

)

[pure virtual]

Search for all occurrences

Opens the file with default flag.

Parameters:

pFileName

Name of the File to open

Returns:

If the file opens successfully return true, otherwise return false.

Examples:

MyOwnWriterReader/MyOwnReader.h.

virtual bool FileOpen

(

KFile *

pFile

)

[virtual]

Search for all occurrences

Opens the file with KFile handle.

Parameters:

pFile

The KFile handle

Returns:

If the file opens successfully return true, otherwise return false.

virtual bool FileClose

(

)

[pure virtual]

Search for all occurrences

Closes the file stream.

Returns:

false

Examples:

MyOwnWriterReader/MyOwnReader.h.

virtual bool IsFileOpen

(

)

[pure virtual]

Search for all occurrences

Checks if the file stream is open.

Returns:

false.

Examples:

MyOwnWriterReader/MyOwnReader.h.

virtual bool GetReadOptions

(

bool

pParseFileAsNeeded = true

)

[pure virtual]

Search for all occurrences

Returns file stream options.

Parameters:

pParseFileAsNeeded

Sets whether to parse file as read options

Returns:

true on success, otherwise return false.

Examples:

MyOwnWriterReader/MyOwnReader.h.

virtual bool Read

(

KFbxDocument *

pDocument

)

[pure virtual]

Search for all occurrences

Reads file with stream options.

Parameters:

pDocument

KFbxDocument to store the file data

Returns:

false.

Examples:

MyOwnWriterReader/MyOwnReader.h.

virtual void PluginReadParameters

(

KFbxObject &

pParams

)

[virtual]

Search for all occurrences

Reads extension plug-ins name, version and parameters, so that we can remember if a plug-in was used during export.

This is especially useful for extension plug-ins that modify the scene and also to warn users during import if an extension plug-in was used that could be missing.

Parameters:

pParams

The parameters of the extension plug-in. The properties of the objects are used as the parameters of the extension plug-in.

Remarks:

This function has no implementation in this class. Only sub-class should implement it as needed. For example, FBX 6 and FBX 7 does implement it.

virtual bool FileOpen	(	char *	pFileName,
		EFileOpenSpecialFlags	pFlags
	)		[inline, virtual]

Search for all occurrences

Opens the file with specific EFileOpenSpecialFlags.

Parameters:

pFileName	Name of the File to open.
pFlags	The EFileOpenSpecialFlags to open with

Returns:

If the file opens successfully return true, otherwise return false.

Definition at line 178 of file kfbxreader.h.

{ return FileOpen(pFileName); }

virtual bool GetAxisInfo	(	KFbxAxisSystem *	pAxisSystem,
		KFbxSystemUnit *	pSystemUnits
	)		[inline, virtual]

Search for all occurrences

Returns the system axis information and file system units from the file.

Parameters:

pAxisSystem	Axis system in file
pSystemUnits	System unit in file

Returns:

false.

Definition at line 185 of file kfbxreader.h.

{ return false; }

virtual bool GetStatistics

(

KFbxStatistics *

pStats

)

[inline, virtual]

Search for all occurrences

Returns statistics from the file.

Parameters:

pStats

Statistics in the file.

Returns:

false.

Definition at line 191 of file kfbxreader.h.

{ return false; }

virtual bool GetFrameRate

(

KTime::ETimeMode &

pTimeMode

)

[inline, virtual]

Search for all occurrences

Get FBX file time mode read from GlobalSettings in FBX 6.n and FBX 7.n.

Parameters:

pTimeMode

ref to a KTime::ETimeMode enum

Returns:

true on success, false otherwise.

Remarks:

This function must be called after KFbxImporter::Initialize(). Can be used for statistics (via GlobalSettings) before loading the whole scene from the file.

Definition at line 199 of file kfbxreader.h.

{ pTimeMode = KTime::eDEFAULT_MODE; return false; }

virtual KFbxDocumentInfo* GetSceneInfo

(

)

[inline, virtual]

Search for all occurrences

Returns the scene info from the file.

Returns:

NULL.

Definition at line 205 of file kfbxreader.h.

{return NULL;}

virtual KArrayTemplate<KFbxTakeInfo*>* GetTakeInfo

(

)

[inline, virtual]

Search for all occurrences

Returns the list of take infos from the file.

Returns:

NULL

Definition at line 210 of file kfbxreader.h.

{return NULL;}

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

Search for all occurrences

If default camera resolution is OK, returns information about the resolution of the render.

Parameters:

pCamName	Default camera name.
pResolutionMode	Default resolution mode.
pW	Default resolution width.
pH	Default resolution height.

Returns:

true If default camera resolution is OK, false Otherwise.

bool IsGenuine

(

)

Search for all occurrences

Judges if the format of the file is was created by an Autodesk plug-in.

An internal (genuine) plug-in is one created by the Autodesk FBX product team.

Returns:

true If the file format is internal plug-in , false Otherwise.

KError& GetError

(

)

Search for all occurrences

Retrieves error objects.

Returns:

Reference to error objects.

EError GetLastErrorID

(

)

const

Search for all occurrences

Returns the ID of the last error that occurred when the file was read.

Returns:

Last error ID.

const char* GetLastErrorString

(

)

const

Search for all occurrences

Returns the error string that describes the last error that occurred when the file was read.

Returns:

A text description of the last error.

void GetMessage

(

KString &

pMessage

)

const

Search for all occurrences

Returns a warning message that describes what occurred when the file was read.

Parameters:

pMessage

The returned warning message.

KString& GetMessage

(

)

Search for all occurrences

Returns a warning message that describes what occurred when the file was read.

Returns:

The warning message.

void ClearMessage

(

)

Search for all occurrences

Clears the warning message string.

virtual KFbxIOSettings* GetIOSettings

(

)

[virtual]

Search for all occurrences

Access to a IOSettings object.

Returns:

A pointer to IOSettings used for this reader or NULL if the object has not been allocated.

virtual void SetIOSettings

(

KFbxIOSettings *

pIOSettings

)

[virtual]

Search for all occurrences

Set the IOSettings pointer to be used for this reader instance.

Parameters:

pIOSettings

virtual void SetProgressHandler

(

KFbxProgress *

pProgress

)

[inline, virtual]

Search for all occurrences

Pass a progress handler to the reader.

Parameters:

pProgress

KFbxProgress to store the progress information.

Definition at line 269 of file kfbxreader.h.

{}

virtual void SetEmbeddingExtractionFolder

(

const char *

pExtractFolder

)

[inline, virtual]

Search for all occurrences

Definition at line 271 of file kfbxreader.h.

{}

void SetDefaultRenderResolution	(	const char *	pCamName,
		const char *	pResolutionMode,
		double	pW,
		double	pH
	)		[protected]

Search for all occurrences

Set resolution information for default camera.

Parameters:

pCamName	The default camera name.
pResolutionMode	Resolution mode. ex: "Fixed Resolution","Fixed Ratio","Fixed Width","Fixed Height","Window Size".
pW	Resolution width.
pH	Resolution height.

void PluginsReadBegin

(

KFbxScene &

pScene

)

[protected]

Search for all occurrences

A callback function called by FBX before the FBX scene is read.

void PluginsRead	(	const char *	pName,
		const char *	pVersion
	)		[protected]

Search for all occurrences

A callback function before read any FBX object.

Parameters:

pName	Object name.
pVersion	Version of object.

void PluginsReadEnd

(

KFbxScene &

pScene

)

[protected]

Search for all occurrences

A callback function called by FBX after read the FBX scene.

KFbxReader& operator=

(

KFbxReader const &

)

[inline, protected]

Definition at line 294 of file kfbxreader.h.

{ return *this; }

virtual bool CheckDuplicateNodeNames	(	KFbxNode *	pRootNode,
		KString &	pDuplicateNodeNameList
	)		[protected, virtual]

Search for all occurrences

Check if there is any node under pRootNode that have the same name in pDuplicateNodeNameList.

Parameters:

pRootNode	Root node. The node and its children will be checked recursively.
pDuplicatedNodeNameList	Name list.

---

Friends And Related Function Documentation

friend struct KFbxReaderFbx7Impl [friend]

Search for all occurrences

Definition at line 313 of file kfbxreader.h.

---

Member Data Documentation

KFbxSdkManager& mManager [protected]

Search for all occurrences

FBX SDK manager.

Examples:

MyOwnWriterReader/MyOwnReader.h.

Definition at line 303 of file kfbxreader.h.

KDefaultRenderResolution* mData [protected]

Search for all occurrences

Resolution data for the active camera.

Definition at line 305 of file kfbxreader.h.

---

The documentation for this class was generated from the following file:

• fbxfilesdk/kfbxio/kfbxreader.h