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

Detailed Description

Optical device class.

Definition at line 787 of file fboptical.h.

#include <fboptical.h>

Inheritance diagram for FBDeviceOptical:

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:

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

Member Function Documentation

void DeviceOpticalBeginSetup ( )

Search for all occurrences

Begin device setup.

void DeviceOpticalEndSetup ( )

Search for all occurrences

End device setup.

virtual void DeviceOpticalEvalAllMarkers ( FBDeviceNotifyInfo & pDeviceNotifyInfo ) [virtual]

Search for all occurrences

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]`

Search for all occurrences

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	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)		`[virtual]`

Search for all occurrences

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	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)		`[virtual]`

Search for all occurrences

Reimplemented from FBDevice.

virtual bool FBCreate ( ) [virtual]

Search for all occurrences

Open Reality Creation function.

Returns:: Outcome of creation (true/false).

Reimplemented from FBDevice.

virtual void FBDestroy ( ) [virtual]

Search for all occurrences

Open Reality destruction function.

Reimplemented from FBDevice.

virtual bool DeviceOperation ( kDeviceOperations pOperation ) [virtual]

Search for all occurrences

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	(	FBAnimationNode *	pAnimationNode,
		FBEvaluateInfo *	pEvaluateInfo
	)		`[virtual]`

Search for all occurrences

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]`

Search for all occurrences

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: