FBDeviceGlove Class Reference
 
 
 
FBDeviceGlove Class Reference

#include <fbcore.h>


Class Description

Base Glove class.

Definition at line 909 of file fbcore.h.

Inheritance diagram for FBDeviceGlove:
FBDevice FBBox FBComponent FBPlug FBWrapperHolder

Classes

class   GloveChannel
  Base GloveChannel. More...

Public Types

enum   kHandModelPart {
  kPartRoot, kPartPalm, kPartThumbA, kPartThumbB,
  kPartThumbC, kPartThumbD, kPartIndexA, kPartIndexB,
  kPartIndexC, kPartIndexD, kPartMiddleA, kPartMiddleB,
  kPartMiddleC, kPartMiddleD, kPartRingA, kPartRingB,
  kPartRingC, kPartRingD, kPartLittleA, kPartLittleB,
  kPartLittleC, kPartLittleD, kPartMax
}
  Hand model parts. More...
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

  FBDeviceGlove (const char *pName, HIObject pObject=NULL)
  Constructor.
virtual void  RecordingInitAnimation (FBAnimationNode *pAnimationNode)
  When recording, initialize animation.
virtual void  RecordingDoneAnimation (FBAnimationNode *pAnimationNode)
  When recording, finish animation.
virtual bool  FBCreate ()
  Open Reality Creation function.
virtual void  FBDestroy ()
  Open Reality destruction function.
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 void  DeviceIONotify (kDeviceIOs pAction, FBDeviceNotifyInfo &pDeviceNotifyInfo)
  Real-Time engine thread: Device I/O.
virtual bool  DeviceEvaluationNotify (kTransportMode pMode, FBEvaluateInfo *pEvaluateInfo)
  Real-Time engine thread: Output device evaluation.
virtual bool  ModelTemplateBindNotify (FBModel *pModel, int pIndex, FBModelTemplate *pModelTemplate)
  Model Template binding notification callback.
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 bool  AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo) override
  Notification function for animation thread.
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 bool  FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
  Storage/Retrieval of information into the FBX file format.
virtual bool  FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
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

FBArrayTemplate< GloveChannel * >  Channels
  Glove channels.
FBPropertyBool  LeftHand
  Read Write Property: Left or right hand glove.
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 Member Functions

void  InitializeModelGeometry ()
  Initialize the hand model geometry.
void  VectorToModelPartAngle (kHandModelPart pPartIndex, FBVector3d &pVector)
  Bring the vector in parameter to a valid angle range of rotation for a given part of the hand model.
FBAnimationNode GetModelRotationNode (kHandModelPart pPartIndex)
  Obtain the rotation animation node of a part of the hand model.

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.

Member Enumeration Documentation

Hand model parts.

Enumerator:
kPartRoot 
kPartPalm 
kPartThumbA 
kPartThumbB 
kPartThumbC 
kPartThumbD 
kPartIndexA 
kPartIndexB 
kPartIndexC 
kPartIndexD 
kPartMiddleA 
kPartMiddleB 
kPartMiddleC 
kPartMiddleD 
kPartRingA 
kPartRingB 
kPartRingC 
kPartRingD 
kPartLittleA 
kPartLittleB 
kPartLittleC 
kPartLittleD 
kPartMax 

Definition at line 914 of file fbcore.h.

                            {   // Parents :

            kPartRoot,          // No parent
            kPartPalm,          // kPartRoot

            // Thumb
            kPartThumbA,        // kPartPalm
            kPartThumbB,        // kPartThumbA
            kPartThumbC,        // kPartThumbB
            kPartThumbD,        // kPartThumbC

            // Index
            kPartIndexA,        // kPartPalm
            kPartIndexB,        // kPartIndexA
            kPartIndexC,        // kPartIndexB
            kPartIndexD,        // kPartIndexC

            // Middle
            kPartMiddleA,       // kPartPalm
            kPartMiddleB,       // kPartMiddleA
            kPartMiddleC,       // kPartMiddleB
            kPartMiddleD,       // kPartMiddleC

            // Ring
            kPartRingA,         // kPartPalm
            kPartRingB,         // kPartRingA
            kPartRingC,         // kPartRingB
            kPartRingD,         // kPartRingC

            // Little
            kPartLittleA,       // kPartPalm
            kPartLittleB,       // kPartLittleA
            kPartLittleC,       // kPartLittleB
            kPartLittleD,       // kPartLittleC

            kPartMax
        };
