Public Member Functions | Public Attributes

FBDeviceInstrument Class Reference

Search for all occurrences

Detailed Description

Instrument abstraction layer.

Definition at line 574 of file fbcore.h.

#include <fbcore.h>

Inheritance diagram for FBDeviceInstrument:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

Constructor & Destructor Documentation

FBDeviceInstrument ( FBDevice pDevice)

Constructor.

Parameters:
pDeviceParent device.

Member Function Documentation

virtual bool InstrumentWriteData ( FBEvaluateInfo pEvaluateInfo) [virtual]

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.

Reimplemented in FBDeviceCameraInstrument.

virtual void InstrumentRecordFrame ( FBTime  pRecordTime,
FBDeviceNotifyInfo pNotifyInfo 
) [virtual]

Record the data to the function curves for the instrument.

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

Reimplemented in FBDeviceCameraInstrument.

virtual bool FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]

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.

Reimplemented in FBDeviceCameraInstrument.

virtual bool FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]

Member Data Documentation

FBPropertyDevice Device

Read Write Property: Handle to owner device.

Definition at line 604 of file fbcore.h.

Read Write Property: Is instrument active?

Definition at line 605 of file fbcore.h.

FBPropertyModelTemplate ModelTemplate

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

Definition at line 606 of file fbcore.h.


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

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