#include <fbxreaderfbx5.h>

Class Description

Definition at line 31 of file fbxreaderfbx5.h.

Inheritance diagram for FbxReaderFbx5:

Public Types
enum	EImportMode { eASCII, eBINARY, eENCRYPTED }

Public Types inherited from FbxReader
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
	FbxReaderFbx5 (FbxManager &pManager, FbxImporter &pImporter, int pID, FbxStatus &pStatus)

virtual	~FbxReaderFbx5 ()

virtual bool	FileOpen (char *pFileName, bool pIgnoredArg)

virtual bool	FileOpen (char *pFileName, EFileOpenSpecialFlags pFlags)
	Opens the file with specific EFileOpenSpecialFlags. More...

virtual bool	FileOpen (char *pFileName)
	Opens the file with default flag. More...

virtual bool	FileOpen (FbxFile *pFile)

virtual bool	FileOpen (FbxStream pStream, void pStreamData)
	Opens the stream with default flag. More...

virtual bool	FileClose ()
	Closes the file stream. More...

virtual bool	IsFileOpen ()
	Checks if the file stream is open. More...

virtual void	SetEmbeddingExtractionFolder (const char *pExtractFolder)

EImportMode	GetImportMode ()

virtual void	GetVersion (int &pMajor, int &pMinor, int &pRevision)
	Returns the file version. More...

virtual bool	GetReadOptions (bool pParseFileAsNeeded=true)
	Returns file stream options. More...

virtual bool	Read (FbxDocument *pDocument)
	Reads file with stream options. More...

virtual bool	GetReadOptions (FbxIO *pFbx, bool pParseFileAsNeeded=true)

virtual bool	Read (FbxScene &pScene, FbxIO *pFbx)

virtual FbxDocumentInfo *	GetSceneInfo ()
	Returns the scene info from the file. More...

virtual FbxArray< FbxTakeInfo * > *	GetTakeInfo ()
	Returns the list of take infos from the file. More...

virtual bool	SupportsStreams () const
	Returns true if this reader supports FbxStream I/O. More...

Public Member Functions inherited from FbxReader
	FbxReader (FbxManager &pManager, int pID, FbxStatus &pStatus)
	Constructor. More...

virtual	~FbxReader ()
	Destructor. More...

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. More...

virtual bool	GetAxisInfo (FbxAxisSystem , FbxSystemUnit )
	Returns the system axis information and file system units from the file. More...

virtual bool	GetStatistics (FbxStatistics *)
	Returns statistics from the file. More...

virtual bool	GetFrameRate (FbxTime::EMode &pTimeMode)
	Get FBX file time mode read from GlobalSettings in FBX 6.n and FBX 7.n. More...

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. More...

bool	IsGenuine ()
	Judges if the format of the file is was created by an Autodesk plug-in. More...

virtual FbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object. More...

virtual void	SetIOSettings (FbxIOSettings *pIOSettings)
	Set the IOSettings pointer to be used for this reader instance. More...

virtual void	SetProgressHandler (FbxProgress *)
	Pass a progress handler to the reader. More...

Member Enumeration Documentation

◆ EImportMode

enum EImportMode

Enumerator
eASCII
eBINARY
eENCRYPTED

Definition at line 47 of file fbxreaderfbx5.h.

     {
         eASCII,
         eBINARY,
         eENCRYPTED
     } EImportMode;

Constructor & Destructor Documentation

◆ FbxReaderFbx5()

FbxReaderFbx5	(	FbxManager &	pManager,
		FbxImporter &	pImporter,
		int	pID,
		FbxStatus &	pStatus
	)

◆ ~FbxReaderFbx5()

virtual ~FbxReaderFbx5 ( )

virtual

Member Function Documentation

◆ FileOpen() [1/5]

virtual bool FileOpen	(	char *	pFileName,
		bool	pIgnoredArg
	)

virtual

◆ FileOpen() [2/5]

virtual bool FileOpen	(	char *	pFileName,
		EFileOpenSpecialFlags
	)

inlinevirtual

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.

Reimplemented from FbxReader.

Definition at line 38 of file fbxreaderfbx5.h.