enum FBDevice::kDeviceOperations [inherited]

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 732 of file fbcore.h.

enum FBDevice::kDeviceIOs [inherited]

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 744 of file fbcore.h.

enum FBDevice::kTransportMode [inherited]

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 754 of file fbcore.h.


Constructor & Destructor Documentation

FBDeviceGlove::FBDeviceGlove ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pName Name of device.
pObject For internal use only (default is NULL).

Member Function Documentation

virtual void FBDeviceGlove::RecordingInitAnimation ( FBAnimationNode pAnimationNode ) [virtual]

When recording, initialize animation.

Parameters:
pAnimationNode Animation node to read information from.

Reimplemented from FBDevice.

virtual void FBDeviceGlove::RecordingDoneAnimation ( FBAnimationNode pAnimationNode ) [virtual]

When recording, finish animation.

Parameters:
pAnimationNode Animation node to write information to.

Reimplemented from FBDevice.

void FBDeviceGlove::InitializeModelGeometry ( ) [protected]

Initialize the hand model geometry.

You should set the LeftHand property prior to using this method, so that the geometry gets initialized correctly. Also call this function if you changed the value of LeftHand property.

void FBDeviceGlove::VectorToModelPartAngle ( kHandModelPart  pPartIndex,
FBVector3d pVector 
) [protected]

Bring the vector in parameter to a valid angle range of rotation for a given part of the hand model.

The input vector should have relative values between 0.0 (min) and 1.0 (max). The output vector is an euler local rotation vector with limits applied. This vector can then be used to constraint the rotation of the hand part model.

Parameters:
pPartIndex The hand part.
pVector The vector to modify.
FBAnimationNode* FBDeviceGlove::GetModelRotationNode ( kHandModelPart  pPartIndex ) [protected]

Obtain the rotation animation node of a part of the hand model.

Parameters:
pPartIndex The hand part.
Returns:
The animation node of the given hand part.
virtual bool FBDevice::FBCreate ( ) [virtual, inherited]

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

Reimplemented in FBDeviceOptical, FBDeviceSync, and FBDeviceCamera.

virtual void FBDevice::FBDestroy ( ) [virtual, inherited]

Open Reality destruction function.

Reimplemented from FBComponent.

Reimplemented in FBDeviceOptical, FBDeviceSync, and FBDeviceCamera.

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.

Parameters:
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).
Returns:
A handle to the newly created animation node.

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.

Parameters:
pOperation Operation to have device perform.
Returns:
Current state : <b true if online.

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.

Parameters:
pMode Transport mode.
pTime Local time.
pSystem System time.
virtual void FBDevice::DeviceIONotify ( kDeviceIOs  pAction,
FBDeviceNotifyInfo pDeviceNotifyInfo 
) [virtual, inherited]

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:
pAction Different reading/writing actions for the device.
pDeviceNotifyInfo Access to the system and local time.

Reimplemented in FBDeviceOptical, and FBDeviceCamera.

virtual bool FBDevice::DeviceEvaluationNotify ( kTransportMode  pMode,
FBEvaluateInfo pEvaluateInfo 
) [virtual, inherited]

Real-Time engine thread: Output device evaluation.

Parameters:
pMode Transport mode.
pEvaluateInfo Access to the system and local time.
Returns:
true if successful.
virtual bool FBDevice::ModelTemplateBindNotify ( FBModel pModel,
int  pIndex,
FBModelTemplate pModelTemplate 
) [virtual, inherited]

Model Template binding notification callback.

Parameters:
pModel Model being bound to model template.
pIndex Index of model template where binding is occuring.
pModelTemplate Model being affected with binding.
Returns:
true if successful.

