Public Member Functions

FBFbxObject Class Reference

Search for all occurrences

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.

Definition at line 80 of file fbfbx.h.

#include <fbfbx.h>

Inheritance diagram for FBFbxObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBFbxObject (HIObject pObject)
 Constructor.
void FieldWriteBegin (const char *pFieldName)
 Begin writing a field named pFieldName.
void FieldWriteEnd ()
 End of field writing.
bool FieldReadBegin (const 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 (const char *pFieldName, FBComponent *pObject)
 Write an object reference (handle) to the field pFieldName.
void FieldWriteObjectReference (FBComponent *pObject)
 Write an object reference (handle) to the current field.
HIObject FieldReadObjectReference (const 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 (const 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.
const char * GetFullFilePath (const char *pFilename)
 Get the full file path for pFilename.
void FieldWriteI (int pValue)
 Write data to the current field.
void FieldWriteC (const char *pValue)
void FieldWriteD (double pValue)
void FieldWriteI (const char *pFieldName, int pValue)
 Write data to field pFieldName.
void FieldWriteC (const char *pFieldName, const char *pValue)
void FieldWriteD (const char *pFieldName, double pValue)
int FieldReadI ()
 Read data from the current field.
const char * FieldReadC ()
double FieldReadD ()
int FieldReadI (const char *pFieldName)
 Read data from field pFieldName.
const char * FieldReadC (const char *pFieldName)
double FieldReadD (const 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:
pObjectFor internal use only.

Member Function Documentation

void FieldWriteBegin ( const char *  pFieldName)

Begin writing a field named pFieldName.

Parameters:
pFieldNameName to give to field in FBX file.
void FieldWriteEnd ( )

End of field writing.

bool FieldReadBegin ( const char *  pFieldName)

Begin reading from a field named pFieldName.

Parameters:
pFieldNameName 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:
pValueValue (int,char,double) to write to current field.
void FieldWriteC ( const char *  pValue)
void FieldWriteD ( double  pValue)
void FieldWriteI ( const char *  pFieldName,
int  pValue 
)

Write data to field pFieldName.

Parameters:
pFieldNameName of the field to write data to.
pValueValue (int,char,double) to write to field.
void FieldWriteC ( const char *  pFieldName,
const char *  pValue 
)
void FieldWriteD ( const char *  pFieldName,
double  pValue 
)
int FieldReadI ( )

Read data from the current field.

Returns:
Value (int,char,double) to read from current field.
const char* FieldReadC ( )
double FieldReadD ( )
int FieldReadI ( const char *  pFieldName)

Read data from field pFieldName.

Parameters:
pFieldNameName of the field to read data from.
Returns:
Value (int,char,double) to read from field.
const char* FieldReadC ( const char *  pFieldName)
double FieldReadD ( const char *  pFieldName)
void FieldWriteObjectReference ( const char *  pFieldName,
FBComponent pObject 
)

Write an object reference (handle) to the field pFieldName.

Parameters:
pFieldNameField name to assign to handle.
pObjectHandle to object to write to FBX.
void FieldWriteObjectReference ( FBComponent pObject)

Write an object reference (handle) to the current field.

Parameters:
pObjectHandle to object to write to FBX.
HIObject FieldReadObjectReference ( const 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:
pFieldNameField 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 ( const 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:
pFieldNameName 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.

const char* GetFullFilePath ( const char *  pFilename)

Get the full file path for pFilename.

Parameters:
pFilenameName of file to get path for.
Returns:
Path of file pFilename.

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

FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject
FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject FBFbxObject