FBDevice Class Reference

#include <fbcore.h>

Class Description

Base Device class. Cannot be instantiated from Python.

Definition at line 777 of file fbcore.h.

+ Inheritance diagram for FBDevice:

Public Types

enum  kDeviceOperations {
  kOpInit, kOpStart, kOpAutoDetect, kOpStop,
  kOpReset, kOpDone
}
 Types of operations for device. More...
 
enum  kDeviceIOs { kIOStopModeRead, kIOPlayModeRead, kIOStopModeWrite, kIOPlayModeWrite }
 Types of I/O for device. More...
 
enum  kTransportMode {
  kPreparePlay, kPlayReady, kPlayStop, kStop,
  kPlay, kJog, kPlayReverse
}
 Transport control types for device. More...
 
- Public Types inherited from FBBox
enum  ECandidateAction { eCandidateAccept, eCandidateIntercept, eCandidateInterceptAfterEvaluation }
 Resolving action for candidates. More...
 

Public Member Functions

 FBDevice (const char *pName, HIObject pObject=((void *) 0))
 Constructor. More...
 
virtual bool FBCreate ()
 Open Reality Creation function. More...
 
virtual void FBDestroy ()
 Open Reality destruction function. More...
 
virtual FBAnimationNodeAnimationNodeInCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=true, double *pMin=((void *) 0), double *pMax=((void *) 0), bool pUserData=false)
 Creation of IN/OUT Animation Nodes. More...
 
virtual FBAnimationNodeAnimationNodeOutCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=true, double *pMin=((void *) 0), double *pMax=((void *) 0), bool pUserData=false)
 
virtual bool DeviceOperation (kDeviceOperations pOperation)
 Operate device. More...
 
virtual void DeviceTransportNotify (kTransportMode pMode, FBTime pTime, FBTime pSystem)
 Real-Time engine thread: Tranport notifications. More...
 
virtual void DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo &pDeviceNotifyInfo)
 Real-Time engine thread: Device I/O. More...
 
virtual bool DeviceEvaluationNotify (kTransportMode pMode, FBEvaluateInfo *pEvaluateInfo)
 Real-Time engine thread: Output device evaluation. More...
 
virtual bool ModelTemplateBindNotify (FBModel *pModel, int pIndex, FBModelTemplate *pModelTemplate)
 Model Template binding notification callback. More...
 
virtual bool ModelTemplateUnBindNotify (int pIndex, FBModelTemplate *pModelTemplate)
 Model Template unbinding notification callback. More...
 
FBModelModelBindingCreate ()
 Create a new model binding. More...
 
void ModelBindingRootsList (FBModelList &pList)
 Get the list of all the possible root models for binding. More...
 
virtual bool AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo) override
 Notification function for animation thread. More...
 
virtual const char * FbxGetObjectType () override
 Object Type "Device". More...
 
virtual void DeviceSendCommand (kDeviceOperations pOperation)
 Send a command to the device. More...
 
virtual HIObject IQuery (kInterfaceID pInterfaceID, int IsLocal=0)
 
virtual void Destroy (int IsLocal=0)
 
void AckOneSampleReceived ()
 Acknowlege that one sample was received (for statistical purposes). More...
 
void AckOneBadSampleReceived ()
 Acknowlege that one bad sample was received (for statistical purposes). More...
 
void AckOneSampleSent ()
 Acknowlege that one sample was sent (for statistical purposes). More...
 
virtual void RecordingInitAnimation (FBAnimationNode *pAnimationNode)
 When recording, initialize animation. More...
 
virtual void RecordingDoneAnimation (FBAnimationNode *pAnimationNode)
 When recording, finish animation. More...
 
virtual bool FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
 Storage/Retrieval of information into the FBX file format. More...
 
virtual bool FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
 
- Public Member Functions inherited from FBBox
 FBBox (const char *pName, HIObject pObject=((void *) 0))
 Constructor. More...
 
virtual bool EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
 Evaluation of non TRS nodes that needs to be evaluated. More...
 
virtual bool ResolveCandidate (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo)
 Function is call when candidate needs to be resolved (like global to local). More...
 
virtual ECandidateAction SetGlobalCandidate (FBAnimationNode *pAnimationNode, double *pData, FBEvaluateInfo *pEvaluateInfo)
 Function is call when a global candidate is set on an animation node. More...
 
virtual ECandidateAction SetStdCandidate (FBAnimationNode *pAnimationNode, double *pData, FBEvaluateInfo *pEvaluateInfo)
 Function is call when a non-global candidate is set on an animation node. More...
 
virtual bool AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
 Destroy an animation node. More...
 
virtual bool AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
 Is the animation node user data? More...
 
virtual void AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
 This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo. More...
 
virtual const char * FbxGetObjectSubType ()
 returns UniqueName if not overloaded. More...
 
virtual int GetOutConnectorCount () const
 Get the number of animation node outputs for this box. More...
 
virtual int GetInConnectorCount () const
 Get the number of animation node inputs for this box. More...
 
virtual FBAnimationNodeGetOutConnector (int pIndex) const
 Get the animation node output associated with the given index. More...
 
virtual FBAnimationNodeGetInConnector (int pIndex) const
 Get the animation node input associated with the given index. More...
 
virtual FBAnimationNodeAnimationNodeInGet ()
 Get the (IN/OUT) animation node for this box. More...
 
virtual FBAnimationNodeAnimationNodeOutGet ()
 
- Public Member Functions inherited from FBComponent
 FBComponent (HIObject pObject)
 Constructor. More...
 
virtual ~FBComponent ()
 Destructor. More...
 
virtual void FBDelete () override
 Open Reality deletion function. More...
 
virtual bool SetHIObject (HIObject pObject, bool pSDKComponent) override
 Assign component to an internal pointer. More...
 
virtual int PropertyAdd (FBProperty *pProperty)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
 Add a reference property to the component's property manager. More...
 
void PropertyRemove (FBProperty *pProperty)
 Remove a Property from the component's Property manager. More...
 
void PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
FBPropertyPropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=((void *) 0))
 Create user or dynamic property. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
void SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
void EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
void DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
void SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=((void *) 0), bool pAddRight=true)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=((void *) 0), bool pAddRight=true)
 ProcessObjectNamespace. More...
 
virtual const char * ClassName () override
 Get the class name. More...
 
virtual bool UseCustomPropertyViewSet () const
 Use the custom property viewSet or not. More...
 
const char * GetFullName (void)
 Get the full name. More...
 
void SetOwnerNamespace (FBNamespace *pOwnerNSObj)
 Set the owner Namespace object. More...
 
FBNamespaceGetOwnerNamespace (void)
 Get the owner Namespace object. More...
 
FBFileReferenceGetOwnerFileReference (void)
 Get the owner FileReference object. More...
 
void HardSelect ()
 HardSelect. More...
 
virtual bool Is (int pTypeId)
 Returns true if object is of type TypeId. More...
 
virtual int GetTypeId ()
 GetTypeId( int pTypeId ) More...
 
- Public Member Functions inherited from FBWrapperHolder
 FBWrapperHolder ()
 
virtual ~FBWrapperHolder ()
 
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Public Attributes

FBPropertyString Status
 Read Write Property: Device information: status. More...
 
FBPropertyString Information
 Read Write Property: Device information: information. More...
 
FBPropertyString HardwareVersionInfo
 Read Write Property: Device information: hardware version. More...
 
FBPropertyTime SamplingPeriod
 Read Write Property: Set this to how many times a device is to be evaluated in one second. More...
 
FBPropertyBool Online
 Read Write Property: Is online? More...
 
FBPropertyEvent OnStatusChange
 Event: Status of device changed. More...
 
