FBX C++ API Reference
FbxIOFileHeaderInfo Class Reference

#include <fbxio.h>

Class Description

FBX header information used at beginning of the FBX file to get or set important values like the file format version number (mFileVersion).

The file version number will be used to select a particular Reader or Writer.

Definition at line 224 of file fbxio.h.

Public Attributes

FbxIODefaultRenderResolution mDefaultRenderResolution
 FbxIODefaultRenderResolution to handle default resolution values. More...
 

Constructors and Destructor

 FbxIOFileHeaderInfo ()
 Default constructor. More...
 
virtual ~FbxIOFileHeaderInfo ()
 Destructor. More...
 

Public Member

virtual void Reset ()
 Reset values to default. More...
 
virtual bool ReadExtendedHeaderInformation (FbxIO *)
 A derived class can override this function to read additional information from the file header. More...
 
int mFileVersion
 Read only properties (not used for file write) More...
 
bool mCreationTimeStampPresent
 Indicates whether a creation time stamp is preset. More...
 
FbxLocalTime mCreationTimeStamp
 Indicates whether the mCreationTimeStamp member variable contains the actual creation time of the file. More...
 
FbxString mCreator
 Indicates who is the creator of the file Ex: "FBX SDK/FBX Plugins version 2011.2". More...
 
bool mIOPlugin
 Indicates whether the file is created by a genuine Autodesk plug-in or not. More...
 
bool mPLE
 The flag indicates that the header was created by a personal learning edition (PLE) of FBX. More...
 

Constructor & Destructor Documentation

◆ FbxIOFileHeaderInfo()

Default constructor.

◆ ~FbxIOFileHeaderInfo()

virtual ~FbxIOFileHeaderInfo ( )
virtual

Destructor.

Member Function Documentation

◆ Reset()

virtual void Reset ( )
virtual

Reset values to default.

◆ ReadExtendedHeaderInformation()

virtual bool ReadExtendedHeaderInformation ( FbxIO )
virtual

A derived class can override this function to read additional information from the file header.

Returns
false in case of failure that should stop loading the file.

Member Data Documentation

◆ mDefaultRenderResolution

FbxIODefaultRenderResolution mDefaultRenderResolution

FbxIODefaultRenderResolution to handle default resolution values.

Definition at line 253 of file fbxio.h.

◆ mFileVersion

int mFileVersion

Read only properties (not used for file write)

File version ex; 5000, 6000, 6100, 7000, 7099, 7100 the major part is the first digit, the minor part, 3 other digits ex: 7100 means version 7.1

Definition at line 262 of file fbxio.h.

◆ mCreationTimeStampPresent

bool mCreationTimeStampPresent

Indicates whether a creation time stamp is preset.

Definition at line 265 of file fbxio.h.

◆ mCreationTimeStamp

FbxLocalTime mCreationTimeStamp

Indicates whether the mCreationTimeStamp member variable contains the actual creation time of the file.

Definition at line 268 of file fbxio.h.

◆ mCreator

FbxString mCreator

Indicates who is the creator of the file Ex: "FBX SDK/FBX Plugins version 2011.2".

Definition at line 273 of file fbxio.h.

◆ mIOPlugin

bool mIOPlugin

Indicates whether the file is created by a genuine Autodesk plug-in or not.

Definition at line 276 of file fbxio.h.

◆ mPLE

bool mPLE

The flag indicates that the header was created by a personal learning edition (PLE) of FBX.

Definition at line 279 of file fbxio.h.


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