Public Member Functions | Public Attributes

FBModelMarkerOptical Class Reference

Search for all occurrences

Detailed Description

Optical model marker class.

Definition at line 310 of file fboptical.h.

#include <fboptical.h>

Inheritance diagram for FBModelMarkerOptical:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBModelMarkerOptical (const char *pName=NULL, FBModelOptical *pOptical=NULL, HIObject pObject=NULL)
 Constructor.
virtual int ImportBegin ()
 Begin import of optical data.
virtual bool ImportKey (double pX, double pY, double pZ=0.0, double pOcclusion=0.0)
 Import a key of optical data.
virtual bool ImportEnd ()
 End importation and clean up data.
virtual int ExportBegin ()
 Begin export of optical data.
virtual bool ExportKey (double *pX, double *pY, double *pZ=NULL, double *pOcclusion=NULL)
 Export a key of optical data.
virtual bool ExportEnd ()
 End exportation from optical model.
virtual void SetModelOptical (FBModelOptical *pOptical)
 Set the current optical model.
virtual void InsertSegmentedData (FBAnimationNode *pTData, FBAnimationNode *pOData)
 Insert segmented data.
virtual FBRigidBody GetRigidBody ()
 Get the rigid body for the marker.

Public Attributes

FBPropertyModelOptical Optical
 Property: Optical model.
FBPropertyListMarkerSegment Segments
 Property: Marker segments.
FBPropertyListOpticalGap Gaps
 Property: Gaps.
FBPropertyColor Color
 Property: Marker color.
FBPropertyBool Done
 Property: Done?
FBPropertyAnimationNode Data
 Property: Data.

Constructor & Destructor Documentation

FBModelMarkerOptical ( const char *  pName = NULL,
FBModelOptical pOptical = NULL,
HIObject  pObject = NULL 
)

Constructor.

If no optical model is given, be sure to add one before accessing the Segments and Gaps properties.

Parameters:
pNameName of optical marker(default=NULL).
pOpticalOptical model(default=NULL).
pObjectInternal parent object(default=NULL).

Member Function Documentation

virtual int ImportBegin ( ) [virtual]

Begin import of optical data.

Sample communication with optical device and return the number of samples that were taken during the sampling period for statistical purposes.

Returns:
The number of samples taken.
virtual bool ImportKey ( double  pX,
double  pY,
double  pZ = 0.0,
double  pOcclusion = 0.0 
) [virtual]

Import a key of optical data.

Parameters:
pXX position.
pYY position.
pZZ position(default=0.0).
pOcclusionOcclusion value(default=0.0).
Returns:
true if successful.
virtual bool ImportEnd ( ) [virtual]

End importation and clean up data.

Interpolates optical data to create a curve from the input key frams.

Returns:
true if successful.
virtual int ExportBegin ( ) [virtual]

Begin export of optical data.

Sample communication with optical device and return the number of samples that were taken during the sampling period for statistical purposes.

Returns:
Number of frames to export.
virtual bool ExportKey ( double *  pX,
double *  pY,
double *  pZ = NULL,
double *  pOcclusion = NULL 
) [virtual]

Export a key of optical data.

Return values:
pX.X position.
pY.Y position.
pZ.Z position(default=NULL).
pOcclusion.Occlusion value(default=NULL).
Returns:
true if successful.
virtual bool ExportEnd ( ) [virtual]

End exportation from optical model.

Returns:
true if successful.
virtual void SetModelOptical ( FBModelOptical pOptical) [virtual]

Set the current optical model.

Parameters:
pOpticalNew optical model.
virtual void InsertSegmentedData ( FBAnimationNode pTData,
FBAnimationNode pOData 
) [virtual]

Insert segmented data.

Parameters:
pTDataTranslation data.
pODataOcclusion data.
virtual FBRigidBody GetRigidBody ( ) [virtual]

Get the rigid body for the marker.

Returns:
Rigid body for marker (check IsValid())

Member Data Documentation

FBPropertyModelOptical Optical

Property: Optical model.

Definition at line 381 of file fboptical.h.

Property: Marker segments.

Definition at line 382 of file fboptical.h.

Property: Gaps.

Definition at line 383 of file fboptical.h.

Property: Marker color.

Reimplemented from FBModelMarker.

Definition at line 384 of file fboptical.h.

Property: Done?

Definition at line 385 of file fboptical.h.

FBPropertyAnimationNode Data

Property: Data.

Definition at line 386 of file fboptical.h.


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

FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical
FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical FBModelMarkerOptical