Reimplemented in FBDeviceCamera.

virtual bool FBDevice::ModelTemplateUnBindNotify ( int  pIndex,
FBModelTemplate pModelTemplate 
) [virtual, inherited]

Model Template unbinding notification callback.

Parameters:
pIndex Index in pModelTemplate where unbinding has occured.
pModelTemplate Model template from which binding is removed.
Returns:
true if successful.
FBModel* FBDevice::ModelBindingCreate ( ) [inherited]

Create a new model binding.

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

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

Return values:
pList List to add found models to.
virtual bool FBDevice::AnimationNodeNotify ( FBAnimationNode pAnimationNode,
FBEvaluateInfo pEvaluateInfo 
) [override, virtual, inherited]

Notification function for animation thread.

This function is called by the real-time engine in order to process animation information.

Parameters:
pAnimationNode Node containing the modified information.
pEvaluateInfo Information 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 const char* FBDevice::FbxGetObjectType ( ) [override, virtual, inherited]

Object Type "Device".

Reimplemented from FBBox.

virtual bool FBDevice::FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [override, virtual, inherited]

Storage/Retrieval of information into the FBX file format.

Parameters:
pFbxObject Object to interface with FBX file format.
pStoreWhat Attributes to store in FBX file.
Returns:
true if successful.

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical, FBDeviceSync, and FBDeviceCamera.

virtual bool FBDevice::FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [override, virtual, inherited]

Reimplemented from FBBox.

Reimplemented in FBDeviceOptical, FBDeviceSync, and FBDeviceCamera.

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.

Parameters:
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.

Parameters:
pEvaluateInfo Information concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.
virtual bool FBBox::AnimationNodeDestroy ( FBAnimationNode pAnimationNode ) [virtual, inherited]

Destroy an animation node.

Parameters:
pAnimationNode Handle to the animation node to be destroyed.
Returns:
true if destruction was successful.
virtual bool FBBox::AnimationNodeIsUserData ( FBAnimationNode pAnimationNode ) [virtual, inherited]

Is the animation node user data?

Parameters:
pAnimationNode Handle to the animation to be queried.
Returns:
true if node is user data.
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.

Parameters:
pEvaluateInfo Evaluation synchronization object (contains evaluation id).
Note:
This can be also done per individual AnimationNode -> FBAnimationNode::DisableIfNotWritten
virtual FBAnimationNode* FBBox::AnimationNodeInGet ( ) [virtual, inherited]

Get the (IN/OUT) animation node for this box.

Returns:
A handle to the 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]
Returns:
Internal class Id

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::SetHIObject ( HIObject  pObject,
bool  pSDKComponent 
) [override, virtual, inherited]

Assign component to an internal pointer.

Reimplemented from FBPlug.

virtual int FBComponent::PropertyAdd ( FBProperty pProperty ) [virtual, inherited]

Add a property to the component's property manager.

Parameters:
pProperty The property to add to the property manager.
Returns:
Index in the property array where property was inserted.
bool FBComponent::PropertyAddReferenceProperty ( FBProperty pReferenceProperty ) [inherited]

Add a reference property to the component's property manager.

Parameters:
pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).
Returns:
True if the reference property could be added.
void FBComponent::PropertyRemove ( FBProperty pProperty ) [inherited]

Remove a Property from the component's Property manager.

If the property was dynamically allocated, it is deleted.

Parameters:
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.

Parameters:
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.

Parameters:
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).

Returns:
Get all object flags in one call. Flags can be concatenated.
void FBComponent::SetObjectFlags ( FBObjectFlag  pFlags ) [inherited]

SetObjectFlags.

Parameters:
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.

Parameters:
pFlags Flags to check if they are present.
Returns:
True if all flags in pFlags are enabled.
void FBComponent::EnableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Enable a specific Object Flags.

Parameters:
pFlags Flags to enable.
void FBComponent::DisableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Disable a specific Object Flags.

Parameters:
pFlags Flags to disable.
void FBComponent::SetObjectStatus ( FBObjectStatus  pStatus,
bool  pValue 
) [inherited]

