Base Device class.
Cannot be instantiated from Python.
Public Member Functions | |
bool | FbxStore (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
Storage/Retrieval of information into the FBX file format. | |
bool | FbxRetrieve (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
__init__ (str pName, object pObject=None) | |
Constructor. | |
bool | FBCreate () |
Open Reality Creation function. | |
FBDestroy () | |
Open Reality destruction function. | |
FBAnimationNode | AnimationNodeInCreate (uintptr_t pUserId, str pName, str pDataType, bool pIsPublic=True, float pMin=None, float pMax=None, bool pUserData=False) |
Creation of IN/OUT Animation Nodes. | |
FBAnimationNode | AnimationNodeOutCreate (uintptr_t pUserId, str pName, str pDataType, bool pIsPublic=True, float pMin=None, float pMax=None, bool pUserData=False) |
bool | DeviceOperation (kDeviceOperations pOperation) |
Operate device. | |
DeviceTransportNotify (kTransportMode pMode, FBTime pTime, FBTime pSystem) | |
Real-Time engine thread: Tranport notifications. | |
DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo pDeviceNotifyInfo) | |
Real-Time engine thread: Device I/O. | |
bool | DeviceEvaluationNotify (kTransportMode pMode, FBEvaluateInfo pEvaluateInfo) |
Real-Time engine thread: Output device evaluation. | |
bool | ModelTemplateBindNotify (FBModel pModel, int pIndex, FBModelTemplate pModelTemplate) |
Model Template binding notification callback. | |
bool | ModelTemplateUnBindNotify (int pIndex, FBModelTemplate pModelTemplate) |
Model Template unbinding notification callback. | |
FBModel | ModelBindingCreate () |
Create a new model binding. | |
ModelBindingRootsList (tuple pList) | |
Get the list of all the possible root models for binding. | |
bool | AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo) |
Notification function for animation thread. | |
str | FbxGetObjectType () |
Object Type "Device". | |
DeviceSendCommand (kDeviceOperations pOperation) | |
Send a command to the device. | |
IObject_Declare (K_IMPLEMENTATION) | |
AckOneSampleReceived () | |
Acknowlege that one sample was received (for statistical purposes). | |
AckOneBadSampleReceived () | |
Acknowlege that one bad sample was received (for statistical purposes). | |
AckOneSampleSent () | |
Acknowlege that one sample was sent (for statistical purposes). | |
RecordingInitAnimation (FBAnimationNode pAnimationNode) | |
When recording, initialize animation. | |
RecordingDoneAnimation (FBAnimationNode pAnimationNode) | |
When recording, finish animation. | |
Public Attributes | |
FBPropertyString | IconFilename |
Read Write Property: Icon filename. | |
FBPropertyString | Status |
Read Write Property: Device information: status. | |
FBPropertyString | Information |
Read Write Property: Device information: information. | |
FBPropertyString | HardwareVersionInfo |
Read Write Property: Device information: hardware version. | |
FBPropertyBase | SamplingPeriod |
Read Write Property: Set this to how many times a device is to be evaluated in one second. | |
FBPropertyBase | Online |
Read Write Property: Is online?. | |
FBPropertyEvent | OnStatusChange |
Event: Status of device changed. | |
FBModelTemplate | ModelTemplate |
Component: Root of model template structure. | |
FBPropertyModel | ModelBindingRoot |
Component: Root of model currently binded model hierarchy. | |
FBPropertyDeviceSamplingMode | SamplingMode |
Read Write Property: Mode to use to record device. | |
FBPropertyBase | CommType |
Read Write Property: Type of communications. | |
FBPropertyListDeviceInstrument | Instruments |
List: List of instruments. | |
FBPropertyBase | RecordingStartTime |
Read Only Property: The time at which the recording started. | |
FBPropertyBase | RecordingStopTime |
Read Only Property: The time at which the recording stopped. |
bool FbxStore | ( | FBFbxObject | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) |
Storage/Retrieval of information into the FBX file format.
pFbxObject | Object to interface with FBX file format. |
pStoreWhat | Attributes to store in FBX file. |
Reimplemented from FBBox.
Reimplemented in FBDeviceOptical.
bool FbxRetrieve | ( | FBFbxObject | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) |
Constructor.
pName | Name of device. |
pObject | For internal use only (default is NULL). |
Reimplemented from FBBox.
Reimplemented in FBDeviceOptical.
bool FBCreate | ( | ) |
Open Reality Creation function.
Reimplemented from FBComponent.
Reimplemented in FBDeviceOptical.
FBDestroy | ( | ) |
Open Reality destruction function.
Reimplemented from FBComponent.
Reimplemented in FBDeviceOptical.
FBAnimationNode AnimationNodeInCreate | ( | uintptr_t | pUserId, |
str | pName, | ||
str | pDataType, | ||
bool | pIsPublic = True , |
||
float | pMin = None , |
||
float | pMax = None , |
||
bool | pUserData = False |
||
) |
Creation of IN/OUT Animation Nodes.
pUserId | User-defined reference number. |
pName | Name of animation node. |
pDataType | Type of data being animated. |
pIsPublic | Determine 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). |
pMin | Minimum values for data (default is NULL). |
pMax | Maximum values for data (default is NULL). |
pUserData | Is 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). |
Reimplemented from FBBox.
FBAnimationNode AnimationNodeOutCreate | ( | uintptr_t | pUserId, |
str | pName, | ||
str | pDataType, | ||
bool | pIsPublic = True , |
||
float | pMin = None , |
||
float | pMax = None , |
||
bool | pUserData = False |
||
) |
Reimplemented from FBBox.
bool DeviceOperation | ( | kDeviceOperations | pOperation | ) |
Operate device.
This is an operation such as Init, Start, Done, Reset, etc.
pOperation | Operation to have device perform. |
Reimplemented in FBDeviceOptical.
Real-Time engine thread: Tranport notifications.
The device I/O thread calls this function when there is a transport change.
pMode | Transport mode. |
pTime | Local time. |
pSystem | System time. |
DeviceIONotify | ( | kDeviceIOs | pAction, |
FBDeviceNotifyInfo | pDeviceNotifyInfo | ||
) |
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.
pAction | Different reading/writing actions for the device. |
pDeviceNotifyInfo | Access to the system and local time. |
Reimplemented in FBDeviceOptical.
bool DeviceEvaluationNotify | ( | kTransportMode | pMode, |
FBEvaluateInfo | pEvaluateInfo | ||
) |
Real-Time engine thread: Output device evaluation.
pMode | Transport mode. |
pEvaluateInfo | Access to the system and local time. |
bool ModelTemplateBindNotify | ( | FBModel | pModel, |
int | pIndex, | ||
FBModelTemplate | pModelTemplate | ||
) |
Model Template binding notification callback.
pModel | Model being bound to model template. |
pIndex | Index of model template where binding is occuring. |
pModelTemplate | Model being affected with binding. |
bool ModelTemplateUnBindNotify | ( | int | pIndex, |
FBModelTemplate | pModelTemplate | ||
) |
Model Template unbinding notification callback.
pIndex | Index in pModelTemplate where unbinding has occured. |
pModelTemplate | Model template from which binding is removed. |
FBModel ModelBindingCreate | ( | ) |
Create a new model binding.
ModelBindingRootsList | ( | tuple | pList | ) |
Get the list of all the possible root models for binding.
pList | List to add found models to. |
bool AnimationNodeNotify | ( | FBAnimationNode | pAnimationNode, |
FBEvaluateInfo | pEvaluateInfo | ||
) |
Notification function for animation thread.
This function is called by the real-time engine in order to process animation information.
pAnimationNode | Node containing the modified information. |
pEvaluateInfo | Information concerning the evaluation of the animation (time, etc.) |
Reimplemented from FBBox.
Reimplemented in FBDeviceOptical.
str FbxGetObjectType | ( | ) |
DeviceSendCommand | ( | kDeviceOperations | pOperation | ) |
Send a command to the device.
This function will send the Init, Start, etc. commands to the device.
pOperation | Operation for device to perform. |
IObject_Declare | ( | K_IMPLEMENTATION | ) |
Reimplemented from FBBox.
AckOneSampleReceived | ( | ) |
Acknowlege that one sample was received (for statistical purposes).
AckOneBadSampleReceived | ( | ) |
Acknowlege that one bad sample was received (for statistical purposes).
AckOneSampleSent | ( | ) |
Acknowlege that one sample was sent (for statistical purposes).
RecordingInitAnimation | ( | FBAnimationNode | pAnimationNode | ) |
When recording, initialize animation.
pAnimationNode | Animation node to read information from. |
Reimplemented in FBDeviceOptical.
RecordingDoneAnimation | ( | FBAnimationNode | pAnimationNode | ) |
When recording, finish animation.
pAnimationNode | Animation node to write information to. |
Reimplemented in FBDeviceOptical.
Read Write Property: Icon filename.
Read Write Property: Device information: status.
Read Write Property: Device information: information.
Read Write Property: Device information: hardware version.
FBPropertyBase 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).
FBPropertyBase Online |
Read Write Property: Is online?.
FBPropertyEvent OnStatusChange |
Event: Status of device changed.
Component: Root of model template structure.
FBPropertyModel ModelBindingRoot |
Component: Root of model currently binded model hierarchy.
FBPropertyDeviceSamplingMode SamplingMode |
Read Write Property: Mode to use to record device.
FBPropertyBase CommType |
Read Write Property: Type of communications.
List: List of instruments.
FBPropertyBase RecordingStartTime |
Read Only Property: The time at which the recording started.
FBPropertyBase RecordingStopTime |
Read Only Property: The time at which the recording stopped.