This reference page is linked to from the following overview topics: Motion Capture Devices.
#include <fbtracker.h>
Camera device base class.
Based on the FBDeviceSync class, this class generalizes the concept of a virtual set camera driver, permitting synchronization with a genlock source, generic camera connectors, and model templates.
Definition at line 286 of file fbtracker.h.
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 Member Functions |
|
FBDeviceCamera (const char *pName, HIObject pObject=NULL) | |
Constructor. |
|
virtual bool | FBCreate () |
Open Reality Creation function. |
|
virtual void | FBDestroy () |
Open Reality destruction function. |
|
virtual bool | DeviceSyncAnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo, int pCorrectedSync) |
Real-Time synchronous evaluation callback.
|
|
virtual void | DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo &pDeviceNotifyInfo) |
Real-Time engine thread: Device I/O.
|
|
virtual bool | ModelTemplateBindNotify (FBModel *pModel, int pIndex, FBModelTemplate *pModelTemplate) |
Model Template binding notification
callback. |
|
virtual bool | FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
Storage/Retrieval of information into the
FBX file format. |
|
virtual bool | FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
virtual void | RecordingInitAnimation (FBAnimationNode *pAnimationNode) |
When recording, initialize animation.
|
|
virtual void | RecordingDoneAnimation (FBAnimationNode *pAnimationNode) |
When recording, finish animation. |
|
virtual bool | DeviceCameraAnimationNodeNotify (FBEvaluateInfo *pEvaluateInfo, FBDeviceCameraPacket *pDstPacket, FBDeviceSyncPacket *pSrcPacket) |
Evaluation engine callback for camera
device. |
|
virtual void | DeviceCameraEvalData (FBDeviceNotifyInfo &pNotifyInfo) |
I/O for camera device. |
|
virtual void | DeviceCameraRecordFrame (FBTime &pRecordTime, FBDeviceNotifyInfo &pNotifyInfo) |
Record a frame of data to the FCurves for
the camera device. |
|
virtual bool | DeviceCameraWriteData (FBEvaluateInfo *pEvaluateInfo) |
Write data to camera connectors. |
|
virtual bool | LoadLensTables (const char *pFilename) |
Load the lens lookup tables. |
|
virtual void | ProcessLensData (FBDeviceCameraPacket *pDataPacket) |
Process the lens table data for this data
packet. |
|
virtual void | PrintDebugAnimInfo (int pSync, FBDeviceSyncPacket *pSyncPacket, FBEvaluateInfo *pEvaluateInfo) |
Print to screen animation info. |
|
virtual void | PrintDebugIOInfo (FBDeviceSyncPacket *pSyncPacket, FBDeviceNotifyInfo &pDeviceNotifyInfo) |
Print to screen input/output info. |
|
virtual void | PrintDebugIONotifyInfo (FBDeviceNotifyInfo &pInfo, int pPacketCount) |
Print to screen input/output notification
info. |
|
virtual bool | AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo) |
Notification function for animation thread.
|
|
virtual void | PacketRegister (FBDeviceSyncPacket *pPacket) |
Register a packet in the buffer. |
|
virtual FBDeviceSyncPacket * | PacketLock () |
Lock a packet from the queue. |
|
virtual void | PacketUnlock (FBDeviceSyncPacket *pPacket, bool pValidPacket) |
Unlock a previously locked packet. |
|
virtual FBDeviceSyncPacket * | PacketFetch (int pRequestedSync) |
Fetch the data packet for the requested sync
count. |
|
virtual void | PacketRelease (FBDeviceSyncPacket *pPacket) |
Release a fetched packet. |
|
virtual FBDeviceSyncPacket * | PacketRemove (int pPacketIndex) |
Remove a packet from the packet queue.
|
|
virtual int | PacketGetCount () |
Get the number of packets in the queue.
|
|
virtual FBAnimationNode * | AnimationNodeInCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=true, double *pMin=NULL, double *pMax=NULL, bool pUserData=false) |
Creation of IN/OUT Animation Nodes. |
|
virtual FBAnimationNode * | AnimationNodeOutCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=true, double *pMin=NULL, double *pMax=NULL, bool pUserData=false) |
virtual bool | DeviceOperation (kDeviceOperations pOperation) |
Operate device. |
|
virtual void | DeviceTransportNotify (kTransportMode pMode, FBTime pTime, FBTime pSystem) |
Real-Time engine thread: Tranport
notifications. |
|
virtual bool | DeviceEvaluationNotify (kTransportMode pMode, FBEvaluateInfo *pEvaluateInfo) |
Real-Time engine thread: Output device
evaluation. |
|
virtual bool | ModelTemplateUnBindNotify (int pIndex, FBModelTemplate *pModelTemplate) |
Model Template unbinding notification
callback. |
|
FBModel * | ModelBindingCreate () |
Create a new model binding. |
|
void | ModelBindingRootsList (FBModelList &pList) |
Get the list of all the possible root models
for binding. |
|
virtual const char * | FbxGetObjectType () override |
Object Type "Device". |
|
virtual void | DeviceSendCommand (kDeviceOperations pOperation) |
Send a command to the device. |
|
IObject_Declare (K_IMPLEMENTATION) | |
void | AckOneSampleReceived () |
Acknowlege that one sample was received (for
statistical purposes). |
|
void | AckOneBadSampleReceived () |
Acknowlege that one bad sample was
received (for statistical purposes). |
|
void | AckOneSampleSent () |
Acknowlege that one sample was sent (for
statistical purposes). |
|
virtual bool | EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo) |
Evaluation of non TRS nodes that needs to be
evaluated. |
|
virtual bool | AnimationNodeDestroy (FBAnimationNode *pAnimationNode) |
Destroy an animation node. |
|
virtual bool | AnimationNodeIsUserData (FBAnimationNode *pAnimationNode) |
Is the animation node user data? |
|
virtual void | AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo) |
This call will disable all out animation
nodes from being pull by system (animation thread) for given
pEvaluateInfo. |
|
virtual const char * | FbxGetObjectSubType () |
returns UniqueName if not overloaded.
|
|
virtual void | FBDelete () override |
Open Reality deletion function. |
|
virtual bool | SetHIObject (HIObject pObject, bool pSDKComponent) override |
Assign component to an internal pointer.
|
|
virtual int | PropertyAdd (FBProperty *pProperty) |
Add a property to the component's property
manager. |
|
bool | PropertyAddReferenceProperty (FBProperty *pReferenceProperty) |
Add a reference property to the component's
property manager. |
|
void | PropertyRemove (FBProperty *pProperty) |
Remove a Property from the component's
Property manager. |
|
void | PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags) |
Get list of properties which have been
modified since last loading. |
|
FBProperty * | PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL) |
Create user or dynamic property. |
|
FBObjectFlag | GetObjectFlags () |
Get all Object Flags (concatenated).
|
|
void | SetObjectFlags (FBObjectFlag pFlags) |
SetObjectFlags. |
|
bool | HasObjectFlags (FBObjectFlag pFlags) |
Check whether a specific object flag is
enabled. |
|
void | EnableObjectFlags (FBObjectFlag pFlags) |
Enable a specific Object Flags. |
|
void | DisableObjectFlags (FBObjectFlag pFlags) |
Disable a specific Object Flags. |
|
void | SetObjectStatus (FBObjectStatus pStatus, bool pValue) |
Enable/Disable a specific Object Status.
|
|
bool | GetObjectStatus (FBObjectStatus pStatus) |
Check to see if an object status is enabled.
|
|
bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
ProcessNamespaceHierarchy. |
|
bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
ProcessObjectNamespace. |
|
virtual const char * | ClassName () override |
Get the class name. |
|
virtual bool | UseCustomPropertyViewSet () const |
Use the custom property viewSet or not.
|
|
const char * | GetFullName (void) |
Get the full name. |
|
void | SetOwnerNamespace (FBNamespace *pOwnerNSObj) |
Set the owner Namespace object. |
|
FBNamespace * | GetOwnerNamespace (void) |
Get the owner Namespace object. |
|
FBFileReference * | GetOwnerFileReference (void) |
Get the owner FileReference object. |
|
void | HardSelect () |
HardSelect. |
|
ICallback_Declare (K_IMPLEMENTATION) | |
virtual bool | Is (int pTypeId) |
Returns true if object is of type TypeId.
|
|
virtual int | GetTypeId () |
GetTypeId( int pTypeId ) |
|
void | KObjectEvent (HIRegister pView, HKEventBase pEvent) |
virtual HIObject | GetHIObject () const |
Return an internal pointer. |
|
bool | IsSDKComponent () |
Return whether or not item is an SDK
component. |
|
bool | ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. |
|
bool | ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. |
|
bool | ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. |
|
bool | ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. |
|
bool | DisconnectDst (FBPlug *pDst) |
Remove a destination connection. |
|
bool | DisconnectSrc (FBPlug *pSrc) |
Remove a source connection. |
|
void | DisconnectAllSrc () |
Remove all source connections. |
|
void | DisconnectAllDst () |
Remove all destination connections. |
|
bool | DisconnectDstAt (int pIndex) |
Remove a destination connection at a
specified index. |
|
bool | DisconnectSrcAt (int pIndex) |
Remove a source connection at a specified
index. |
|
bool | ReplaceDstAt (int pIndex, FBPlug *pDst) |
Replace a destination connection at a
specified index. |
|
bool | ReplaceSrcAt (int pIndex, FBPlug *pSrc) |
Replace a source connection at a specified
index. |
|
bool | SwapSrc (int pIndexA, int pIndexB) |
Swap source connection at index A with
source connection at index B. |
|
bool | MoveSrcAt (int pIndex, int pAtIndex) |
Move source connection at pIndex to
pAtIndex. |
|
bool | MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc) |
Move source connection pSrc to the position
of pAtSrc. |
|
int | GetSrcCount () |
Get source connection count. |
|
FBPlug * | GetSrc (int pIndex) |
Get a source connection's plug at specified
index. |
|
FBConnectionType | GetSrcType (int pIndex) |
Get a source connection's type at specified
index. |
|
int | GetDstCount () |
Get destination connection count. |
|
FBPlug * | GetDst (int pIndex) |
Get a destination connection's plug at
specified index. |
|
FBConnectionType | GetDstType (int pIndex) |
Get a destination connection's type at
specified index. |
|
bool | BeginChange () |
Begins a change on multiple plugs. |
|
void | EndChange () |
Ends a change on multiple plugs. |
|
void | SetSelfModified (FBPlugModificationFlag pFlag, bool pBool) |
Set the plug's self modification flag.
|
|
bool | GetSelfModified (FBPlugModificationFlag pFlag) |
Tell if the plug's self has changed.
|
|
void | SetContentModified (FBPlugModificationFlag pFlag, bool pBool) |
Set the plug's owned property/object's
modification flag. |
|
bool | GetContentModified (FBPlugModificationFlag pFlag) |
Tell if the plug's content has changed.
|
|
int | GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) |
Get plug's modified src/dst property/object
connection added/removed List. |
|
bool | RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask) |
Revert the plug's modification to original
status. |
|
void | SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue) |
Set the plug's status flag. |
|
bool | GetStatusFlag (FBPlugStatusFlag pStatus) const |
Tell if the plug's status has changed.
|
|
FBPlug * | GetOwner () |
Get the owner of this plug. |
|
FBPlug * | GetOwned (int pIndex) |
Get the owned plug at specified index.
|
|
int | GetOwnedCount () |
Get the owned plug count. |
|
virtual bool | PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
PlugDataNotify when overloaded is equivalent
of FBSystem.OnConnectionDataNotify
but in the context of the derived object only. |
|
virtual bool | PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
PlugStateNotify when overloaded is
equivalent of
FBSystem.OnConnectionStateNotify but in the context of the
derived object only. |
|
virtual bool | PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL) |
PlugNotify when overloaded is equivalent of
FBSystem.OnConnectionNotify but in the context of the derived
object only. |
|
FBScriptWrapper * | GetWrapper () |
Return the wrapper interface of this
FBObject. |
|
void | AddWrapper (FBScriptWrapper *) |
void | RemoveWrapper (FBScriptWrapper *) |
virtual FBAnimationNode * | AnimationNodeInGet () |
Get the (IN/OUT) animation node for this
box. |
|
virtual FBAnimationNode * | AnimationNodeOutGet () |
void * | operator new (size_t stAllocateBlock) |
void * | operator new (size_t stAllocateBlock, int blockType, const char *filename, int linenumber) |
void | operator delete (void *pvMem) |
void | RegisterPropertyEvent (FBPropertyEvent *pPropertyEvent) |
void | UnregisterPropertyEvent (FBPropertyEvent *pPropertyEvent) |
void | InvalidatePropertyEventsParents () |
Static Public Member Functions |
|
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 void | PrintClassDefinitions () |
Print out internal Class (ID) Definition
table. |
|
Public Attributes |
|
FBPropertyBool | UsingCustomInstruments |
Property(RW): Using custom
instruments? |
|
FBPropertyInt | NumberOfInstruments |
Property(RW): Number of instruments.
|
|
FBPropertyString | ModelTemplatePrefix |
Property(RW): Model template prefix.
|
|
FBPropertyInt | PacketBufferSize |
Property: Packet buffer
size(default=100). |
|
FBPropertyInt | SyncDelay |
Property: Synchronization delay (in
sync count units). |
|
FBPropertyBool | DebugInfo |
Property: Debugging Info? |
|
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. |
|
FBPropertyTime | SamplingPeriod |
Read Write Property: Set this to how
many times a device is to be evaluated in one second. |
|
FBPropertyBool | 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. |
|
FBPropertyInt | CommType |
Read Write Property: Type of
communications. |
|
FBPropertyListDeviceInstrument | Instruments |
List: List of instruments. |
|
FBPropertyTime | RecordingStartTime |
Read Only Property: The time at which
the recording started. |
|
FBPropertyTime | RecordingStopTime |
Read Only Property: The time at which
the recording stopped. |
|
const char * | UniqueName |
internal Unique name. |
|
FBPropertyBool | Animatable |
Read Write Property: Is the box
animatable. |
|
FBPropertyBool | Live |
Read Write Property: Is live?
|
|
FBPropertyBool | RecordMode |
Read Write Property: Is recording?
|
|
DataFBComponent * | mLocalPtr |
Handle on DataFBComponent. |
|
FBPropertyManager | PropertyList |
Read Only Property: Manages all of
the properties for the component. |
|
FBPropertyListComponent | Components |
List: List of components. |
|
FBPropertyListComponent | Parents |
List: Parents. |
|
FBPropertyBool | Selected |
Read Write Property: Selected
property. |
|
FBPropertyString | Name |
Read Write Property: Unique name of
object. |
|
FBPropertyString | LongName |
Read Write Property: Name and
namespace for object. |
|
FBPropertyFolder | Folder |
Read Write Property: The folder that
contain this component. |
|
KObject * | mDummyObject |
Internal Dummy Object for non KObject
Components. |
|
bool | mAllocated |
Contain the Allocation State of the
Component. |
|
Static Public Attributes |
|
static int | TypeInfo |
Contains the Type information of the object.
|
|
static const char * | ClassGroupName |
ClassGroupName of the object. |
|
Protected Attributes |
|
FBString | mName |
Name of the component. |
|
HIObject | mObject |
Handle on the Plug. |
|
bool | mSDKComponent |
bool Plug is an SDK component. |
|
Static Protected Attributes |
|
static int | mGlobalTypeInfo |
Represente the Type Index. |
|
Friends |
|
class | __FBDevice |
class | DataFBDeviceOptical |
K_DLLIMPORT friend int | __FBRegisterTypeInfo (int pInternalClassId) |
__FBRegisterTypeInfo For internal use only,
Register the TypeInfo mapped to internal class id. |
enum FBDevice::kDeviceOperations
[inherited] |
Types of operations for device.
These are parameters for the DeviceSendCommand() function.
enum FBDevice::kDeviceIOs
[inherited] |
Types of I/O for device.
These are states of the engine for the DeviceIONotify callback.
enum FBDevice::kTransportMode
[inherited] |
Transport control types for device.
These are states of the engine for the DeviceEvaluationNofity callback.
kPreparePlay |
Preparing to play. |
kPlayReady |
Ready to play. |
kPlayStop |
Stopping play. |
kStop |
Play stopped. |
kPlay |
Playing. |
kJog |
Jog. |
kPlayReverse |
Playing Reverse. |
Definition at line 754 of file fbcore.h.
{ kPreparePlay, kPlayReady, kPlayStop, kStop, kPlay, kJog, kPlayReverse };
FBDeviceCamera::FBDeviceCamera | ( | const char * | pName, |
HIObject | pObject =
NULL |
||
) |
Constructor.
pName | Unique name of optical device. |
pObject | Internal parent object(default=NULL). |
virtual bool FBDeviceCamera::FBCreate | ( | ) | [virtual] |
Open Reality Creation function.
Reimplemented from FBDeviceSync.
virtual void FBDeviceCamera::FBDestroy | ( | ) | [virtual] |
virtual bool FBDeviceCamera::DeviceSyncAnimationNodeNotify | ( | FBAnimationNode * | pAnimationNode, |
FBEvaluateInfo * | pEvaluateInfo, | ||
int | pCorrectedSync | ||
) | [virtual] |
Real-Time synchronous evaluation callback.
Note that this function must be overloaded to instanciate a synchronous device class.
pAnimationNode | Connector being pulled. |
pEvaluateInfo | Evaluation information structure. |
pCorrectedSync | Corrected sync value. |
Implements FBDeviceSync.
virtual void FBDeviceCamera::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.
pAction | Different reading/writing actions for the device. |
pDeviceNotifyInfo | Access to the system and local time. |
Reimplemented from FBDevice.
virtual bool FBDeviceCamera::ModelTemplateBindNotify | ( | FBModel * | pModel, |
int | pIndex, | ||
FBModelTemplate * | pModelTemplate | ||
) | [virtual] |
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. |
Reimplemented from FBDevice.
virtual bool FBDeviceCamera::FbxStore | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
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 FBDeviceSync.
virtual bool FBDeviceCamera::FbxRetrieve | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
Reimplemented from FBDeviceSync.
virtual void FBDeviceCamera::RecordingInitAnimation | ( | FBAnimationNode * | pAnimationNode | ) | [virtual] |
When recording, initialize animation.
pAnimationNode | Animation node to read information from. |
Reimplemented from FBDevice.
virtual void FBDeviceCamera::RecordingDoneAnimation | ( | FBAnimationNode * | pAnimationNode | ) | [virtual] |
When recording, finish animation.
pAnimationNode | Animation node to write information to. |
Reimplemented from FBDevice.
virtual bool FBDeviceCamera::DeviceCameraAnimationNodeNotify | ( | FBEvaluateInfo * | pEvaluateInfo, |
FBDeviceCameraPacket * | pDstPacket, | ||
FBDeviceSyncPacket * | pSrcPacket | ||
) | [virtual] |
Evaluation engine callback for camera device.
pEvaluateInfo | Evaluation information structure. |
pDstPacket | Destination packet to fill with camera data (will go to connectors). |
pSrcPacket | Source packet of information (from Sync buffer). |
virtual void FBDeviceCamera::DeviceCameraEvalData | ( | FBDeviceNotifyInfo & | pNotifyInfo | ) | [virtual] |
I/O for camera device.
This synchronous callback is used to fill the device buffer and is not necessary if the device I/O notify function call is overloaded, as it merely isolates the read operation from DeviceIONotify().
pNotifyInfo | Device notification information structure. |
virtual void FBDeviceCamera::DeviceCameraRecordFrame | ( | FBTime & | pRecordTime, |
FBDeviceNotifyInfo & | pNotifyInfo | ||
) | [virtual] |
Record a frame of data to the FCurves for the camera device.
pRecordTime | Time to record values for. |
pNotifyInfo | Device notification structure. |
virtual bool FBDeviceCamera::DeviceCameraWriteData | ( | FBEvaluateInfo * | pEvaluateInfo | ) | [virtual] |
Write data to camera connectors.
pEvaluateInfo | Evaluation information structure. |
virtual bool FBDeviceCamera::LoadLensTables | ( | const char * | pFilename | ) | [virtual] |
Load the lens lookup tables.
pFilename | Name of *.klc file with lens values. |
virtual void FBDeviceCamera::ProcessLensData | ( | FBDeviceCameraPacket * | pDataPacket | ) | [virtual] |
Process the lens table data for this data packet.
The actual operation for this will depend on a couple of properties for the instrument: LensTableLoaded, LensMode, as well as the invert values and the zoom multiplier.
pDataPacket | Camera data to process with the lens tables. |
virtual void FBDeviceSync::PrintDebugAnimInfo | ( | int | pSync, |
FBDeviceSyncPacket * | pSyncPacket, | ||
FBEvaluateInfo * | pEvaluateInfo | ||
) | [virtual, inherited] |
Print to screen animation info.
pSync | Application sync. |
pSyncPacket | Device sync packet. |
pEvaluateInfo | Information for evaluation. |
virtual void FBDeviceSync::PrintDebugIOInfo | ( | FBDeviceSyncPacket * | pSyncPacket, |
FBDeviceNotifyInfo & | pDeviceNotifyInfo | ||
) | [virtual, inherited] |
Print to screen input/output info.
pSyncPacket | Device sync packet. |
pDeviceNotifyInfo | Device notification info. |
virtual void FBDeviceSync::PrintDebugIONotifyInfo | ( | FBDeviceNotifyInfo & | pInfo, |
int | pPacketCount | ||
) | [virtual, inherited] |
Print to screen input/output notification info.
pInfo | Device sync packet. |
pPacketCount | Device notification info. |
virtual bool FBDeviceSync::AnimationNodeNotify | ( | FBAnimationNode * | pAnimationNode, |
FBEvaluateInfo * | pEvaluateInfo | ||
) | [virtual, inherited] |
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 FBDevice.
virtual void FBDeviceSync::PacketRegister | ( | FBDeviceSyncPacket * | pPacket | ) | [virtual, inherited] |
Register a packet in the buffer.
This will determine the buffer size (based on the number of packets that are added). Each packet should be allocated dynamically just before being added then registered to the device, which will then take complete ownership (and will destroy the packet itself).
pPacket | Newly allocated packet to register in the buffer. |
virtual FBDeviceSyncPacket* FBDeviceSync::PacketLock | ( | ) | [virtual, inherited] |
Lock a packet from the queue.
Locks a packet for modification (write), to be used in the DeviceIONotify Function
virtual void FBDeviceSync::PacketUnlock | ( | FBDeviceSyncPacket * | pPacket, |
bool | pValidPacket | ||
) | [virtual, inherited] |
Unlock a previously locked packet.
Unlocks a packet pPacket, indicating whether or not the packet is valid. If valid, the packet is kept in the buffer. Otherwise, the packet is listed as being free for the other write operations. To be used in DeviceIONotify() for unlocking a packet being read from the device.
pPacket | Packet to unlock. |
pValidPacket | Is the packet valid data or not. |
virtual FBDeviceSyncPacket* FBDeviceSync::PacketFetch | ( | int | pRequestedSync | ) | [virtual, inherited] |
Fetch the data packet for the requested sync count.
Given a requested sync count, pRequestedSync, return the data packet that corresponds to this count in the queue. This routine will also protect the packet from write operations, requiring a call to PacketRelease when the current use is finished. To be used in AnimationNodeNotify() for locking a packet being read from the device.
pRequestedSync | Desired packet sync count. |
virtual void FBDeviceSync::PacketRelease | ( | FBDeviceSyncPacket * | pPacket | ) | [virtual, inherited] |
Release a fetched packet.
Finish a read process of a specified packet pPacket. This will make the packet available to be read/modified by other processes. To be used in AnimationNodeNotify() for unlocking a packet being read from the device.
virtual FBDeviceSyncPacket* FBDeviceSync::PacketRemove | ( | int | pPacketIndex | ) | [virtual, inherited] |
Remove a packet from the packet queue.
pPacketIndex | Index of packet to remove. |
virtual int FBDeviceSync::PacketGetCount | ( | ) | [virtual, inherited] |
Get the number of packets in the queue.
virtual FBAnimationNode* FBDevice::AnimationNodeInCreate | ( | kReference | pUserId, |
const char * | pName, | ||
const char * | pDataType, | ||
bool | pIsPublic = true , |
||
double * | pMin = NULL , |
||
double * | pMax = NULL , |
||
bool | pUserData =
false |
||
) | [virtual, inherited] |
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.
virtual FBAnimationNode* FBDevice::AnimationNodeOutCreate | ( | kReference | pUserId, |
const char * | pName, | ||
const char * | pDataType, | ||
bool | pIsPublic = true , |
||
double * | pMin = NULL , |
||
double * | pMax = NULL , |
||
bool | pUserData =
false |
||
) | [virtual, inherited] |
Reimplemented from FBBox.
virtual bool FBDevice::DeviceOperation | ( | kDeviceOperations | pOperation | ) | [virtual, inherited] |
Operate device.
This is an operation such as Init, Start, Done, Reset, etc.
pOperation | Operation to have device perform. |
Reimplemented in FBDeviceOptical.
virtual void FBDevice::DeviceTransportNotify | ( | kTransportMode | pMode, |
FBTime | pTime, | ||
FBTime | pSystem | ||
) | [virtual, inherited] |
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. |
virtual bool FBDevice::DeviceEvaluationNotify | ( | kTransportMode | pMode, |
FBEvaluateInfo * | pEvaluateInfo | ||
) | [virtual, inherited] |
Real-Time engine thread: Output device evaluation.
pMode | Transport mode. |
pEvaluateInfo | Access to the system and local time. |
virtual bool FBDevice::ModelTemplateUnBindNotify | ( | int | pIndex, |
FBModelTemplate * | pModelTemplate | ||
) | [virtual, inherited] |
Model Template unbinding notification callback.
pIndex | Index in pModelTemplate where unbinding has occured. |
pModelTemplate | Model template from which binding is removed. |
FBModel* FBDevice::ModelBindingCreate | ( | ) | [inherited] |
Create a new model binding.
void FBDevice::ModelBindingRootsList | ( | FBModelList & | pList | ) | [inherited] |
Get the list of all the possible root models for binding.
pList | List to add found models to. |
virtual const char* FBDevice::FbxGetObjectType | ( | ) | [override, virtual, inherited] |
virtual void FBDevice::DeviceSendCommand | ( | kDeviceOperations | pOperation | ) | [virtual, inherited] |
Send a command to the device.
This function will send the Init, Start, etc. commands to the device.
pOperation | Operation for device to perform. |
FBDevice::IObject_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
Reimplemented from FBBox.
void FBDevice::AckOneSampleReceived | ( | ) | [inherited] |
Acknowlege that one sample was received (for statistical purposes).
void FBDevice::AckOneBadSampleReceived | ( | ) | [inherited] |
Acknowlege that one bad sample was received (for statistical purposes).
void FBDevice::AckOneSampleSent | ( | ) | [inherited] |
Acknowlege that one sample was sent (for statistical purposes).
virtual bool FBBox::EvaluateAnimationNodes | ( | FBEvaluateInfo * | pEvaluateInfo | ) | [virtual, inherited] |
Evaluation of non TRS nodes that needs to be evaluated.
This function is called by the real-time engine in order to process animation information.
pEvaluateInfo | Information concerning the evaluation of the animation (time, etc.) |
virtual bool FBBox::AnimationNodeDestroy | ( | FBAnimationNode * | pAnimationNode | ) | [virtual, inherited] |
Destroy an animation node.
pAnimationNode | Handle to the animation node to be destroyed. |
virtual bool FBBox::AnimationNodeIsUserData | ( | FBAnimationNode * | pAnimationNode | ) | [virtual, inherited] |
Is the animation node user data?
pAnimationNode | Handle to the animation to be queried. |
virtual void FBBox::AnimationNodesOutDisableIfNotWritten | ( | FBEvaluateInfo * | pEvaluateInfo | ) | [virtual, inherited] |
This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.
pEvaluateInfo | Evaluation synchronization object (contains evaluation id). |
virtual FBAnimationNode* FBBox::AnimationNodeInGet | ( | ) | [virtual, inherited] |
Get the (IN/OUT) animation node for this box.
virtual FBAnimationNode* FBBox::AnimationNodeOutGet | ( | ) | [virtual, inherited] |
virtual const char* FBBox::FbxGetObjectSubType | ( | ) | [virtual, inherited] |
returns UniqueName if not overloaded.
Reimplemented in FBMaterial, FBModel, FBModelNull, and FBModelMarker.
FBComponent::GetInternalClassId | ( | ) | [static, inherited] |
virtual void FBComponent::FBDelete | ( | ) | [override, virtual, inherited] |
Open Reality deletion function.
Reimplemented from FBPlug.
Reimplemented in FBAudioClip, FBActor, FBCharacter, FBCharacterExtension, FBActorFace, FBCharacterFace, FBContainer, FBFCurve, FBAnimationLayer, FBTake, FBFolder, FBGroup, FBSet, FBImage, FBKeyingGroup, FBModel, FBMotionClip, FBScene, FBStoryFolder, FBStoryTrack, FBStoryClip, FBTexture, FBLayeredTexture, FBVideoClip, and FBGenericMenu.
virtual bool FBComponent::SetHIObject | ( | HIObject | pObject, |
bool | pSDKComponent | ||
) | [override, virtual, inherited] |
virtual int FBComponent::PropertyAdd | ( | FBProperty * | pProperty | ) | [virtual, inherited] |
Add a property to the component's property manager.
pProperty | The property to add to the property manager. |
bool FBComponent::PropertyAddReferenceProperty | ( | FBProperty * | pReferenceProperty | ) | [inherited] |
Add a reference property to the component's property manager.
pReferenceProperty | The property to from an other object to add a reference to (property cannot be a custom ORSDK property). |
void FBComponent::PropertyRemove | ( | FBProperty * | pProperty | ) | [inherited] |
Remove a Property from the component's Property manager.
If the property was dynamically allocated, it is deleted.
pProperty | The property to remove from the property manager. |
void FBComponent::PropertyGetModifiedList | ( | FBArrayTemplate< FBProperty * > & | pPropList, |
FBPlugModificationFlag | pModificationFlags | ||
) | [inherited] |
Get list of properties which have been modified since last loading.
pPropList | property list to hold the modified properties. |
pModificationFlags | type of modification to query. |
FBProperty* FBComponent::PropertyCreate | ( | const char * | pName, |
FBPropertyType | pType, | ||
const char * | pDataType, | ||
bool | pAnimatable, | ||
bool | pIsUser = false , |
||
FBProperty * | pReferenceSource =
NULL |
||
) | [inherited] |
Create user or dynamic property.
pName | The name of the property. |
pType | Type of the property. See enum FBPropertyType. |
pDataType | DataType of the property. |
pAnimatable | To specify if the property can be animated. |
pIsUser | To specify if the property is available as a custom property or dynamic and attached to the object. |
pReferenceSource | Specifies the property that a reference refers to. |
FBObjectFlag FBComponent::GetObjectFlags | ( | ) | [inherited] |
Get all Object Flags (concatenated).
void FBComponent::SetObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
SetObjectFlags.
pFlags | Set flag values. Note: this function overwrites all flags with those passed in parameter. |
bool FBComponent::HasObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
Check whether a specific object flag is enabled.
pFlags | Flags to check if they are present. |
void FBComponent::EnableObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
void FBComponent::DisableObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
void FBComponent::SetObjectStatus | ( | FBObjectStatus | pStatus, |
bool | pValue | ||
) | [inherited] |
Enable/Disable a specific Object Status.
pStatus | Status to change. |
pValue | Value to change the status to. |
bool FBComponent::GetObjectStatus | ( | FBObjectStatus | pStatus | ) | [inherited] |
Check to see if an object status is enabled.
pStatus | Status to query. |
bool FBComponent::ProcessNamespaceHierarchy | ( | FBNamespaceAction | pNamespaceAction, |
const char * | pNamespaceName, | ||
const char * | pReplaceTo = NULL , |
||
bool | pAddRight =
true |
||
) | [inherited] |
ProcessNamespaceHierarchy.
New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.
pNamespaceAction | Which operation to do on the hierarchy (children). |
pNamespaceName | The Namespace name on Add/Delete or the prefix to replace in case of replace. |
pReplaceTo | The new Namespace Name or NULL in case of add or delete. |
pAddRight | Whether to add the namespace on right-most or left-most side or other namespace. |
bool FBComponent::ProcessObjectNamespace | ( | FBNamespaceAction | pNamespaceAction, |
const char * | pNamespaceName, | ||
const char * | pReplaceTo = NULL , |
||
bool | pAddRight =
true |
||
) | [inherited] |
ProcessObjectNamespace.
New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.
pNamespaceAction | Which operation to do on the hierarchy (children). |
pNamespaceName | The Namespace name on Add/Delete or the prefix to replace in case of replace. |
pReplaceTo | The new Namespace Name or NULL in case of add or delete. |
pAddRight | Whether to add the namespace on right-most or left-most side or other namespace. |
virtual const char* FBComponent::ClassName | ( | ) | [override, virtual, inherited] |
Get the class name.
Reimplemented from FBPlug.
Reimplemented in FBCustomManager.
virtual bool FBComponent::UseCustomPropertyViewSet | ( | ) | const [inline, virtual, inherited] |
Use the custom property viewSet or not.
To have custom property view for custom subclass, modification bin/config/propertyview.fbx is required.
Definition at line 791 of file fbcomponent.h.
{ return true; }
const char* FBComponent::GetFullName | ( | void | ) | [inherited] |
void FBComponent::SetOwnerNamespace | ( | FBNamespace * | pOwnerNSObj | ) | [inherited] |
Set the owner Namespace object.
FBNamespace* FBComponent::GetOwnerNamespace | ( | void | ) | [inherited] |
FBFileReference* FBComponent::GetOwnerFileReference | ( | void | ) | [inherited] |
Get the owner FileReference object.
void FBComponent::HardSelect | ( | ) | [inherited] |
HardSelect.
Selects the object, and emits a hard select event for UI update notification.
void* FBComponent::operator new | ( | size_t | stAllocateBlock | ) | [inherited] |
void* FBComponent::operator new | ( | size_t | stAllocateBlock, |
int | blockType, | ||
const char * | filename, | ||
int | linenumber | ||
) | [inherited] |
void FBComponent::operator delete | ( | void * | pvMem | ) | [inherited] |
void FBComponent::RegisterPropertyEvent | ( | FBPropertyEvent * | pPropertyEvent | ) | [inherited] |
void FBComponent::UnregisterPropertyEvent | ( | FBPropertyEvent * | pPropertyEvent | ) | [inherited] |
void FBComponent::InvalidatePropertyEventsParents | ( | ) | [inherited] |
FBComponent::ICallback_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
Reimplemented from FBPlug.
Reimplemented in FBModel, and FBVisualComponent.
virtual bool FBComponent::Is | ( | int | pTypeId | ) | [virtual, inherited] |
Returns true if object is of type TypeId.
pTypeId | TypeId to compare object to. |
Reimplemented from FBPlug.
Reimplemented in FBCustomManager.
virtual int FBComponent::GetTypeId | ( | ) | [virtual, inherited] |
GetTypeId( int pTypeId )
Reimplemented from FBPlug.
Reimplemented in FBCustomManager.
static void FBComponent::FBComponentSetName | ( | FBComponent * | pObject, |
const char * | pName | ||
) | [static, inherited] |
static const char* FBComponent::FBComponentGetName | ( | FBComponent * | pObject | ) | [static, inherited] |
static void FBComponent::FBComponentSetLongName | ( | FBComponent * | pObject, |
const char * | pName | ||
) | [static, inherited] |
static const char* FBComponent::FBComponentGetLongName | ( | FBComponent * | pObject | ) | [static, inherited] |
void FBComponent::KObjectEvent | ( | HIRegister | pView, |
HKEventBase | pEvent | ||
) | [inherited] |
virtual HIObject FBPlug::GetHIObject | ( | ) | const [virtual, inherited] |
Return an internal pointer.
bool FBPlug::IsSDKComponent | ( | ) | [inherited] |
Return whether or not item is an SDK component.
bool FBPlug::ConnectSrc | ( | FBPlug * | pSrc, |
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a source connection.
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectDst | ( | FBPlug * | pDst, |
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a destination connection.
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectSrcAt | ( | int | pDst_SrcIndex, |
FBPlug * | pSrc, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a source connection.
pDst_SrcIndex | Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end. |
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectDstAt | ( | int | pSrc_DstIndex, |
FBPlug * | pDst, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a destination connection.
pSrc_DstIndex | Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end. |
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::DisconnectDst | ( | FBPlug * | pDst | ) | [inherited] |
Remove a destination connection.
pDst | Destination plug. |
bool FBPlug::DisconnectSrc | ( | FBPlug * | pSrc | ) | [inherited] |
Remove a source connection.
pSrc | Source plug. |
void FBPlug::DisconnectAllSrc | ( | ) | [inherited] |
Remove all source connections.
void FBPlug::DisconnectAllDst | ( | ) | [inherited] |
Remove all destination connections.
bool FBPlug::DisconnectDstAt | ( | int | pIndex | ) | [inherited] |
Remove a destination connection at a specified index.
pIndex | Destination plug index. |
bool FBPlug::DisconnectSrcAt | ( | int | pIndex | ) | [inherited] |
Remove a source connection at a specified index.
pIndex | Source plug index. |
bool FBPlug::ReplaceDstAt | ( | int | pIndex, |
FBPlug * | pDst | ||
) | [inherited] |
Replace a destination connection at a specified index.
pIndex | Destination plug index. |
pDst | Plug that will replace the other at index. |
bool FBPlug::ReplaceSrcAt | ( | int | pIndex, |
FBPlug * | pSrc | ||
) | [inherited] |
Replace a source connection at a specified index.
pIndex | Source plug index. |
pSrc | Plug that will replace the other at index. |
bool FBPlug::SwapSrc | ( | int | pIndexA, |
int | pIndexB | ||
) | [inherited] |
Swap source connection at index A with source connection at index B.
pIndexA | Plug index. |
pIndexB | Other plug index. |
bool FBPlug::MoveSrcAt | ( | int | pIndex, |
int | pAtIndex | ||
) | [inherited] |
Move source connection at pIndex to pAtIndex.
pIndex | Plug current index. |
pAtIndex | Plug new index. |
Move source connection pSrc to the position of pAtSrc.
pSrc | Plug. |
pAtSrc | Plug that mark where we want to insert (will insert before this one). |
int FBPlug::GetSrcCount | ( | ) | [inherited] |
FBPlug* FBPlug::GetSrc | ( | int | pIndex | ) | [inherited] |
Get a source connection's plug at specified index.
pIndex | Index of the source connection's plug. |
FBConnectionType FBPlug::GetSrcType | ( | int | pIndex | ) | [inherited] |
Get a source connection's type at specified index.
pIndex | Index of the source connection's type. |
int FBPlug::GetDstCount | ( | ) | [inherited] |
Get destination connection count.
FBPlug* FBPlug::GetDst | ( | int | pIndex | ) | [inherited] |
Get a destination connection's plug at specified index.
pIndex | Index of the destination connection's plug. |
FBConnectionType FBPlug::GetDstType | ( | int | pIndex | ) | [inherited] |
Get a destination connection's type at specified index.
pIndex | Index of the destination connection's type. |
bool FBPlug::BeginChange | ( | ) | [inherited] |
Begins a change on multiple plugs.
void FBPlug::EndChange | ( | ) | [inherited] |
Ends a change on multiple plugs.
void FBPlug::SetSelfModified | ( | FBPlugModificationFlag | pFlag, |
bool | pBool | ||
) | [inherited] |
Set the plug's self modification flag.
pFlag | bitwise AND of self modification flags. |
pBool | true if self changed. |
bool FBPlug::GetSelfModified | ( | FBPlugModificationFlag | pFlag | ) | [inherited] |
Tell if the plug's self has changed.
pFlag | bitwise AND of self modification flags. |
void FBPlug::SetContentModified | ( | FBPlugModificationFlag | pFlag, |
bool | pBool | ||
) | [inherited] |
Set the plug's owned property/object's modification flag.
pFlag | bitwise AND of content modification flags. |
pBool | true if content has modification. |
bool FBPlug::GetContentModified | ( | FBPlugModificationFlag | pFlag | ) | [inherited] |
Tell if the plug's content has changed.
pFlag | bitwise AND of content modification flags. |
int FBPlug::GetPlugConnectionModifiedList | ( | FBPlugList & | pPlugList, |
FBPlugModificationFlag | pConnectionModificatonFlag, | ||
bool | pAddRemove | ||
) | [inherited] |
Get plug's modified src/dst property/object connection added/removed List.
pPlugList | plug list to fill up. |
pConnectionModificatonFlag | Src/Dst Property/Object connection modification flag. |
pAddRemove | Ask for the added list if true, removed list if false. |
bool FBPlug::RevertModification | ( | FBPlugModificationFlag | pFlag =
kFBAllModifiedMask |
) | [inherited] |
Revert the plug's modification to original status.
pFlag | the type of modification to be reverted. |
void FBPlug::SetStatusFlag | ( | FBPlugStatusFlag | pStatus, |
bool | pValue | ||
) | [inherited] |
Set the plug's status flag.
pStatus | bitwise AND of status flags. |
pValue | true if status has modification. |
bool FBPlug::GetStatusFlag | ( | FBPlugStatusFlag | pStatus | ) | const [inherited] |
Tell if the plug's status has changed.
pStatus | bitwise AND of self modification flags. |
FBPlug* FBPlug::GetOwner | ( | ) | [inherited] |
Get the owner of this plug.
Very useful for properties since they are plugs too.
FBPlug* FBPlug::GetOwned | ( | int | pIndex | ) | [inherited] |
Get the owned plug at specified index.
pIndex | Index of the owned plug to get. |
int FBPlug::GetOwnedCount | ( | ) | [inherited] |
virtual bool FBPlug::PlugDataNotify | ( | FBConnectionAction | pAction, |
FBPlug * | pThis, | ||
void * | pData = NULL , |
||
void * | pDataOld = NULL , |
||
int | pDataSize =
0 |
||
) | [virtual, inherited] |
PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
pAction | Plug action, the event type. |
pThis | Plug concerned. |
pData | Current data, meaning depends of plug action. |
pDataOld | Previous data, meaning depends of plug action. |
pDataSize | Size of data. |
virtual bool FBPlug::PlugStateNotify | ( | FBConnectionAction | pAction, |
FBPlug * | pThis, | ||
void * | pData = NULL , |
||
void * | pDataOld = NULL , |
||
int | pDataSize =
0 |
||
) | [virtual, inherited] |
PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
pAction | Plug action, the event type. |
pThis | Plug concerned. |
pData | Current data, meaning depends of plug action. |
pDataOld | Previous data, meaning depends of plug action. |
pDataSize | Size of data. |
virtual bool FBPlug::PlugNotify | ( | FBConnectionAction | pAction, |
FBPlug * | pThis, | ||
int | pIndex, | ||
FBPlug * | pPlug = NULL , |
||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone , |
||
FBPlug * | pNewPlug =
NULL |
||
) | [virtual, inherited] |
PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
pAction | Plug action, the event type. |
pThis | Plug concerned. |
pIndex | Index of the plug. |
pPlug | Other plug concerned. |
pConnectionType | Connection type between the plugs. |
pNewPlug | New plug (for the replace event). |
static void FBPlug::PrintClassDefinitions | ( | ) | [static, inherited] |
Print out internal Class (ID) Definition table.
For internal debug purpose only.
FBScriptWrapper* FBWrapperHolder::GetWrapper | ( | ) | [inherited] |
Return the wrapper interface of this FBObject.
void FBWrapperHolder::AddWrapper | ( | FBScriptWrapper * | ) | [inherited] |
void FBWrapperHolder::RemoveWrapper | ( | FBScriptWrapper * | ) | [inherited] |
friend class __FBDevice [friend,
inherited] |
friend class DataFBDeviceOptical [friend,
inherited] |
K_DLLIMPORT friend int __FBRegisterTypeInfo | ( | int | pInternalClassId | ) | [friend, inherited] |
__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.
Property(RW): Using custom instruments?
Definition at line 347 of file fbtracker.h.
Property(RW): Number of instruments.
Definition at line 348 of file fbtracker.h.
Property(RW): Model template prefix.
Definition at line 349 of file fbtracker.h.
FBPropertyInt
FBDeviceSync::PacketBufferSize
[inherited] |
Property: Packet buffer size(default=100).
Definition at line 188 of file fbtracker.h.
FBPropertyInt
FBDeviceSync::SyncDelay
[inherited] |
Property: Synchronization delay (in sync count units).
Definition at line 189 of file fbtracker.h.
FBPropertyBool
FBDeviceSync::DebugInfo
[inherited] |
FBPropertyString FBDevice::IconFilename
[inherited] |
Read Write Property: Icon filename.
FBPropertyString FBDevice::Status
[inherited] |
Read Write Property: Device information: status.
FBPropertyString FBDevice::Information
[inherited] |
Read Write Property: Device information: information.
FBPropertyString FBDevice::HardwareVersionInfo
[inherited] |
Read Write Property: Device information: hardware version.
FBPropertyTime
FBDevice::SamplingPeriod
[inherited] |
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).
FBPropertyBool
FBDevice::Online
[inherited] |
FBPropertyEvent FBDevice::OnStatusChange
[inherited] |
Event: Status of device changed.
FBModelTemplate FBDevice::ModelTemplate
[inherited] |
Component: Root of model template structure.
FBPropertyModel FBDevice::ModelBindingRoot
[inherited] |
Component: Root of model currently binded model hierarchy.
FBPropertyDeviceSamplingMode FBDevice::SamplingMode
[inherited] |
Read Write Property: Mode to use to record device.
FBPropertyInt
FBDevice::CommType
[inherited] |
Read Write Property: Type of communications.
FBPropertyListDeviceInstrument
FBDevice::Instruments
[inherited] |
FBPropertyTime
FBDevice::RecordingStartTime
[inherited] |
Read Only Property: The time at which the recording started.
FBPropertyTime
FBDevice::RecordingStopTime
[inherited] |
Read Only Property: The time at which the recording stopped.
const char* FBBox::UniqueName
[inherited] |
FBPropertyBool
FBBox::Animatable
[inherited] |
Read Write Property: Is the box animatable.
FBPropertyBool
FBBox::Live
[inherited] |
FBPropertyBool
FBBox::RecordMode
[inherited] |
Read Write Property: Is recording?
DataFBComponent* FBComponent::mLocalPtr
[inherited] |
Handle on DataFBComponent.
Reimplemented in FBCustomManager.
Definition at line 650 of file fbcomponent.h.
FBString FBComponent::mName
[protected, inherited] |
int FBComponent::TypeInfo
[static, inherited] |
Contains the Type information of the object.
Reimplemented from FBPlug.
Reimplemented in FBCustomManager.
Definition at line 658 of file fbcomponent.h.
FBPropertyManager FBComponent::PropertyList
[inherited] |
Read Only Property: Manages all of the properties for the component.
Definition at line 838 of file fbcomponent.h.
FBPropertyListComponent
FBComponent::Components
[inherited] |
List: List of components.
Reimplemented in FBScene, and FBPropertyInspector.
Definition at line 839 of file fbcomponent.h.
FBPropertyListComponent
FBComponent::Parents
[inherited] |
FBPropertyBool
FBComponent::Selected
[inherited] |
Read Write Property: Selected property.
Definition at line 841 of file fbcomponent.h.
FBPropertyString FBComponent::Name
[inherited] |
Read Write Property: Unique name of object.
Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.
Definition at line 842 of file fbcomponent.h.
FBPropertyString FBComponent::LongName
[inherited] |
Read Write Property: Name and namespace for object.
Definition at line 843 of file fbcomponent.h.
FBPropertyFolder FBComponent::Folder
[inherited] |
Read Write Property: The folder that contain this component.
Definition at line 846 of file fbcomponent.h.
KObject* FBComponent::mDummyObject
[inherited] |
Internal Dummy Object for non KObject Components.
Definition at line 871 of file fbcomponent.h.
const char* FBPlug::ClassGroupName
[static, inherited] |
bool FBPlug::mAllocated
[inherited] |
Contain the Allocation State of the Component.
int FBPlug::mGlobalTypeInfo
[static, protected, inherited] |
HIObject FBPlug::mObject
[protected, inherited] |
bool FBPlug::mSDKComponent
[protected, inherited] |