This reference page is linked to from the following overview topics: Skeleton mocap: deviceskeleton, Model templates.

Contains definitions for devices, boxes and models. More...

#include
<kaydaradef.h>

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbfbx.h>
#include <fbsdk/fbtime.h>
#include <fbsdk/fbdata.h>
#include <fbsdk/fbevaluateinfo.h>

Go to the source code of this file.

Classes
class	FBBox
	A box is a fundamental building block in the application architecture. More...
class	FBHandle
	FBHandle class. More...
class	FBPropertyListHandle
	PropertyList: Handle. More...
class	FBPropertyListModelTemplate
	PropertyList: ModelTemplate. More...
class	FBPropertyListModelTemplateBinding
	PropertyList: ModelTemplateBinding. More...
class	FBModelTemplate
	Model template class. More...
class	FBPropertyListDevice
	PropertyList: Device More...
class	FBDeviceNotifyInfo
	Device Input and Output Notification information structure. More...
class	FBDeviceInstrument
	Instrument abstraction layer. More...
class	FBPropertyListDeviceInstrument
	List of instruments. More...
class	FBDevice
	Base Device class. More...
class	FBDeviceGlove
	Base Glove class. More...
class	FBDeviceGlove::GloveChannel
	Base GloveChannel. More...
Defines
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FBBoxDeclare(ClassName, Parent)
	Box declaration.
#define	FBBoxImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Box implementation.
#define	FBDeviceDeclare(ClassName, Parent)
	Device declaration.
#define	FBDeviceImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Device implementation.
#define	FBRegisterBox(UniqueNameStr, ClassName, FolderName, Label, Description, IconFilename)
	Register a box class.
#define	FBRegisterDevice(UniqueNameStr, ClassName, Label, Description, IconFilename)
	Register a device class.
#define	FBRegisterOnlineDevice(UniqueNameStr, ClassName, Label, Description, IconFilename)
	Register an online device class.
Typedefs
typedef HIObject(*	kFBObjectCreatorFnc )(HIObject pOwner, char pName, void pData)
typedef class FBSDK_DLL FBPropertyBaseList < HFBAnimationNode >	FBPropertyBaseListModelTemplateBinding
	typedef class FBSDK_DLL FBPropertyBaseList< HFBAnimationNode > FBPropertyBaseListModelTemplateBinding
Enumerations
enum	FBModelTemplateStyle { kFBModelTemplateNone, kFBModelTemplateNull, kFBModelTemplateMarker, kFBModelTemplateRoot, kFBModelTemplateSensor, kFBModelTemplateSkeleton, kFBModelTemplateCamera, kFBModelTemplateGeometry, kFBModelTemplateCameraInterest, kFBModelTemplateLight, kFBModelTemplateOptical }
	Model template styles When creating model templates, this parameter will affect the actual model created (associated with the model template). More...
enum	FBDeviceSamplingMode { kFBHardwareTimestamp, kFBHardwareFrequency, kFBAutoFrequency, kFBSoftwareTimestamp }
	Recording types. More...
enum	FBCommType { kFBCommTypeNone = 0, kFBCommTypeSerial = 1<<0, kFBCommTypeNetworkTCP = 1<<1, kFBCommTypeNetworkUDP = 1<<2, kFBCommTypeSharedMemory = 1<<3, kFBCommTypeSimulator = 1<<4, kFBCommTypeOther = 1<<5 }
	Communications type. More...
Functions
	FB_DEFINE_COMPONENT (FBSDK_DLL, ModelTemplate)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Device)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Path3D)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Scene)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Model)
	__FB_FORWARD (FBBox)
	FB_FORWARD (FBFbxObject)
	__FB_FORWARD (FBHandle)
	FB_DEFINE_LIST (FBSDK_DLL, Handle)
	FB_FORWARD (FBPropertyListHandle)
	__FB_FORWARD (FBModelTemplate)
	__FB_FORWARD (FBPropertyListModelTemplate)
	FB_DEFINE_LIST (FBSDK_DLL, ModelTemplate)
	__FB_FORWARD (FBModelTemplateBinding)
	__FB_FORWARD (FBPropertyListModelTemplateBinding)
	__FB_FORWARD (FBDevice)
	__FB_FORWARD (FBPropertyListDevice)
	FB_FORWARD (FBDeviceNotifyInfo)
	__FB_FORWARD (FBDeviceInstrument)
	FB_DEFINE_COMPONENT (FBSDK_DLL, DeviceInstrument)
	__FB_FORWARD (FBPropertyListDeviceInstrument)
	FB_DEFINE_LIST (FBSDK_DLL, DeviceInstrument)
	FB_DEFINE_ENUM (FBSDK_DLL, DeviceSamplingMode)
	__FB_FORWARD (FBDeviceGlove)

Detailed Description

Contains definitions for devices, boxes and models.

Definition in file fbcore.h.

Define Documentation

#define FBSDK_DLL K_DLLIMPORT

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbcore.h.

#define FBBoxDeclare	(	ClassName,
		Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent ); \
  public: \
  ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

Box declaration.

Parameters:

ClassName	Name of box class.
Parent	Parent class of ClassName.

Definition at line 90 of file fbcore.h.

#define FBBoxImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Search for all occurrences

Box implementation.

Parameters:

ThisComponent Name of box class to implement.

Definition at line 99 of file fbcore.h.

#define FBDeviceDeclare	(	ClassName,
		Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent ); \
  public: \
    ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

Device declaration.

Parameters:

ClassName	Name of device class.
Parent	Parent class of ClassName.

Definition at line 106 of file fbcore.h.

#define FBDeviceImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Search for all occurrences

Device implementation.

Parameters:

ThisComponent Name of device class to implement.

Definition at line 115 of file fbcore.h.

#define FBRegisterBox	(	UniqueNameStr,
		ClassName,
		FolderName,
		Label,
		Description,
		IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterBox##ClassName##Create( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName(pName); \
        Class->mAllocated = true; \
        Class->UniqueName = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
\
    FBLibraryModule( ClassName )    \
    {\
        FBRegisterObject(ClassName##R1,"Boxes",UniqueNameStr,Description,RegisterBox##ClassName##Create,true, IconFilename );\
        FBRegisterObject(ClassName##R2,"Boxes/Functions/"FolderName,Label,Description,RegisterBox##ClassName##Create,true, IconFilename );\
        FBRegisterObject(ClassName##R3,"FbxStorable/Box",UniqueNameStr,Description,RegisterBox##ClassName##Create,true, IconFilename ); \
    }

Register a box class.

Parameters:

UniqueNameStr	Unique name of class.
ClassName	Name of box class.
FolderName	Directory structure within the application.
Label	Short description.
Description	Long description.
IconFilename	Name of the file containing the icon.

Definition at line 129 of file fbcore.h.

#define FBRegisterDevice	(	UniqueNameStr,
		ClassName,
		Label,
		Description,
		IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterDevice##ClassName##Create( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName(pName); \
        Class->mAllocated = true; \
        Class->UniqueName = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
\
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject(ClassName##R1,"Boxes/Devices",Label,Description,RegisterDevice##ClassName##Create,true, IconFilename );\
        FBRegisterObject(ClassName##R2,"FbxStorable/Device",UniqueNameStr,Description,RegisterDevice##ClassName##Create,true, IconFilename ); \
    }

Register a device class.

Parameters:

UniqueNameStr	Unique name of class.
ClassName	Name of device class.
Label	Short description.
Description	Long description.
IconFilename	Name of the file containing the icon.

Definition at line 157 of file fbcore.h.

#define FBRegisterOnlineDevice	(	UniqueNameStr,
		ClassName,
		Label,
		Description,
		IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterDevice##ClassName##Create( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName(pName); \
        Class->mAllocated = true; \
        Class->UniqueName = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
\
    FBLibraryModule( ClassName )    \
    {   \
        if( FBGetLicense() >= kFBLicenseOnline )    \
        {   \
            FBRegisterObject(ClassName##R1,"Boxes/Devices",Label,Description,RegisterDevice##ClassName##Create, true, IconFilename );\
            FBRegisterObject(ClassName##R2,"FbxStorable/Device",UniqueNameStr,Description,RegisterDevice##ClassName##Create, true, IconFilename ); \
        }   \
    }

Register an online device class.

Parameters:

UniqueNameStr	Unique name of class.
ClassName	Name of device class.
Label	Short description.
Description	Long description.
IconFilename	Name of the file containing the icon.

Definition at line 184 of file fbcore.h.

Typedef Documentation

kFBObjectCreatorFnc

Search for all occurrences

Parameters:

pOwner	Object that own this new object
pName	Name of the object
pData	Data put in the object

Definition at line 81 of file fbcore.h.

typedef class FBSDK_DLL FBPropertyBaseList< HFBAnimationNode > FBPropertyBaseListModelTemplateBinding

Search for all occurrences

typedef class FBSDK_DLL FBPropertyBaseList< HFBAnimationNode > FBPropertyBaseListModelTemplateBinding

Definition at line 409 of file fbcore.h.

Enumeration Type Documentation

enum FBModelTemplateStyle

Search for all occurrences

Model template styles When creating model templates, this parameter will affect the actual model created (associated with the model template).

Enumerator:

kFBModelTemplateNone	No style. Search for all occurrences
kFBModelTemplateNull	Null. Search for all occurrences
kFBModelTemplateMarker	Marker. Search for all occurrences
kFBModelTemplateRoot	Root (3 axes). Search for all occurrences
kFBModelTemplateSensor	Yellow magnetic sensor. Search for all occurrences
kFBModelTemplateSkeleton	Skeleton limb. Search for all occurrences
kFBModelTemplateCamera	Camera. Search for all occurrences
kFBModelTemplateGeometry	Generic geometry. Search for all occurrences
kFBModelTemplateCameraInterest	Camera interest. Search for all occurrences
kFBModelTemplateLight	Light. Search for all occurrences
kFBModelTemplateOptical	Optical model (not supported yet). Search for all occurrences

Definition at line 452 of file fbcore.h.

                          { 
    kFBModelTemplateNone,               
    kFBModelTemplateNull,               
    kFBModelTemplateMarker,             
    kFBModelTemplateRoot,               
    kFBModelTemplateSensor,             
    kFBModelTemplateSkeleton,           
    kFBModelTemplateCamera,             
    kFBModelTemplateGeometry,           
    kFBModelTemplateCameraInterest,     
    kFBModelTemplateLight,              
    kFBModelTemplateOptical             
 };

enum FBDeviceSamplingMode

Search for all occurrences

Recording types.

The different values for this will control the way the keys are added when the device is being recorded. There are four different types of recording keys for devices:

Hardware Timestamping. This case is when the hardware provides timestamps with each packet.
Hardware Frequency. The hardware is guaranteed to provide packets at a given frequency.
Auto Frequency Packets are coming in at a fixed, unknown frequency. The recorded data will be resampled to be equidistant.
Software Timestamping. The application will provide a timestamp for each packet depending on when it receives the data.

Enumerator:

kFBHardwareTimestamp	Device supplies timestamp. Search for all occurrences
kFBHardwareFrequency	Device is running at known, fixed frequency. Search for all occurrences
kFBAutoFrequency	Device is running at unknown, fixed frequency. Search for all occurrences
kFBSoftwareTimestamp	The software will timestamp packets as they arrive. Search for all occurrences

Definition at line 654 of file fbcore.h.

                            { 
    kFBHardwareTimestamp,       
    kFBHardwareFrequency,       
    kFBAutoFrequency,           
    kFBSoftwareTimestamp        
};

enum FBCommType

Search for all occurrences

Communications type.

Different base types of communications. There is always the 'other' type in order to use another type of communication.

Enumerator:

kFBCommTypeNone	A non-communicating device. Search for all occurrences
kFBCommTypeSerial	Serial communications. Search for all occurrences
kFBCommTypeNetworkTCP	Network (TCP) device. Search for all occurrences
kFBCommTypeNetworkUDP	Network (UDP) device. Search for all occurrences
kFBCommTypeSharedMemory	Accessing shared memory. Search for all occurrences
kFBCommTypeSimulator	Software simulator. Search for all occurrences
kFBCommTypeOther	Any other type of communications. Search for all occurrences

Definition at line 666 of file fbcore.h.

                {
    kFBCommTypeNone         = 0,        
    kFBCommTypeSerial       = 1<<0,     
    kFBCommTypeNetworkTCP   = 1<<1,     
    kFBCommTypeNetworkUDP   = 1<<2,     
    kFBCommTypeSharedMemory = 1<<3,     
    kFBCommTypeSimulator    = 1<<4,     
    kFBCommTypeOther        = 1<<5      
};

Function Documentation

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		ModelTemplate
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Device
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Path3D
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Scene
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Model
	)

Search for all occurrences

__FB_FORWARD ( FBBox )

Search for all occurrences

FB_FORWARD ( FBFbxObject )

Search for all occurrences

__FB_FORWARD ( FBHandle )

Search for all occurrences

FB_DEFINE_LIST	(	FBSDK_DLL	,
		Handle
	)

Search for all occurrences

FB_FORWARD ( FBPropertyListHandle )

Search for all occurrences

__FB_FORWARD ( FBModelTemplate )

Search for all occurrences

__FB_FORWARD ( FBPropertyListModelTemplate )

Search for all occurrences

FB_DEFINE_LIST	(	FBSDK_DLL	,
		ModelTemplate
	)

Search for all occurrences

__FB_FORWARD ( FBModelTemplateBinding )

Search for all occurrences

__FB_FORWARD ( FBPropertyListModelTemplateBinding )

Search for all occurrences

__FB_FORWARD ( FBDevice )

Search for all occurrences

__FB_FORWARD ( FBPropertyListDevice )

Search for all occurrences

FB_FORWARD ( FBDeviceNotifyInfo )

Search for all occurrences

__FB_FORWARD ( FBDeviceInstrument )

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		DeviceInstrument
	)

Search for all occurrences

__FB_FORWARD ( FBPropertyListDeviceInstrument )

Search for all occurrences

FB_DEFINE_LIST	(	FBSDK_DLL	,
		DeviceInstrument
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		DeviceSamplingMode
	)

Search for all occurrences

__FB_FORWARD ( FBDeviceGlove )

Search for all occurrences

fbcore.h File Reference

Classes

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation