Public Member Functions | Public Attributes | Friends

FBDeviceOptical Class Reference

This reference page is linked to from the following overview topics: Motion Capture Devices, Optical devices.


Search for all occurrences

Detailed Description

Optical device class.

Definition at line 807 of file fboptical.h.

#include <fboptical.h>

Inheritance diagram for FBDeviceOptical:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Friends

class FBDeviceOpticalLayout

Constructor & Destructor Documentation

FBDeviceOptical ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

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

Member Function Documentation

void DeviceOpticalBeginSetup ( )

Begin device setup.

void DeviceOpticalEndSetup ( )

End device setup.

virtual void DeviceOpticalEvalAllMarkers ( FBDeviceNotifyInfo pDeviceNotifyInfo) [virtual]

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.
virtual void DeviceOpticalRecordFrame ( FBTime pTime,
FBDeviceNotifyInfo pDeviceNotifyInfo 
) [virtual]

Record a frame of information from device.

Virtual function that derived class may overide

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

virtual bool FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]
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:
pOperationOperation to have device perform.
Returns:
Current state : <b true if online.

Reimplemented from FBDevice.

virtual bool AnimationNodeNotify ( FBAnimationNode pAnimationNode,
FBEvaluateInfo pEvaluateInfo 
) [virtual]

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.

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:
pActionDifferent reading/writing actions for the device.
pDeviceNotifyInfoAccess to the system and local time.

Reimplemented from FBDevice.

virtual void RecordingInitAnimation ( FBAnimationNode pAnimationNode) [virtual]

When recording, initialize animation.

Parameters:
pAnimationNodeAnimation node to read information from.

Reimplemented from FBDevice.

virtual void RecordingDoneAnimation ( FBAnimationNode pAnimationNode) [virtual]

When recording, finish animation.

Parameters:
pAnimationNodeAnimation node to write information to.

Reimplemented from FBDevice.


Friends And Related Function Documentation

friend class FBDeviceOpticalLayout [friend]

Definition at line 811 of file fboptical.h.


Member Data Documentation

List: Markers.

Definition at line 819 of file fboptical.h.

Property: Does the device support occulsion?

Definition at line 820 of file fboptical.h.

Property: Is it auto-antialiasing?

Definition at line 821 of file fboptical.h.

Property: Damping time for device.

Definition at line 822 of file fboptical.h.

FBPropertyModel ModelOptical

Property: Optical model for manipulation.

Definition at line 823 of file fboptical.h.

Property: Force the use of the optical sampling rate?

Definition at line 825 of file fboptical.h.

Property: Resampling rate for optical device.

Definition at line 826 of file fboptical.h.

Property: Use the individual marker timestamps?

Definition at line 827 of file fboptical.h.

Property: Skip Record Frame

Definition at line 829 of file fboptical.h.

Property: TimeStamp for marker.

Definition at line 830 of file fboptical.h.


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

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