FBModelTemplate ModelTemplate
 Component: Root of model template structure. More...
 
FBPropertyModel ModelBindingRoot
 Component: Root of model currently binded model hierarchy. More...
 
FBPropertyDeviceSamplingMode SamplingMode
 Read Write Property: Mode to use to record device. More...
 
FBPropertyInt CommType
 Read Write Property: Type of communications. More...
 
FBPropertyListDeviceInstrument Instruments
 List: List of instruments. More...
 
FBPropertyTime RecordingStartTime
 Read Only Property: The time at which the recording started. More...
 
FBPropertyTime RecordingStopTime
 Read Only Property: The time at which the recording stopped. More...
 
- Public Attributes inherited from FBBox
const char * UniqueName
 internal Unique name. More...
 
FBPropertyBool Animatable
 Read Write Property: Is the box animatable. More...
 
FBPropertyBool Live
 Read Write Property: Is live? More...
 
FBPropertyBool RecordMode
 Read Write Property: Is recording? More...
 
- Public Attributes inherited from FBComponent
FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyListComponent Components
 List: List of components. More...
 
FBPropertyListComponent Parents
 List: Parents. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
FBPropertyFolder Folder
 Read Write Property: The folder that contain this component. More...
 

Friends

class __FBDevice
 
class DataFBDeviceOptical
 

Additional Inherited Members

- Static Public Member Functions inherited from FBComponent
static int GetInternalClassId ()
 
static void FBComponentSetName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetName (FBComponent *pObject)
 
static void FBComponentSetLongName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetLongName (FBComponent *pObject)
 
- Static Public Attributes inherited from FBComponent
static int TypeInfo
 Contains the Type information of the object. More...
 
- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=((void *) 0), FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=((void *) 0))
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component. More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Member Enumeration Documentation

enum kDeviceIOs

Types of I/O for device.

These are states of the engine for the DeviceIONotify callback.

Enumerator
kIOStopModeRead 

Read from device (Transport=stopped).

kIOPlayModeRead 

Read from device (Transport=playing).

kIOStopModeWrite 

Write to device (Transport=stopped).

kIOPlayModeWrite 

Write to device (Transport=playing).

Definition at line 795 of file fbcore.h.

795  {
800  };
Read from device (Transport=playing).
Definition: fbcore.h:797
Write to device (Transport=stopped).
Definition: fbcore.h:798
Read from device (Transport=stopped).
Definition: fbcore.h:796
Write to device (Transport=playing).
Definition: fbcore.h:799

Types of operations for device.

These are parameters for the DeviceSendCommand() function.

Enumerator
kOpInit 

Initalize device (creation).

kOpStart 

Start device (online).

kOpAutoDetect 

Autodetect (automatic).

kOpStop 

Stop device (offline).

kOpReset 

Reset device (stop->start).

kOpDone 

Remove device (destruction).

Definition at line 783 of file fbcore.h.

783  {
784  kOpInit,
785  kOpStart,
786  kOpAutoDetect,
787  kOpStop,
788  kOpReset,
789  kOpDone
790  };
Start device (online).
Definition: fbcore.h:785
Stop device (offline).
Definition: fbcore.h:787
Autodetect (automatic).
Definition: fbcore.h:786
Remove device (destruction).
Definition: fbcore.h:789
Initalize device (creation).
Definition: fbcore.h:784
Reset device (stop->start).
Definition: fbcore.h:788

Transport control types for device.

These are states of the engine for the DeviceEvaluationNofity callback.

Enumerator
kPreparePlay 

Preparing to play.

kPlayReady 

Ready to play.

kPlayStop 

Stopping play.

kStop 

Play stopped.

kPlay 

Playing.

kJog 

Jog.

kPlayReverse 

Playing Reverse.

Definition at line 805 of file fbcore.h.

805  {
806  kPreparePlay,
807  kPlayReady,
808  kPlayStop,
809  kStop,
810  kPlay,
811  kJog,
812  kPlayReverse
813  };
Play stopped.
Definition: fbcore.h:809
Preparing to play.
Definition: fbcore.h:806

Constructor & Destructor Documentation

FBDevice ( const char *  pName,
HIObject  pObject = ((void *) 0) 
)

Constructor.

Parameters
pNameName of device.
pObjectFor internal use only (default is NULL).

Member Function Documentation

void AckOneBadSampleReceived ( )

Acknowlege that one bad sample was received (for statistical purposes).

void AckOneSampleReceived ( )

Acknowlege that one sample was received (for statistical purposes).

void AckOneSampleSent ( )

Acknowlege that one sample was sent (for statistical purposes).

virtual FBAnimationNode* AnimationNodeInCreate ( kReference  pUserId,
const char *  pName,
const char *  pDataType,
bool  pIsPublic = true,
double *  pMin = ((void *) 0),
double *  pMax = ((void *) 0),
bool  pUserData = false 
)
virtual

Creation of IN/OUT Animation Nodes.

Parameters
pUserIdUser-defined reference number.
pNameName of animation node.
pDataTypeType of data being animated.
pIsPublicDetermine if the animation node is published, that means whether to show it in property editor and have input / output in relation constraints editor (default is false).
pMinMinimum values for data (default is NULL).
pMaxMaximum values for data (default is NULL).
pUserDataIs this user data? False means the property is NOT animated, user cannot change the data. Especially for device, it doesn't make sense to make it animated, unless you want to record the device data. (default is false).
Returns
A handle to the newly created animation node.

Reimplemented from FBBox.

virtual bool AnimationNodeNotify ( FBAnimationNode pAnimationNode,
FBEvaluateInfo pEvaluateInfo 
)
overridevirtual

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 FBBox.

Reimplemented in FBDeviceOptical, and FBDeviceSync.

virtual FBAnimationNode* AnimationNodeOutCreate ( kReference  pUserId,
const char *  pName,
const char *  pDataType,
bool  pIsPublic = true,
double *  pMin = ((void *) 0),
double *  pMax = ((void *) 0),
bool  pUserData = false 
)
virtual

Reimplemented from FBBox.

virtual void Destroy ( int  IsLocal = 0)
virtual

Reimplemented from FBBox.

virtual bool DeviceEvaluationNotify ( kTransportMode  pMode,
FBEvaluateInfo pEvaluateInfo 
)
virtual

Real-Time engine thread: Output device evaluation.

Parameters
pModeTransport mode.
pEvaluateInfoAccess to the system and local time.
Returns
true if successful.
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 in FBDeviceOptical, and FBDeviceCamera.

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 in FBDeviceOptical.

virtual void DeviceSendCommand ( kDeviceOperations  pOperation)
virtual

Send a command to the device.

This function will send the Init, Start, etc. commands to the device.

Parameters
pOperationOperation for device to perform.
virtual void DeviceTransportNotify ( kTransportMode  pMode,
FBTime  pTime,
FBTime  pSystem 
)
virtual

Real-Time engine thread: Tranport notifications.

The device I/O thread calls this function when there is a transport change.

Parameters
pModeTransport mode.
pTimeLocal time.
pSystemSystem time.
virtual bool FBCreate ( )
virtual

Open Reality Creation function.

Returns
Outcome of creation (true/false).

Reimplemented from FBComponent.

Reimplemented in FBDeviceOptical, FBDeviceCamera, and FBDeviceSync.

virtual void FBDestroy ( )
virtual

Open Reality destruction function.

Reimplemented from FBComponent.

Reimplemented in FBDeviceOptical, FBDeviceCamera, and FBDeviceSync.

virtual const char* FbxGetObjectType ( )
overridevirtual

Object Type "Device".

Reimplemented from FBBox.

virtual bool FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
)
overridevirtual

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical, FBDeviceCamera, and FBDeviceSync.

virtual bool FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
)
overridevirtual

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 FBBox.

Reimplemented in FBDeviceOptical, FBDeviceCamera, and FBDeviceSync.

virtual HIObject IQuery ( kInterfaceID  pInterfaceID,
int  IsLocal = 0 
)
virtual

Reimplemented from FBBox.

FBModel* ModelBindingCreate ( )

Create a new model binding.

Returns
The model root that has been created or NULL is an error occured.
void ModelBindingRootsList ( FBModelList pList)

Get the list of all the possible root models for binding.

Return values
pListList to add found models to.
virtual bool ModelTemplateBindNotify ( FBModel pModel,
int  pIndex,
FBModelTemplate pModelTemplate 
)
virtual

Model Template binding notification callback.

Parameters
pModelModel being bound to model template.
pIndexIndex of model template where binding is occuring.
pModelTemplateModel being affected with binding.
Returns
true if successful.

Reimplemented in FBDeviceCamera.

virtual bool ModelTemplateUnBindNotify ( int  pIndex,
FBModelTemplate pModelTemplate 
)
virtual

Model Template unbinding notification callback.

Parameters
pIndexIndex in pModelTemplate where unbinding has occured.
pModelTemplateModel template from which binding is removed.
Returns
true if successful.
virtual void RecordingDoneAnimation ( FBAnimationNode pAnimationNode)
virtual

When recording, finish animation.

Parameters
pAnimationNodeAnimation node to write information to.

Reimplemented in FBDeviceGlove, FBDeviceOptical, and FBDeviceCamera.

virtual void RecordingInitAnimation ( FBAnimationNode pAnimationNode)
virtual

When recording, initialize animation.

Parameters
pAnimationNodeAnimation node to read information from.

Reimplemented in FBDeviceGlove, FBDeviceOptical, and FBDeviceCamera.

Friends And Related Function Documentation

friend class __FBDevice
friend

Definition at line 950 of file fbcore.h.

friend class DataFBDeviceOptical
friend

Definition at line 951 of file fbcore.h.

Member Data Documentation

FBPropertyInt CommType

Read Write Property: Type of communications.

Definition at line 924 of file fbcore.h.

FBPropertyString HardwareVersionInfo

Read Write Property: Device information: hardware version.

Definition at line 914 of file fbcore.h.

FBPropertyString Information

Read Write Property: Device information: information.

Definition at line 913 of file fbcore.h.

List: List of instruments.

Definition at line 926 of file fbcore.h.

FBPropertyModel ModelBindingRoot

Component: Root of model currently binded model hierarchy.

Definition at line 921 of file fbcore.h.

FBModelTemplate ModelTemplate

Component: Root of model template structure.

Definition at line 920 of file fbcore.h.

Read Write Property: Is online?

Definition at line 916 of file fbcore.h.

FBPropertyEvent OnStatusChange

Event: Status of device changed.

Definition at line 918 of file fbcore.h.

FBPropertyTime RecordingStartTime

Read Only Property: The time at which the recording started.

Definition at line 928 of file fbcore.h.

FBPropertyTime RecordingStopTime

Read Only Property: The time at which the recording stopped.

Definition at line 929 of file fbcore.h.

Read Write Property: Mode to use to record device.

Definition at line 923 of file fbcore.h.

FBPropertyTime SamplingPeriod

Read Write Property: Set this to how many times a device is to be evaluated in one second.

There is no theoretical maximum value but practically you should consider scene complexity, system resources, network speed, etc. If set to 0: the device is evaluated on the sync signal. When the sync occurs; the device is scheduled to be evaluated. If you do not set, the sampling period is based on the internal variable from the [Sync] section of the .Application.txt file (NTSC, PAL, CINEMA).

Definition at line 915 of file fbcore.h.

Read Write Property: Device information: status.

Definition at line 912 of file fbcore.h.


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