FBDeviceInstrument Class Reference


Detailed Description

Instrument abstraction layer.

Inheritance diagram for FBDeviceInstrument:

List of all members.

Public Member Functions

bool FbxStore (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
 Storage/Retrieval of information into the FBX file format.
bool FbxRetrieve (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
 __init__ (FBDevice pDevice)
 Constructor.
bool InstrumentWriteData (FBEvaluateInfo pEvaluateInfo)
 Write data to instrument's connectors.
 InstrumentRecordFrame (FBTime pRecordTime, FBDeviceNotifyInfo pNotifyInfo)
 Record the data to the function curves for the instrument.

Public Attributes

FBPropertyDevice Device
 Read Write Property: Handle to owner device.
FBPropertyBase Active
 Read Write Property: Is instrument active?.
FBPropertyModelTemplate ModelTemplate
 Read Write Property: Model template to build instruments' structure.

Member Function Documentation

bool FbxStore ( FBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)

Storage/Retrieval of information into the FBX file format.

Parameters:
pFbxObjectObject to interface with FBX file format.
pStoreWhatAttributes to store in FBX file.
Returns:
true if successful.
bool FbxRetrieve ( FBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)
__init__ ( FBDevice  pDevice)

Constructor.

Parameters:
pDeviceParent device.
bool InstrumentWriteData ( FBEvaluateInfo  pEvaluateInfo)

Write data to instrument's connectors.

In the evaluation engine callback, this will take the data in the instrument's temporary data holders and write it to the connectors.

Parameters:
pEvaluateInfoEvaluation information structure.
Returns:
true if successful.
InstrumentRecordFrame ( FBTime  pRecordTime,
FBDeviceNotifyInfo  pNotifyInfo 
)

Record the data to the function curves for the instrument.

Parameters:
pRecordTimeTime to record data at.
pNotifyInfoDevice notification information structure.

Member Data Documentation

FBPropertyDevice Device

Read Write Property: Handle to owner device.

FBPropertyBase Active

Read Write Property: Is instrument active?.

FBPropertyModelTemplate ModelTemplate

Read Write Property: Model template to build instruments' structure.


FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument
FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument FBDeviceInstrument