FBX C++ API Reference
FbxReaderFbx5 Class Reference

#include <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)
 
bool FileOpen (char *pFileName, EFileOpenSpecialFlags pFlags) override
 Opens the file with specific EFileOpenSpecialFlags. More...
 
bool FileOpen (char *pFileName) override
 Opens the file with default flag. More...
 
bool FileOpen (FbxFile *pFile) override
 
bool FileOpen (FbxStream *pStream, void *pStreamData) override
 Opens the stream with default flag. More...
 
bool FileClose () override
 Closes the file stream. More...
 
bool IsFileOpen () override
 Checks if the file stream is open. More...
 
void SetEmbeddingExtractionFolder (const char *pExtractFolder) override
 
void SetEmbeddedFileCallback (FbxEmbeddedFileCallback *pCallback) override
 
EImportMode GetImportMode ()
 
void GetVersion (int &pMajor, int &pMinor, int &pRevision) override
 Returns the file version. More...
 
bool GetReadOptions (bool pParseFileAsNeeded=true) override
 Returns file stream options. More...
 
bool Read (FbxDocument *pDocument) override
 Reads file with stream options. More...
 
virtual bool GetReadOptions (FbxIO *pFbx, bool pParseFileAsNeeded=true)
 
virtual bool Read (FbxScene &pScene, FbxIO *pFbx)
 
FbxDocumentInfoGetSceneInfo () override
 Returns the scene info from the file. More...
 
FbxArray< FbxTakeInfo * > * GetTakeInfo () override
 Returns the list of take infos from the file. More...
 
bool SupportsStreams () const override
 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 FbxIOSettingsGetIOSettings ()
 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...
 

Detailed Description

Definition at line 31 of file fbxreaderfbx5.h.

Member Enumeration Documentation

Enumerator
eASCII 
eBINARY 
eENCRYPTED 

Definition at line 48 of file fbxreaderfbx5.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual bool FileOpen ( char *  pFileName,
bool  pIgnoredArg 
)
virtual
bool FileOpen ( char *  pFileName,
EFileOpenSpecialFlags   
)
inlineoverridevirtual

Opens the file with specific EFileOpenSpecialFlags.

Parameters
pFileNameName of the File to open.
pFlagsThe 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); }
virtual bool FileOpen(char *pFileName)=0
Opens the file with default flag.
bool FileOpen ( char *  pFileName)
overridevirtual

Opens the file with default flag.

Parameters
pFileNameName of the File to open
Returns
If the file opens successfully return true, otherwise return false.

Implements FbxReader.

bool FileOpen ( FbxFile pFile)
override
bool FileOpen ( FbxStream pStream,
void *  pStreamData 
)
overridevirtual

Opens the stream with default flag.

Parameters
pStreamstream to open
pStreamDatauser-defined stream data
Returns
If the stream opens successfully return true, otherwise return false.

Reimplemented from FbxReader.

bool FileClose ( )
overridevirtual

Closes the file stream.

Returns
false

Implements FbxReader.

bool IsFileOpen ( )
overridevirtual

Checks if the file stream is open.

Returns
false.

Implements FbxReader.

void SetEmbeddingExtractionFolder ( const char *  pExtractFolder)
overridevirtual

Reimplemented from FbxReader.

void SetEmbeddedFileCallback ( FbxEmbeddedFileCallback pCallback)
overridevirtual

Reimplemented from FbxReader.

EImportMode GetImportMode ( )
void GetVersion ( int &  pMajor,
int &  pMinor,
int &  pRevision 
)
overridevirtual

Returns the file version.

Parameters
pMajorMajor version.
pMinorMinor version.
pRevisionRevision version.

Reimplemented from FbxReader.

bool GetReadOptions ( bool  pParseFileAsNeeded = true)
overridevirtual

Returns file stream options.

Parameters
pParseFileAsNeededSets whether to parse file as read options
Returns
true on success, otherwise return false.

Implements FbxReader.

bool Read ( FbxDocument pDocument)
overridevirtual

Reads file with stream options.

Parameters
pDocumentFbxDocument to store the file data
Returns
false.

Implements FbxReader.

virtual bool GetReadOptions ( FbxIO pFbx,
bool  pParseFileAsNeeded = true 
)
virtual
virtual bool Read ( FbxScene pScene,
FbxIO pFbx 
)
virtual
FbxDocumentInfo* GetSceneInfo ( )
inlineoverridevirtual

Returns the scene info from the file.

Returns
NULL.

Reimplemented from FbxReader.

Definition at line 64 of file fbxreaderfbx5.h.

64 { return mSceneInfo; }
FbxArray<FbxTakeInfo*>* GetTakeInfo ( )
inlineoverridevirtual

Returns the list of take infos from the file.

Returns
NULL

Reimplemented from FbxReader.

Definition at line 65 of file fbxreaderfbx5.h.

65 { return &mTakeInfo; }
bool SupportsStreams ( ) const
inlineoverridevirtual

Returns true if this reader supports FbxStream I/O.

Default value is false.

Reimplemented from FbxReader.

Definition at line 67 of file fbxreaderfbx5.h.

67 { return true; }

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