FBDeviceOptical Class Reference


Detailed Description

Optical device class.

Inheritance diagram for FBDeviceOptical:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 DeviceOpticalBeginSetup ()
 Begin device setup.
 DeviceOpticalEndSetup ()
 End device setup.
 DeviceOpticalEvalAllMarkers (FBDeviceNotifyInfo pDeviceNotifyInfo)
 Evaluate all optical markers for the device.
 DeviceOpticalRecordFrame (FBTime pTime, FBDeviceNotifyInfo pDeviceNotifyInfo)
 Record a frame of information from device.
bool FbxStore (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
 Storage/Retrieval of information into the FBX file format.
bool FbxRetrieve (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
bool FBCreate ()
 Open Reality Creation function.
 FBDestroy ()
 Open Reality destruction function.
bool DeviceOperation (kDeviceOperations pOperation)
 Operate device.
bool AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
 Notification function for animation thread.
 DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo pDeviceNotifyInfo)
 Real-Time engine thread: Device I/O.
 RecordingInitAnimation (FBAnimationNode pAnimationNode)
 When recording, initialize animation.
 RecordingDoneAnimation (FBAnimationNode pAnimationNode)
 When recording, finish animation.

Public Attributes

FBPropertyListDeviceOpticalMarker Markers
 List: Markers.
FBPropertyBase SupportOcclusion
 Property: Does the device support occulsion?.
FBPropertyBase AutoAntialiasing
 Property: Is it auto-antialiasing?.
FBPropertyBase DampingTime
 Property: Damping time for device.
FBPropertyModel ModelOptical
 Property: Optical model for manipulation.
FBPropertyBase ForceOpticalSamplingRate
 Property: Force the use of the optical sampling rate?.
FBPropertyBase OpticalSamplingRate
 Property: Resampling rate for optical device.
FBPropertyBase UseMarkerTimeStamp
 Property: Use the individual marker timestamps?.
FBPropertyBase SkipFrame
 Property: Skip Record Frame.
FBPropertyBase MarkerTimeStamp
 Property: TimeStamp for marker.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameUnique name of optical device.
pObjectInternal parent object.

Reimplemented from FBDevice.

DeviceOpticalBeginSetup ( )

Begin device setup.

DeviceOpticalEndSetup ( )

End device setup.

DeviceOpticalEvalAllMarkers ( FBDeviceNotifyInfo  pDeviceNotifyInfo)

Evaluate all optical markers for the device.

Pure virtual device-specific call to eval marker positions.

Parameters:
pDeviceNotifyInfoNotification information when thread was called.
Remarks:
This function is the device evaluation function, called by the real-time engine.
DeviceOpticalRecordFrame ( FBTime  pTime,
FBDeviceNotifyInfo  pDeviceNotifyInfo 
)

Record a frame of information from device.

Virtual function that derived class may overide

Parameters:
pTimeTime of evaluation.
pDeviceNotifyInfoNotification information when thread was called.
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.

Reimplemented from FBDevice.

bool FbxRetrieve ( FBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)
bool FBCreate ( )

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBDevice.

FBDestroy ( )

Open Reality destruction function.

Reimplemented from FBDevice.

bool DeviceOperation ( kDeviceOperations  pOperation)

Operate device.

This is an operation such as Init, Start, Done, Reset, etc.

Parameters:
pOperationOperation to have device perform.
Returns:
Current state : <b true if online.

Reimplemented from FBDevice.

bool AnimationNodeNotify ( FBAnimationNode  pAnimationNode,
FBEvaluateInfo  pEvaluateInfo 
)

Notification function for animation thread.

This function is called by the real-time engine in order to process animation information.

Parameters:
pAnimationNodeNode containing the modified information.
pEvaluateInfoInformation concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.

Reimplemented from FBDevice.

DeviceIONotify ( kDeviceIOs  pAction,
FBDeviceNotifyInfo  pDeviceNotifyInfo 
)

Real-Time engine thread: Device I/O.

The device I/O thread calls this function (required) which is a highly optimized non-blocking function registering input/output information from/to the device.

Parameters:
pActionDifferent reading/writing actions for the device.
pDeviceNotifyInfoAccess to the system and local time.

Reimplemented from FBDevice.

RecordingInitAnimation ( FBAnimationNode  pAnimationNode)

When recording, initialize animation.

Parameters:
pAnimationNodeAnimation node to read information from.

Reimplemented from FBDevice.

RecordingDoneAnimation ( FBAnimationNode  pAnimationNode)

When recording, finish animation.

Parameters:
pAnimationNodeAnimation node to write information to.

Reimplemented from FBDevice.


Member Data Documentation

FBPropertyListDeviceOpticalMarker Markers
FBPropertyBase SupportOcclusion

Property: Does the device support occulsion?.

FBPropertyBase AutoAntialiasing

Property: Is it auto-antialiasing?.

FBPropertyBase DampingTime

Property: Damping time for device.

FBPropertyModel ModelOptical

Property: Optical model for manipulation.

FBPropertyBase ForceOpticalSamplingRate

Property: Force the use of the optical sampling rate?.

FBPropertyBase OpticalSamplingRate

Property: Resampling rate for optical device.

FBPropertyBase UseMarkerTimeStamp

Property: Use the individual marker timestamps?.

FBPropertyBase SkipFrame

Property: Skip Record Frame.

FBPropertyBase MarkerTimeStamp

Property: TimeStamp for marker.


FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical
FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical