FBModelMarkerOptical Class Reference


Detailed Description

Optical model marker class.

Inheritance diagram for FBModelMarkerOptical:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ (str pName=None, HFBModelOptical pOptical=None, object pObject=None)
  Constructor.
int  ImportBegin ()
  Begin import of optical data.
bool  ImportKey (float pX, float pY, float pZ=0.0, float pOcclusion=0.0)
  Import a key of optical data.
bool  ImportEnd ()
  End importation and clean up data.
int  ExportBegin ()
  Begin export of optical data.
bool  ExportKey (float pX, float pY, float pZ=None, float pOcclusion=None)
  Export a key of optical data.
bool  ExportEnd ()
  End exportation from optical model.
  SetModelOptical (HFBModelOptical pOptical)
  Set the current optical model.
  InsertSegmentedData (HFBAnimationNode pTData, HFBAnimationNode pOData)
  Insert segmented data.
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.
FBPropertyBase  Color
  Property: Marker color.
FBPropertyBase  Done
  Property: Done?.
FBPropertyAnimationNode  Data
  Property: Data.

Member Function Documentation

__init__ ( str  pName = None,
HFBModelOptical  pOptical = None,
object  pObject = None 
)

Constructor.

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

Parameters:
pName Name of optical marker(default=NULL).
pOptical Optical model(default=NULL).
pObject Internal parent object(default=NULL).
int ImportBegin ( )

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.
bool ImportKey ( float  pX,
float  pY,
float  pZ = 0.0,
float  pOcclusion = 0.0 
)

Import a key of optical data.

Parameters:
pX X position.
pY Y position.
pZ Z position(default=0.0).
pOcclusion Occlusion value(default=0.0).
Returns:
true if successful.
bool ImportEnd ( )

End importation and clean up data.

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

Returns:
true if successful.
int ExportBegin ( )

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.
bool ExportKey ( float  pX,
float  pY,
float  pZ = None,
float  pOcclusion = None 
)

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.
bool ExportEnd ( )

End exportation from optical model.

Returns:
true if successful.
SetModelOptical ( HFBModelOptical  pOptical )

Set the current optical model.

Parameters:
pOptical New optical model.
InsertSegmentedData ( HFBAnimationNode  pTData,
HFBAnimationNode  pOData 
)

Insert segmented data.

Parameters:
pTData Translation data.
pOData Occlusion data.
FBRigidBody GetRigidBody ( )

Get the rigid body for the marker.

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

Member Data Documentation

FBPropertyModelOptical Optical

Property: Optical model.

FBPropertyListMarkerSegment Segments

Property: Marker segments.

FBPropertyListOpticalGap Gaps

Property: Gaps.

FBPropertyBase Color

Property: Marker color.

Reimplemented from FBModelMarker.

FBPropertyBase Done

Property: Done?.

FBPropertyAnimationNode Data

Property: Data.


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