Detailed Description
FBX file interface.
When an object is stored/retrieved, it receives a callback (FbxStore/FbxRetrieve). This callback receives an object of type FBFbxObject as a parameter in order to interact with the FBX file.
#include <fbfbx.h>
Public Member Functions |
|
| FBFbxObject (HIObject pObject) | |
| Constructor. |
|
| void | FieldWriteBegin (char *pFieldName) |
| Begin writing a field named
pFieldName. |
|
| void | FieldWriteEnd () |
| End of field writing. |
|
| bool | FieldReadBegin (char *pFieldName) |
| Begin reading from a field named
pFieldName. |
|
| void | FieldReadEnd () |
| End of field reading. |
|
| int | FieldReadGetCount () |
| Get the number of items to read for the
current field. |
|
| void | FieldWriteObjectReference (char *pFieldName, HFBComponent pObject) |
| Write an object reference (handle) to the
field pFieldName. |
|
| void | FieldWriteObjectReference (HFBComponent pObject) |
| Write an object reference (handle) to the
current field. |
|
| HIObject | FieldReadObjectReference (char *pFieldName) |
| Read an object reference from the field
pFieldName. |
|
| HIObject | FieldReadObjectReference () |
| Read an object reference from the current
field. |
|
| void | FieldWriteBlockBegin () |
| Begin writing a block in the FBX file.
|
|
| void | FieldWriteBlockBegin (char *pFieldName) |
| Begin writing a block in the FBX file.
|
|
| void | FieldWriteBlockEnd () |
| Finish writing a block of data. |
|
| bool | FieldReadIsBlock () |
| Is current reading a block of data? |
|
| bool | FieldReadBlockBegin () |
| Begin reading a block of data. |
|
| void | FieldReadBlockEnd () |
| Finish reading data from a block. |
|
| char * | GetFullFilePath (char *pFilename) |
| Get the full file path for
pFilename. |
|
| void | FieldWriteI (int pValue) |
| Write data to the current field. |
|
| void | FieldWriteC (char *pValue) |
| void | FieldWriteD (double pValue) |
| void | FieldWriteI (char *pFieldName, int pValue) |
| Write data to field pFieldName.
|
|
| void | FieldWriteC (char *pFieldName, char *pValue) |
| void | FieldWriteD (char *pFieldName, double pValue) |
| int | FieldReadI () |
| Read data from the current field. |
|
| char * | FieldReadC () |
| double | FieldReadD () |
| int | FieldReadI (char *pFieldName) |
| Read data from field pFieldName.
|
|
| char * | FieldReadC (char *pFieldName) |
| double | FieldReadD (char *pFieldName) |
Constructor & Destructor Documentation
| FBFbxObject | ( | HIObject | pObject | ) |
Constructor.
Client code cannot instantiate objects of this class. Instances of FBFbxObject are passed as parameters for the methods FbxStore and FbxRetrieve of some Open Reality classes.
- Parameters:
-
pObject For internal use only.
Member Function Documentation
| void FieldWriteBegin | ( | char * | pFieldName | ) |
Begin writing a field named pFieldName.
- Parameters:
-
pFieldName Name to give to field in FBX file.
| void FieldWriteEnd | ( | ) |
End of field writing.
| bool FieldReadBegin | ( | char * | pFieldName | ) |
Begin reading from a field named pFieldName.
- Parameters:
-
pFieldName Name of field to read from.
- Returns:
- true if the field was found.
| void FieldReadEnd | ( | ) |
End of field reading.
| int FieldReadGetCount | ( | ) |
Get the number of items to read for the current field.
- Returns:
- The number of field items for the current field.
| void FieldWriteI | ( | int | pValue | ) |
Write data to the current field.
- Parameters:
-
pValue Value (int,char,double) to write to current field.
| void FieldWriteC | ( | char * | pValue | ) |
| void FieldWriteD | ( | double | pValue | ) |
| void FieldWriteI | ( | char * | pFieldName, |
| int | pValue | ||
| ) |
Write data to field pFieldName.
- Parameters:
-
pFieldName Name of the field to write data to. pValue Value (int,char,double) to write to field.
| void FieldWriteC | ( | char * | pFieldName, |
| char * | pValue | ||
| ) |
| void FieldWriteD | ( | char * | pFieldName, |
| double | pValue | ||
| ) |
| int FieldReadI | ( | ) |
Read data from the current field.
- Returns:
- Value (int,char,double) to read from current field.
| char* FieldReadC | ( | ) |
| double FieldReadD | ( | ) |
| int FieldReadI | ( | char * | pFieldName | ) |
Read data from field pFieldName.
- Parameters:
-
pFieldName Name of the field to read data from.
- Returns:
- Value (int,char,double) to read from field.
| char* FieldReadC | ( | char * | pFieldName | ) |
| double FieldReadD | ( | char * | pFieldName | ) |
| void FieldWriteObjectReference | ( | char * | pFieldName, |
| HFBComponent | pObject | ||
| ) |
Write an object reference (handle) to the field pFieldName.
- Parameters:
-
pFieldName Field name to assign to handle. pObject Handle to object to write to FBX.
| void FieldWriteObjectReference | ( | HFBComponent | pObject | ) |
Write an object reference (handle) to the current field.
- Parameters:
-
pObject Handle to object to write to FBX.
| HIObject FieldReadObjectReference | ( | char * | pFieldName | ) |
Read an object reference from the field pFieldName.
\ The returned reference is a HIObject which is an internal application object. Calling 'FBGetFBComponent()' will provide a FBComponent wrapper object with which it is possible to interact.
- Parameters:
-
pFieldName Field name to read from.
- Returns:
- Handle to internal object.
| HIObject FieldReadObjectReference | ( | ) |
Read an object reference from the current field.
The returned reference is a HIObject which is an internal application object. Calling 'FBGetFBComponent()' will provide a FBComponent wrapper object with which it is possible to interact.
- Returns:
- Handle to internal object.
| void FieldWriteBlockBegin | ( | ) |
Begin writing a block in the FBX file.
A block in an FBX file is to re-group different field together, in the same way a a namespace functions in C++. This permits the use of fields with the same name in the FBX file, which is impossible unless they are in different blocks of data.
| void FieldWriteBlockBegin | ( | char * | pFieldName | ) |
Begin writing a block in the FBX file.
A block in an FBX file is to re-group different field together, in the same way a a namespace functions in C++. This permits the use of fields with the same name in the FBX file, which is impossible unless they are in different blocks of data.
- Parameters:
-
pFieldName Name to give to block.
| void FieldWriteBlockEnd | ( | ) |
Finish writing a block of data.
| bool FieldReadIsBlock | ( | ) |
Is current reading a block of data?
- Returns:
- true if current data is a block.
| bool FieldReadBlockBegin | ( | ) |
Begin reading a block of data.
- Returns:
- true if current read is from a block.
| void FieldReadBlockEnd | ( | ) |
Finish reading data from a block.
| char* GetFullFilePath | ( | char * | pFilename | ) |
Get the full file path for pFilename.
- Parameters:
-
pFilename Name of file to get path for.
- Returns:
- Path of file pFilename.
The documentation for this class was generated from the following file:
- fbsdk/fbfbx.h
