Detailed Description

Optical device class.

Inheritance diagram for FBDeviceOptical:

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 (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.
bool	FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
bool	FBCreate ()
	Open Reality Creation function.
	FBDestroy ()
	Open Reality destruction function.
bool	DeviceOperation (kDeviceOperations pOperation)
	Operate device.
bool	AnimationNodeNotify (HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.
	DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo pDeviceNotifyInfo)
	Real-Time engine thread: Device I/O.
	RecordingInitAnimation (HFBAnimationNode pAnimationNode)
	When recording, initialize animation.
	RecordingDoneAnimation (HFBAnimationNode 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`
	)

Search for all occurrences

Constructor.

Parameters:

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

Reimplemented from FBDevice.

DeviceOpticalBeginSetup ( )

Search for all occurrences

Begin device setup.

DeviceOpticalEndSetup ( )

Search for all occurrences

End device setup.

DeviceOpticalEvalAllMarkers ( FBDeviceNotifyInfo pDeviceNotifyInfo )

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.

DeviceOpticalRecordFrame	(	FBTime	pTime,
		FBDeviceNotifyInfo	pDeviceNotifyInfo
	)

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.

bool FbxStore	(	HFBFbxObject	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

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.

bool FbxRetrieve	(	HFBFbxObject	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

Search for all occurrences

Reimplemented from FBDevice.

bool FBCreate ( )

Search for all occurrences

Open Reality Creation function.

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

Reimplemented from FBDevice.

FBDestroy ( )

Search for all occurrences

Open Reality destruction function.

Reimplemented from FBDevice.

bool DeviceOperation ( kDeviceOperations pOperation )

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.

bool AnimationNodeNotify	(	HFBAnimationNode	pAnimationNode,
		HFBEvaluateInfo	pEvaluateInfo
	)

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.

DeviceIONotify	(	kDeviceIOs	pAction,
		FBDeviceNotifyInfo	pDeviceNotifyInfo
	)

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: