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

File Description

Contains definitions for devices, boxes and models.

Definition in file fbcore.h.

Classes
class	FBBox
	A box is a fundamental building block in the application architecture. More...

class	FBHandle
	FBHandle class exposes the Handle object of the application. 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	FBSyncReference
	Application sync. More...

class	FBDevice
	Base Device class. Cannot be instantiated from Python. More...

class	FBDeviceGlove
	Base Glove class. More...

class	FBDeviceGlove::GloveChannel
	Base GloveChannel. More...

Namespaces
	ORSDK2018

Macros
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...

#define	FBBoxDeclare(ClassName, Parent)
	Box declaration. More...

#define	FBBoxImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Box implementation. More...

#define	FBDeviceDeclare(ClassName, Parent)
	Device declaration. More...

#define	FBDeviceImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Device implementation. More...

#define	FBRegisterBox(UniqueNameStr, ClassName, FolderName, Label, Description, IconFilename)
	Register a box class. More...

#define	FBRegisterDevice(UniqueNameStr, ClassName, Label, Description, IconFilename)
	Register a device class. More...

#define	FBRegisterOnlineDevice(UniqueNameStr, ClassName, Label, Description, IconFilename)
	Register an online device class. More...

Typedefs
typedef class FBPropertyBase< FBModelTemplate *, kFBPT_object >	FBPropertyBaseModelTemplate

typedef class FBPropertyBaseComponent< FBModelTemplate * >	FBPropertyModelTemplate

typedef class FBPropertyBase< FBDevice *, kFBPT_object >	FBPropertyBaseDevice

typedef class FBPropertyBaseComponent< FBDevice * >	FBPropertyDevice

typedef class FBPropertyBase< FBPath3D *, kFBPT_object >	FBPropertyBasePath3D

typedef class FBPropertyBaseComponent< FBPath3D * >	FBPropertyPath3D

typedef class FBPropertyBase< FBScene *, kFBPT_object >	FBPropertyBaseScene

typedef class FBPropertyBaseComponent< FBScene * >	FBPropertyScene

typedef class FBPropertyBase< FBModel *, kFBPT_object >	FBPropertyBaseModel

typedef class FBPropertyBaseComponent< FBModel * >	FBPropertyModel

typedef HIObject(*	kFBObjectCreatorFnc) (HIObject pOwner, const char pName, void pData)

typedef class FBPropertyBaseList< FBHandle * >	FBPropertyBaseListHandle

typedef class FBPropertyBaseList< FBModelTemplate * >	FBPropertyBaseListModelTemplate

typedef class FBPropertyBaseList< FBAnimationNode * >	FBPropertyBaseListModelTemplateBinding
	typedef class FBSDK_DLL FBPropertyBaseList< FBAnimationNode* > FBPropertyBaseListModelTemplateBinding More...

typedef class FBPropertyBase< FBDeviceInstrument *, kFBPT_object >	FBPropertyBaseDeviceInstrument

typedef class FBPropertyBaseComponent< FBDeviceInstrument * >	FBPropertyDeviceInstrument

typedef class FBPropertyBaseList< FBDeviceInstrument * >	FBPropertyBaseListDeviceInstrument

typedef class FBPropertyBase< FBSyncReference *, kFBPT_object >	FBPropertyBaseSyncReference

typedef class FBPropertyBaseComponent< FBSyncReference * >	FBPropertySyncReference

typedef class FBPropertyBaseEnum< enum FBDeviceSamplingMode >	FBPropertyDeviceSamplingMode

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

Macro Definition Documentation

#define FBBoxDeclare	(	ClassName,
		Parent
	)

Value:

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

Box declaration.

Parameters

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

Examples:: boxes/box_template/orbox_template_box.h, boxes/boxhmfstotc/orboxhmsftotc_box.h, boxes/boxquaternion/orboxquaternion_box.h, boxes/boxsineramp/orboxsineramp_box.h, boxes/boxtransport/orboxtransport_box.h, and boxes/boxvector/orboxvector_box.h.

Definition at line 90 of file fbcore.h.

#define FBBoxImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Box implementation.

Parameters

ThisComponent Name of box class to implement.

Examples:: boxes/box_template/orbox_template_box.cxx, boxes/boxhmfstotc/orboxhmsftotc_box.cxx, boxes/boxquaternion/orboxquaternion_box.cxx, boxes/boxsineramp/orboxsineramp_box.cxx, boxes/boxtransport/orboxtransport_box.cxx, and boxes/boxvector/orboxvector_box.cxx.

Definition at line 99 of file fbcore.h.

#define FBDeviceDeclare	(	ClassName,
		Parent
	)

Value:

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

Device declaration.

Parameters

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

Examples:: devices/device_syncreference/ordevice_syncreference_device.h, devices/device_template/ordevice_template_device.h, devices/devicecamera/ordevicecamera_device.h, devices/deviceinput/ordeviceinput_device.h, devices/devicemocap/ordevicemocap_device.h, devices/deviceoptical/ordeviceoptical_device.h, devices/deviceopticalhybrid/ordeviceopticalhybrid_device.h, devices/deviceoutput/ordeviceoutput_device.h, devices/devicereclist/ordevicereclist_device.h, devices/deviceskeleton/ordeviceskeleton_device.h, devices/devicesync/ordevicesync_device.h, devices/devicetimecode/ordeviceTimeCode_device.h, devices/devicevideo/ordevicevideo_device.h, and importexport/impexpdevice/orimpexpdevice_device.h.

Definition at line 106 of file fbcore.h.

#define FBDeviceImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Device implementation.

Parameters

ThisComponent Name of device class to implement.

Examples:: devices/device_syncreference/ordevice_syncreference_device.cxx, devices/device_template/ordevice_template_device.cxx, devices/devicecamera/ordevicecamera_device.cxx, devices/deviceinput/ordeviceinput_device.cxx, devices/devicemocap/ordevicemocap_device.cxx, devices/deviceoptical/ordeviceoptical_device.cxx, devices/deviceopticalhybrid/ordeviceopticalhybrid_device.cxx, devices/deviceoutput/ordeviceoutput_device.cxx, devices/devicereclist/ordevicereclist_device.cxx, devices/deviceskeleton/ordeviceskeleton_device.cxx, devices/devicesync/ordevicesync_device.cxx, devices/devicetimecode/ordeviceTimeCode_device.cxx, devices/devicevideo/ordevicevideo_device.cxx, and importexport/impexpdevice/orimpexpdevice_device.cxx.

Definition at line 115 of file fbcore.h.

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

Value:

HIObject RegisterBox##ClassName##Create( HIObject /*pOwner*/,const 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.

Examples:: boxes/box_template/orbox_template_box.cxx, boxes/boxhmfstotc/orboxhmsftotc_box.cxx, boxes/boxquaternion/orboxquaternion_box.cxx, boxes/boxsineramp/orboxsineramp_box.cxx, boxes/boxtransport/orboxtransport_box.cxx, and boxes/boxvector/orboxvector_box.cxx.

Definition at line 129 of file fbcore.h.

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

Value:

HIObject RegisterDevice##ClassName##Create( HIObject /*pOwner*/,const 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.

Examples:: devices/device_syncreference/ordevice_syncreference_device.cxx, devices/device_template/ordevice_template_device.cxx, devices/devicecamera/ordevicecamera_device.cxx, devices/deviceinput/ordeviceinput_device.cxx, devices/devicemocap/ordevicemocap_device.cxx, devices/deviceoptical/ordeviceoptical_device.cxx, devices/deviceopticalhybrid/ordeviceopticalhybrid_device.cxx, devices/deviceoutput/ordeviceoutput_device.cxx, devices/devicereclist/ordevicereclist_device.cxx, devices/deviceskeleton/ordeviceskeleton_device.cxx, devices/devicesync/ordevicesync_device.cxx, devices/devicetimecode/ordeviceTimeCode_device.cxx, devices/devicevideo/ordevicevideo_device.cxx, and importexport/impexpdevice/orimpexpdevice_device.cxx.

Definition at line 157 of file fbcore.h.

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

Value:

HIObject RegisterDevice##ClassName##Create( HIObject /*pOwner*/,const 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.

#define FBSDK_DLL K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbcore.h.

Go to the source code of this file.

fbsdk/fbcore.h File Reference

File Description

Classes

Namespaces

Macros

Typedefs

Enumerations

Macro Definition Documentation