38 { return FbxReader::FileOpen(pFileName, pFlags); }

FbxReader::FileOpen

virtual bool FileOpen(char *pFileName)=0

Opens the file with default flag.

◆ FileOpen() [3/5]

virtual bool FileOpen ( char * pFileName )

virtual

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.

Implements FbxReader.

◆ FileOpen() [4/5]

virtual bool FileOpen ( FbxFile * pFile )

virtual

◆ FileOpen() [5/5]

virtual bool FileOpen	(	FbxStream *	pStream,
		void *	pStreamData
	)

virtual

Opens the stream with default flag.

Parameters

pStream	stream to open
pStreamData	user-defined stream data

Returns: If the stream opens successfully return true, otherwise return false.

Reimplemented from FbxReader.

◆ FileClose()

virtual bool FileClose ( )

virtual

Closes the file stream.

Returns: false

Implements FbxReader.

◆ IsFileOpen()

virtual bool IsFileOpen ( )

virtual

Checks if the file stream is open.

Returns: false.

Implements FbxReader.

◆ SetEmbeddingExtractionFolder()

virtual void SetEmbeddingExtractionFolder ( const char * pExtractFolder )

virtual

Reimplemented from FbxReader.

◆ GetImportMode()

EImportMode GetImportMode ( )

◆ GetVersion()

virtual void GetVersion	(	int &	pMajor,
		int &	pMinor,
		int &	pRevision
	)

virtual

Returns the file version.

Parameters

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

Reimplemented from FbxReader.

◆ GetReadOptions() [1/2]

virtual bool GetReadOptions ( bool pParseFileAsNeeded = true )

virtual

Returns file stream options.

Parameters

pParseFileAsNeeded Sets whether to parse file as read options

Returns: true on success, otherwise return false.

Implements FbxReader.

◆ Read() [1/2]

virtual bool Read ( FbxDocument * pDocument )

virtual

Reads file with stream options.

Parameters

pDocument FbxDocument to store the file data

Returns: false.

Implements FbxReader.

◆ GetReadOptions() [2/2]

virtual bool GetReadOptions	(	FbxIO *	pFbx,
		bool	pParseFileAsNeeded = `true`
	)

virtual

◆ Read() [2/2]

virtual bool Read	(	FbxScene &	pScene,
		FbxIO *	pFbx
	)

virtual

◆ GetSceneInfo()

virtual FbxDocumentInfo* GetSceneInfo ( )

inlinevirtual

Returns the scene info from the file.

Returns: NULL.

Reimplemented from FbxReader.

Definition at line 63 of file fbxreaderfbx5.h.

63 { return mSceneInfo; }

◆ GetTakeInfo()

virtual FbxArray<FbxTakeInfo*>* GetTakeInfo ( )

inlinevirtual

Returns the list of take infos from the file.

Returns: NULL

Reimplemented from FbxReader.

Definition at line 64 of file fbxreaderfbx5.h.

64 { return &mTakeInfo; }

◆ SupportsStreams()

virtual bool SupportsStreams ( ) const

inlinevirtual

Returns true if this reader supports FbxStream I/O.

Default value is false.

Reimplemented from FbxReader.

Definition at line 66 of file fbxreaderfbx5.h.

66 { return true; }

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

fbxsdk/fileio/fbx/fbxreaderfbx5.h

Class Description

Public Types

Public Member Functions

Member Enumeration Documentation

◆ EImportMode

Constructor & Destructor Documentation

◆ FbxReaderFbx5()

◆ ~FbxReaderFbx5()

Member Function Documentation

◆ FileOpen() [1/5]

◆ FileOpen() [2/5]

◆ FileOpen() [3/5]

◆ FileOpen() [4/5]

◆ FileOpen() [5/5]

◆ FileClose()

◆ IsFileOpen()

◆ SetEmbeddingExtractionFolder()

◆ GetImportMode()

◆ GetVersion()

◆ GetReadOptions() [1/2]

◆ Read() [1/2]

◆ GetReadOptions() [2/2]

◆ Read() [2/2]

◆ GetSceneInfo()

◆ GetTakeInfo()

◆ SupportsStreams()