Enable/Disable a specific Object Status.

Parameters:
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.

Parameters:
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.

Parameters:
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.
Returns:
return true if process successful.
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.

Parameters:
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.
Returns:
return true if process successful.
virtual const char* FBComponent::ClassName ( ) [override, virtual, inherited]

Get the class name.

Returns:
The class name (i.e. "FBComponent").

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.

Returns:
False if to use internal corresponding object's viewSet of the parent class.

Definition at line 791 of file fbcomponent.h.

{ return true; }
const char* FBComponent::GetFullName ( void  ) [inherited]

Get the full name.

Returns:
the full name of the component.
void FBComponent::SetOwnerNamespace ( FBNamespace pOwnerNSObj ) [inherited]

Set the owner Namespace object.

FBNamespace* FBComponent::GetOwnerNamespace ( void  ) [inherited]

Get the owner Namespace object.

Returns:
the owner Namespace object
FBFileReference* FBComponent::GetOwnerFileReference ( void  ) [inherited]

Get the owner FileReference object.

Returns:
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.

Parameters:
pTypeId TypeId to compare object to.
Returns:
Result of the comparison.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual int FBComponent::GetTypeId ( ) [virtual, inherited]

GetTypeId( int pTypeId )

Returns:
The TypeInfo of the object

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.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDst ( FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
bool FBPlug::ConnectSrcAt ( int  pDst_SrcIndex,
FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
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.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDstAt ( int  pSrc_DstIndex,
FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
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.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectDst ( FBPlug pDst ) [inherited]

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrc ( FBPlug pSrc ) [inherited]

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrcAt ( int  pIndex ) [inherited]

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceDstAt ( int  pIndex,
FBPlug pDst 
) [inherited]

Replace a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceSrcAt ( int  pIndex,
FBPlug pSrc 
) [inherited]

Replace a source connection at a specified index.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::SwapSrc ( int  pIndexA,
int  pIndexB 
) [inherited]

Swap source connection at index A with source connection at index B.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::MoveSrcAt ( int  pIndex,
int  pAtIndex 
) [inherited]

Move source connection at pIndex to pAtIndex.

Parameters:
pIndex Plug current index.
pAtIndex Plug new index.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtIndex is untouched.
bool FBPlug::MoveSrcAt ( FBPlug pSrc,
FBPlug pAtSrc 
) [inherited]

Move source connection pSrc to the position of pAtSrc.

Parameters:
pSrc Plug.
pAtSrc Plug that mark where we want to insert (will insert before this one).
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtSrc is untouched.
int FBPlug::GetSrcCount ( ) [inherited]

Get source connection count.

Returns:
Total sources connections count.
FBPlug* FBPlug::GetSrc ( int  pIndex ) [inherited]

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
FBConnectionType FBPlug::GetSrcType ( int  pIndex ) [inherited]

Get a source connection's type at specified index.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
int FBPlug::GetDstCount ( ) [inherited]

Get destination connection count.

Returns:
Total destinations connections count.
FBPlug* FBPlug::GetDst ( int  pIndex ) [inherited]

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
FBConnectionType FBPlug::GetDstType ( int  pIndex ) [inherited]

Get a destination connection's type at specified index.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
bool FBPlug::BeginChange ( ) [inherited]

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
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.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
void FBPlug::SetContentModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's owned property/object's modification flag.

Parameters:
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.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
int FBPlug::GetPlugConnectionModifiedList ( FBPlugList pPlugList,
FBPlugModificationFlag  pConnectionModificatonFlag,
bool  pAddRemove 
) [inherited]

Get plug's modified src/dst property/object connection added/removed List.

Parameters:
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.
Returns:
count of list;
bool FBPlug::RevertModification ( FBPlugModificationFlag  pFlag = kFBAllModifiedMask ) [inherited]

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
void FBPlug::SetStatusFlag ( FBPlugStatusFlag  pStatus,
bool  pValue 
) [inherited]

Set the plug's status flag.

Parameters:
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.

Parameters:
pStatus bitwise AND of self modification flags.
Returns:
true if self changed
FBPlug* FBPlug::GetOwner ( ) [inherited]

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
FBPlug* FBPlug::GetOwned ( int  pIndex ) [inherited]

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
int FBPlug::GetOwnedCount ( ) [inherited]

Get the owned plug count.

Returns:
The owned plug count.
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.

Parameters:
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.
Returns:
unused should return true
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.

Parameters:
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.
Returns:
unused should return true except in the case of property rename kFBRename
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.

Parameters:
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).
Returns:
should by default return true except in the case of connection requests (kFBRequestConnectSrc or kFBRequestConnectDst)
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]

Friends And Related Function Documentation

friend class __FBDevice [friend, inherited]

Definition at line 900 of file fbcore.h.

friend class DataFBDeviceOptical [friend, inherited]

Definition at line 901 of file fbcore.h.

K_DLLIMPORT friend int __FBRegisterTypeInfo ( int  pInternalClassId ) [friend, inherited]

__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.


Member Data Documentation

Read Write Property: Left or right hand glove.

Definition at line 1028 of file fbcore.h.

Read Write Property: Icon filename.

Definition at line 861 of file fbcore.h.

Read Write Property: Device information: status.

Definition at line 862 of file fbcore.h.

Read Write Property: Device information: information.

Definition at line 863 of file fbcore.h.

Read Write Property: Device information: hardware version.

Definition at line 864 of file fbcore.h.

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 865 of file fbcore.h.

Read Write Property: Is online?

Definition at line 866 of file fbcore.h.

Event: Status of device changed.

Definition at line 868 of file fbcore.h.

Component: Root of model template structure.

Definition at line 870 of file fbcore.h.

FBPropertyModel FBDevice::ModelBindingRoot [inherited]

Component: Root of model currently binded model hierarchy.

Definition at line 871 of file fbcore.h.

FBPropertyDeviceSamplingMode FBDevice::SamplingMode [inherited]

Read Write Property: Mode to use to record device.

Definition at line 873 of file fbcore.h.

Read Write Property: Type of communications.

Definition at line 874 of file fbcore.h.

List: List of instruments.

Definition at line 876 of file fbcore.h.

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

Definition at line 878 of file fbcore.h.

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

Definition at line 879 of file fbcore.h.

const char* FBBox::UniqueName [inherited]

internal Unique name.

Definition at line 293 of file fbcore.h.

Read Write Property: Is the box animatable.

Definition at line 299 of file fbcore.h.

Read Write Property: Is live?

Definition at line 300 of file fbcore.h.

Read Write Property: Is recording?

Definition at line 301 of file fbcore.h.

DataFBComponent* FBComponent::mLocalPtr [inherited]

Handle on DataFBComponent.

Reimplemented in FBCustomManager.

Definition at line 650 of file fbcomponent.h.

FBString FBComponent::mName [protected, inherited]

Name of the component.

Definition at line 653 of file fbcomponent.h.

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.

Read Only Property: Manages all of the properties for the component.

Definition at line 838 of file fbcomponent.h.

List: List of components.

Reimplemented in FBScene, and FBPropertyInspector.

Definition at line 839 of file fbcomponent.h.

List: Parents.

Definition at line 840 of file fbcomponent.h.

Read Write Property: Selected property.

Definition at line 841 of file fbcomponent.h.

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.

Definition at line 842 of file fbcomponent.h.

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]

ClassGroupName of the object.

Definition at line 444 of file fbplug.h.

bool FBPlug::mAllocated [inherited]

Contain the Allocation State of the Component.

Definition at line 450 of file fbplug.h.

int FBPlug::mGlobalTypeInfo [static, protected, inherited]

Represente the Type Index.

Definition at line 500 of file fbplug.h.

HIObject FBPlug::mObject [protected, inherited]

Handle on the Plug.

Definition at line 502 of file fbplug.h.

bool FBPlug::mSDKComponent [protected, inherited]

bool Plug is an SDK component.

Definition at line 503 of file fbplug.h.


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