Class 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:: FbxImporter

ex:

FbxReaderFbx5 can read FBX 5 format files
FbxReaderFbx6 can read FBX 6 format files
FbxReaderFbx7 can read FBX 7 format files
FbxReaderCollada can read Collada files
FbxReaderDxf 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 FbxReader 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 fbxreader.h.

Inheritance diagram for FbxReader:

List of all members.

Public Types
enum	EInfoRequest { eInfoExtension, eInfoDescriptions, eReserved1 = 0xFBFB }
	Information type to request. More...
enum	EFileOpenSpecialFlags { eParseForGlobalSettings = 1, eParseForStatistics = 2 }
	Flags for reading parts of file. More...
typedef FbxReader (	CreateFuncType )(FbxManager &pManager, FbxImporter &pImporter, int pSubID, int pPluginID)
typedef void(*	IOSettingsFillerFuncType )(FbxIOSettings &pIOS)
typedef void (	GetInfoFuncType )(EInfoRequest pRequest, int pReaderTypeId)
Public Member Functions
	FbxReader (FbxManager &pManager, int pID, FbxStatus &pStatus)
	Constructor.
virtual	~FbxReader ()
	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 (FbxStream pStream, void pStreamData)
	Opens the stream with default flag.
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 (FbxDocument *pDocument)=0
	Reads file with stream options.
virtual void	PluginReadParameters (FbxObject &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)
	Opens the file with specific EFileOpenSpecialFlags.
virtual bool	GetAxisInfo (FbxAxisSystem , FbxSystemUnit )
	Returns the system axis information and file system units from the file.
virtual bool	GetStatistics (FbxStatistics *)
	Returns statistics from the file.
virtual bool	GetFrameRate (FbxTime::EMode &pTimeMode)
	Get FBX file time mode read from GlobalSettings in FBX 6.n and FBX 7.n.
virtual FbxDocumentInfo *	GetSceneInfo ()
	Returns the scene info from the file.
virtual FbxArray< FbxTakeInfo * > *	GetTakeInfo ()
	Returns the list of take infos from the file.
virtual bool	GetDefaultRenderResolution (FbxString &pCamName, FbxString &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.
virtual FbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
virtual void	SetIOSettings (FbxIOSettings *pIOSettings)
	Set the IOSettings pointer to be used for this reader instance.
virtual void	SetProgressHandler (FbxProgress *)
	Pass a progress handler to the reader.
virtual void	SetEmbeddingExtractionFolder (const char *)
virtual bool	SupportsStreams () const
	Returns true if this reader supports FbxStream I/O.

Member Typedef Documentation

typedef FbxReader*(* CreateFuncType)(FbxManager &pManager, FbxImporter &pImporter, int pSubID, int pPluginID)

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

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

FbxReader	(	FbxManager &	pManager,
		int	pID,
		FbxStatus &	pStatus
	)

pManager	The FbxManager Object.
pID	Id for current reader.
pStatus	The FbxStatus object to hold error codes.

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

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

virtual bool FileOpen	(	FbxStream *	pStream,
		void *	pStreamData
	)		`[virtual]`

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

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

virtual bool GetAxisInfo	(	FbxAxisSystem *	,
		FbxSystemUnit *
	)		`[inline, virtual]`

pAxisSystem	Axis system in file
pSystemUnits	System unit in file

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

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

Class Description

Public Types

Public Member Functions

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation