|
Python Reference Guide
|
|
|
Python Reference Guide
|
|
Optical device class. More...
#include <pyfbsdk.h>
Public Member Functions | |
| FBDeviceOptical (str pName) | |
| Constructor. More... | |
| DeviceOpticalBeginSetup () | |
| Begin device setup. More... | |
| DeviceOpticalEndSetup () | |
| End device setup. More... | |
| DeviceOpticalRecordFrame (FBTime pTime, FBDeviceNotifyInfo pDeviceNotifyInfo) | |
| Record a frame of information from device. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| RecordingDoneAnimation (FBAnimationNode pAnimationNode) | |
| When recording, finish animation. More... | |
| RecordingInitAnimation (FBAnimationNode pAnimationNode) | |
| When recording, initialize animation. More... | |
 Public Member Functions inherited from FBDevice | |
| FBDevice (str pName) | |
| Constructor. More... | |
| AckOneBadSampleReceived () | |
| Acknowlege that one bad sample was received (for statistical purposes). More... | |
| AckOneSampleReceived () | |
| Acknowlege that one sample was received (for statistical purposes). More... | |
| AckOneSampleSent () | |
| Acknowlege that one sample was sent (for statistical purposes). More... | |
| bool | DeviceOperation (kDeviceOperations pOperation) |
| Operate device. More... | |
| DeviceSendCommand (kDeviceOperations pOperation) | |
| Send a command to the device. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| FBModel | ModelBindingCreate () |
| Create a new model binding. More... | |
| ModelBindingRootsList (FBModelList pList) | |
| Get the list of all the possible root models for binding. More... | |
| RecordingDoneAnimation (FBAnimationNode pAnimationNode) | |
| When recording, finish animation. More... | |
| RecordingInitAnimation (FBAnimationNode pAnimationNode) | |
| When recording, initialize animation. More... | |
| Public Member Functions inherited from FBBox | |
| FBBox (str pName) | |
| Constructor. More... | |
| bool | AnimationNodeDestroy (FBAnimationNode pAnimationNode) |
| Destroy an animation node. More... | |
| FBAnimationNode | AnimationNodeInGet () |
| Get the (IN/OUT) animation node for this box. More... | |
| bool | AnimationNodeIsUserData (FBAnimationNode pAnimationNode) |
| Is the animation node user data? More... | |
| FBAnimationNode | AnimationNodeOutGet () |
| str | FbxGetObjectSubType () |
| Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'. More... | |
| str | FbxGetObjectType () |
| Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'. More... | |
| FBAnimationNode | GetInConnector (int pIndex) |
| Get the animation node input associated with the given index. More... | |
| int | GetInConnectorCount () |
| Get the number of animation node inputs for this box. More... | |
| FBAnimationNode | GetOutConnector (int pIndex) |
| Get the animation node output associated with the given index. More... | |
| int | GetOutConnectorCount () |
| Get the number of animation node outputs for this box. More... | |
| Public Member Functions inherited from FBComponent | |
| FBComponent () | |
| Constructor. More... | |
| str | ClassName () |
| Get the class name. More... | |
| DisableObjectFlags (FBObjectFlag pFlags) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBObjectFlag pFlags) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags () |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBObjectStatus pStatus) |
| Check to see if an object status is enabled. More... | |
| FBFileReference | GetOwnerFileReference (p0) |
| Get the owner FileReference object. More... | |
| HardSelect () | |
| HardSelect. More... | |
| bool | HasObjectFlags (FBObjectFlag pFlags) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (int pTypeId) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessObjectNamespace. More... | |
| 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... | |
| FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
| Create user or dynamic property. More... | |
| PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
| Get list of properties which have been modified since last loading. More... | |
| PropertyRemove (FBProperty pProperty) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBObjectFlag pFlags) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
| Enable/Disable a specific Object Status. More... | |
Public Attributes | |
| bool | AutoAntialiasing |
| Property: Is it auto-antialiasing? More... | |
| float | DampingTime |
| Property: Damping time for device. More... | |
| bool | ForceOpticalSamplingRate |
| Property: Force the use of the optical sampling rate? More... | |
| FBTime | MarkerTimeStamp |
| Property: TimeStamp for marker. More... | |
| FBListDeviceOpticalMarker | Markers |
| List: Markers. More... | |
| FBModel | ModelOptical |
| Property: Optical model for manipulation. More... | |
| float | OpticalSamplingRate |
| Property: Resampling rate for optical device. More... | |
| bool | SkipFrame |
| Property: Skip Record Frame More... | |
| bool | SupportOcclusion |
| Property: Does the device support occulsion? More... | |
| bool | UseMarkerTimeStamp |
| Property: Use the individual marker timestamps? More... | |
| Public Attributes inherited from FBDevice | |
| int | CommType |
| Read Write Property: Type of communications. More... | |
| str | HardwareVersionInfo |
| Read Write Property: Device information: hardware version. More... | |
| str | Information |
| Read Write Property: Device information: information. More... | |
| FBModel | ModelBindingRoot |
| Component: Root of model currently binded model hierarchy. More... | |
| FBModelTemplate | ModelTemplate |
| Component: Root of model template structure. More... | |
| bool | Online |
| Read Write Property: Is online? More... | |
| FBTime | RecordingStartTime |
| Read Only Property: The time at which the recording started. More... | |
| FBTime | RecordingStopTime |
| Read Only Property: The time at which the recording stopped. More... | |
| FBDeviceSamplingMode | SamplingMode |
| Read Write Property: Mode to use to record device. More... | |
| FBTime | 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). More... | |
| str | Status |
| Read Write Property: Device information: status. More... | |
| Public Attributes inherited from FBBox | |
| bool | Animatable |
| Read Write Property: Is the box animatable. More... | |
| bool | Live |
| Read Write Property: Is live? More... | |
| bool | RecordMode |
| Read Write Property: Is recording? More... | |
| str | UniqueName |
| internal Unique name. More... | |
| Public Attributes inherited from FBComponent | |
| FBListComponent | Components |
| List: List of components. More... | |
| str | LongName |
| Read Write Property: Name and namespace for object. More... | |
| str | Name |
| Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More... | |
| FBListComponent | Parents |
| List: Parents. More... | |
| FBManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| bool | Selected |
| Read Write Property: Selected property. More... | |
| int | TypeInfo |
| Contains the Type information of the object. More... | |
| Public Attributes inherited from FBPlug | |
| str | ClassGroupName |
| ClassGroupName of the object. More... | |
| int | TypeInfo |
| TypeInfo. More... | |
Optical device class.
| FBDeviceOptical | ( | str | pName | ) |
Constructor.
| pName | Unique name of optical device. |
| DeviceOpticalBeginSetup | ( | ) |
Begin device setup.
| DeviceOpticalEndSetup | ( | ) |
End device setup.
| DeviceOpticalRecordFrame | ( | FBTime | pTime, |
| FBDeviceNotifyInfo | pDeviceNotifyInfo | ||
| ) |
Record a frame of information from device.
Virtual function that derived class may overide
| pTime | Time of evaluation. |
| pDeviceNotifyInfo | Notification information when thread was called. |
| bool FBCreate | ( | ) |
Open Reality Creation function.
| FBDestroy | ( | ) |
Open Reality destruction function.
| RecordingDoneAnimation | ( | FBAnimationNode | pAnimationNode | ) |
When recording, finish animation.
| pAnimationNode | Animation node to write information to. |
| RecordingInitAnimation | ( | FBAnimationNode | pAnimationNode | ) |
When recording, initialize animation.
| pAnimationNode | Animation node to read information from. |
| bool AutoAntialiasing |
Property: Is it auto-antialiasing?
| float DampingTime |
Property: Damping time for device.
| bool ForceOpticalSamplingRate |
Property: Force the use of the optical sampling rate?
| FBListDeviceOpticalMarker Markers |
List: Markers.
| FBTime MarkerTimeStamp |
Property: TimeStamp for marker.
| FBModel ModelOptical |
Property: Optical model for manipulation.
| float OpticalSamplingRate |
Property: Resampling rate for optical device.
| bool SkipFrame |
Property: Skip Record Frame
| bool SupportOcclusion |
Property: Does the device support occulsion?
| bool UseMarkerTimeStamp |
Property: Use the individual marker timestamps?
1.9.4