FBDeviceOptical Class Reference

#include <fboptical.h>
FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical FBDeviceOptical
Inheritance diagram for FBDeviceOptical:
Inheritance graph
[legend]

List of all members.


Detailed Description

Optical device class.

Definition at line 785 of file fboptical.h.


Public Member Functions

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

Public Attributes

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

Constructor & Destructor Documentation

FBDeviceOptical ( char *  pName,
HIObject  pObject = NULL  
)

Constructor.

Parameters:
pName  Unique name of optical device.
pObject  Internal parent object.

Member Function Documentation

void DeviceOpticalBeginSetup (  ) 

Begin device setup.

void DeviceOpticalEndSetup (  ) 

End device setup.

virtual void DeviceOpticalEvalAllMarkers ( FBDeviceNotifyInfo pDeviceNotifyInfo  )  [pure virtual]

Evaluate all optical markers for the device.

Pure virtual device-specific call to eval marker positions.

Parameters:
pDeviceNotifyInfo  Notification information when thread was called.
Remarks:
This function is the device evaluation function, called by the real-time engine.

virtual void DeviceOpticalRecordFrame ( FBTime pTime,
FBDeviceNotifyInfo pDeviceNotifyInfo  
) [virtual]

Record a frame of information from device.

Virtual function that derived class may overide

Parameters:
pTime  Time of evaluation.
pDeviceNotifyInfo  Notification information when thread was called.

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

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.

Reimplemented from FBDevice.

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

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.

Reimplemented from FBDevice.

virtual bool FBCreate (  )  [virtual]

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBDevice.

virtual void FBDestroy (  )  [virtual]

Open Reality destruction function.

Reimplemented from FBDevice.

virtual bool DeviceOperation ( kDeviceOperations  pOperation  )  [virtual]

Operate device.

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

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

Reimplemented from FBDevice.

virtual bool AnimationNodeNotify ( HFBAnimationNode  pAnimationNode,
HFBEvaluateInfo  pEvaluateInfo  
) [virtual]

Notification function for animation thread.

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

Parameters:
pAnimationNode  Node containing the modified information.
pEvaluateInfo  Information concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.

Reimplemented from FBDevice.

virtual void DeviceIONotify ( kDeviceIOs  pAction,
FBDeviceNotifyInfo pDeviceNotifyInfo  
) [virtual]

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:
pAction  Different reading/writing actions for the device.
pDeviceNotifyInfo  Access to the system and local time.

Reimplemented from FBDevice.

virtual void RecordingInitAnimation ( HFBAnimationNode  pAnimationNode  )  [virtual]

When recording, initialize animation.

Parameters:
pAnimationNode  Animation node to read information from.

Reimplemented from FBDevice.

virtual void RecordingDoneAnimation ( HFBAnimationNode  pAnimationNode  )  [virtual]

When recording, finish animation.

Parameters:
pAnimationNode  Animation node to write information to.

Reimplemented from FBDevice.


Member Data Documentation

FBPropertyListDeviceOpticalMarker Markers

List: Markers.

Definition at line 797 of file fboptical.h.

FBPropertyBool SupportOcclusion

Property: Does the device support occulsion?

Definition at line 798 of file fboptical.h.

FBPropertyBool AutoAntialiasing

Property: Is it auto-antialiasing?

Definition at line 799 of file fboptical.h.

FBPropertyDouble DampingTime

Property: Damping time for device.

Definition at line 800 of file fboptical.h.

FBPropertyModel ModelOptical

Property: Optical model for manipulation.

Definition at line 801 of file fboptical.h.

FBPropertyBool ForceOpticalSamplingRate

Property: Force the use of the optical sampling rate?

Definition at line 803 of file fboptical.h.

FBPropertyDouble OpticalSamplingRate

Property: Resampling rate for optical device.

Definition at line 804 of file fboptical.h.

FBPropertyBool UseMarkerTimeStamp

Property: Use the individual marker timestamps?

Definition at line 805 of file fboptical.h.

FBPropertyBool SkipFrame

Property: Skip Record Frame

Definition at line 807 of file fboptical.h.

FBPropertyTime MarkerTimeStamp

Property: TimeStamp for marker.

Definition at line 808 of file fboptical.h.


Please send us your comments about this page.