FBFbxObject Class Reference

FBX file interface. More...

#include <fbfbx.h>

Inheritance diagram for FBFbxObject:

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	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, int pDefault=0)
	Read data from field pFieldName.
const char *	FieldReadC (const char *pFieldName, const char *pDefault="")
double	FieldReadD (const char *pFieldName, double pDefault=0)
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.
Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.
virtual	~FBComponent ()
	Destructor.
virtual bool	FBCreate ()
	Open Reality Creation function.
virtual void	FBDestroy ()
	Open Reality destruction function.
virtual void	FBDelete () override
	Open Reality deletion function.
virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.
virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.
void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.
void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
FBProperty *	PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.
virtual const char *	ClassName () override
	Get the class name.
virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.
const char *	GetFullName (void)
	Get the full name.
void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.
FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.
FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.
void	HardSelect ()
	HardSelect.
virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.
virtual int	GetTypeId () override
	GetTypeId( int pTypeId )
Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.
void	AddWrapper (FBScriptWrapper *)
void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()
static void	FBComponentSetName (FBComponent *pObject, const char *pName)
static const char *	FBComponentGetName (FBComponent *pObject)
static void	FBComponentSetLongName (FBComponent *pObject, const char *pName)
static const char *	FBComponentGetLongName (FBComponent *pObject)
Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
FBPropertyListComponent	Components
	List: List of components.
FBPropertyListComponent	Parents
	List: Parents.
FBPropertyBool	Selected
	Read Write Property: Selected property.
FBPropertyString	Name
	Read Write Property: Unique name of object.
FBPropertyString	LongName
	Read Write Property: Name and namespace for object.
FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.
Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.
Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.
bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.
bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.
bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.
bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.
bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.
bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.
void	DisconnectAllSrc ()
	Remove all source connections.
void	DisconnectAllDst ()
	Remove all destination connections.
bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.
bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.
bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.
bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.
bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.
bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.
bool	MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
	Move source connection pSrc to the position of pAtSrc.
int	GetSrcCount ()
	Get source connection count.
FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.
FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.
int	GetDstCount ()
	Get destination connection count.
FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.
FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.
bool	BeginChange ()
	Begins a change on multiple plugs.
void	EndChange ()
	Ends a change on multiple plugs.
void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.
bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.
void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.
bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.
int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.
bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.
void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.
bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.
FBPlug *	GetOwner ()
	Get the owner of this plug.
FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.
int	GetOwnedCount ()
	Get the owned plug count.
virtual const char *	ClassName ()
	internal System vars.
virtual bool	Is (int pTypeId)
	Is( int pTypeId )
virtual int	GetTypeId ()
	GetTypeId( int pTypeId )
virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
virtual void	FBDelete ()
	Actual destructor for a FBPlug.
Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.
Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.
HIObject	mObject
	Handle on the Plug.
bool	mSDKComponent
	bool Plug is an SDK component.
Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.
static int	TypeInfo
	TypeInfo.
static int	mGlobalTypeInfo
	Represente the Type Index.

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.

Constructor & Destructor Documentation

FBFbxObject()

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

FieldReadBegin()

bool FieldReadBegin

(

const char *

pFieldName

)

Begin reading from a field named pFieldName.

Parameters

pFieldName

Name of field to read from.

Returns

true if the field was found.

FieldReadBlockBegin()

bool FieldReadBlockBegin

(

)

Begin reading a block of data.

Returns

true if current read is from a block.

FieldReadBlockEnd()

void FieldReadBlockEnd

(

)

Finish reading data from a block.

FieldReadEnd()

void FieldReadEnd

(

)

End of field reading.

FieldReadGetCount()

int FieldReadGetCount

(

)

Get the number of items to read for the current field.

Returns

The number of field items for the current field.

FieldReadI() [1/2]

int FieldReadI

(

)

Read data from the current field.

Returns

Value (int,char,double) to read from current field.

FieldReadI() [2/2]

int FieldReadI	(	const char *	pFieldName,
		int	pDefault = 0
	)

Read data from field pFieldName.

Parameters

pFieldName

Name of the field to read data from.

Returns

Value (int,char,double) to read from field.

FieldReadIsBlock()

bool FieldReadIsBlock

(

)

Is current reading a block of data?

Returns

true if current data is a block.

FieldReadObjectReference() [1/2]

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.

FieldReadObjectReference() [2/2]

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

pFieldName

Field name to read from.

Returns

Handle to internal object.

FieldWriteBegin()

void FieldWriteBegin

(

const char *

pFieldName

)

Begin writing a field named pFieldName.

Parameters

pFieldName

Name to give to field in FBX file.

FieldWriteBlockBegin() [1/2]

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.

FieldWriteBlockBegin() [2/2]

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

pFieldName

Name to give to block.

FieldWriteBlockEnd()

void FieldWriteBlockEnd

(

)

Finish writing a block of data.

FieldWriteEnd()

void FieldWriteEnd

(

)

End of field writing.

FieldWriteI() [1/2]

void FieldWriteI	(	const 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.

FieldWriteI() [2/2]

void FieldWriteI

(

int

pValue

)

Write data to the current field.

Parameters

pValue

Value (int,char,double) to write to current field.

FieldWriteObjectReference() [1/2]

void FieldWriteObjectReference	(	const char *	pFieldName,
		FBComponent *	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.

FieldWriteObjectReference() [2/2]

void FieldWriteObjectReference

(

FBComponent *

pObject

)

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

Parameters

pObject

Handle to object to write to FBX.

GetFullFilePath()

const char * GetFullFilePath

(

const 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:

• fbfbx.h