FBDeviceInstrument Class Reference


Detailed Description

Instrument abstraction layer.

Inheritance diagram for FBDeviceInstrument:
Inheritance graph
[legend]

List of all members.

Public Member Functions

bool  FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
  Storage/Retrieval of information into the FBX file format.
bool  FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
  __init__ (HFBDevice pDevice)
  Constructor.
bool  InstrumentWriteData (HFBEvaluateInfo 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 ( HFBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)

Storage/Retrieval of information into the FBX file format.

Parameters:
pFbxObject Object to interface with FBX file format.
pStoreWhat Attributes to store in FBX file.
Returns:
true if successful.
bool FbxRetrieve ( HFBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)
__init__ ( HFBDevice  pDevice )

Constructor.

Parameters:
pDevice Parent device.
bool InstrumentWriteData ( HFBEvaluateInfo  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:
pEvaluateInfo Evaluation information structure.
Returns:
true if successful.
InstrumentRecordFrame ( FBTime  pRecordTime,
FBDeviceNotifyInfo  pNotifyInfo 
)

Record the data to the function curves for the instrument.

Parameters:
pRecordTime Time to record data at.
pNotifyInfo Device 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