Properties are callback variables that insert a layer of abstraction between the internal objects and the software development kit.
Definition in file fbproperties.h.
#include <kaydaradef.h>
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <fbsdk/fbplug.h>
#include <fbsdk/fbarray.h>
#include <fbsdk/fbstring.h>
#include <fbsdk/fbtime.h>
#include <fbsdk/fbevaluateinfo.h>
Go to the source code of this file.
Classes |
|
class | FBProperty |
Property: Base property class.
More... |
|
class | FBPropertyEvent |
PropertyEvent: Base event class.
More... |
|
class | FBPropertyEventUIIdle |
PropertyEvent: UI idle event.
More... |
|
class | FBPropertyEventConnectionNotify |
PropertyEvent: Global
ConnectionNotify event. More... |
|
class | FBPropertyEventConnectionDataNotify |
PropertyEvent: Global
ConnectionDataNotify event. More... |
|
class | FBPropertyEventConnectionStateNotify |
PropertyEvent: Global
ConnectionStateNotify event. More... |
|
class | FBPropertyBase |
class | FBPropertyBaseEnum |
class | FBPropertyBasicList |
class | FBPropertyBaseList |
class | FBPropertyStringList |
Property: StringList More... |
|
class | FBPropertyManager |
Property Manager. More... |
|
class | FBPropertyBaseComponent |
class | FBPropertyAction |
Property: Action More... |
|
class | FBPropertyAnimatable |
Animatable property base class. More... |
|
class | FBPropertyBaseAnimatable |
class | FBPropertyBaseAnimatableEnum |
Defines |
|
#define | FBSDK_DLL K_DLLIMPORT |
Be sure that FBSDK_DLL is defined only once.
|
|
#define | FB_DEFINE_COMPONENT(DllTag, Type) |
Define a component and give it the ability
to be a property. |
|
#define | FB_DEFINE_ENUM(DllTag, Type) typedef class DllTag FBPropertyBaseEnum< enum FB##Type > FBProperty##Type; |
Define an enum and give it the ability to be
a property. |
|
#define | FB_DEFINE_LIST(DllTag, Type) typedef class DllTag FBPropertyBaseList< HFB##Type > FBPropertyBaseList##Type; |
Define a component list. |
|
#define | FBImplementPropertyComponent(DllTag, Type) |
Implement a property based on a component.
|
|
#define | FBImplementPropertyEnum(DllTag, Type) template class DllTag FBSDKNamespaceFunc(FBPropertyBaseEnum)< enum FB##Type > |
Implement a property based on an
enumeration. |
|
#define | FBImplementPropertyList(DllTag, Type) template class DllTag FBSDKNamespaceFunc(FBPropertyBaseList) < HFB##Type > |
Implement a property list for a component.
|
|
#define | FBPropertyInit(Param, Type, PropName, Get, Set) |
Initialize a property: default. |
|
#define | FBPropertyInitList(Param, PropName) |
Initialize a property: list. |
|
#define | FBPropertyInitStringList(Param, PropName) |
Initialize a property: string list. |
|
#define | FBPropertyInitEvent(Param, Type, SubType, PropName) |
Initialize a property: event. |
|
#define | FBPropertyInitEventGlobal(GlobalEventName, PropName) |
Initialize a property: global event.
|
|
#define | FBPropertyInitInternal(Parent, PropName, MBProperty) |
Mapping to internal properties. |
|
#define | FBPropertyInitInternalEnum(Param, Type, PropName, MBProperty, Get, Set) |
Mapping to internal enum properties.
|
|
#define | FBPropertyPublish(Parent, Prop, PropName, Get, Set) |
Publish a property. |
|
Typedefs |
|
typedef void(* | fbGetSetHandler )(void) |
function pointer |
|
typedef void(* | fbExternalGetSetHandler )(HIObject pObject) |
function pointer |
|
typedef class K_DLLIMPORT FBPropertyBaseEnum < enum kDefaultEnum > |
FBPropertyEnum |
A typedef Definition. |
|
typedef class K_DLLIMPORT FBPropertyBase< char *, kFBPT_charptr > |
FBPropertyString |
Property class: char * (String).
|
|
typedef class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > |
FBPropertyBool |
Property: bool |
|
typedef class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > |
FBPropertyInt |
Property: int |
|
typedef class K_DLLIMPORT FBPropertyBase< long long, kFBPT_int64 > |
FBPropertyInt64 |
Property: int |
|
typedef class K_DLLIMPORT FBPropertyBase < unsigned long long, kFBPT_uint64 > |
FBPropertyUInt64 |
Property: int |
|
typedef class K_DLLIMPORT FBPropertyBase < double, kFBPT_double > |
FBPropertyDouble |
Property: double |
|
typedef class K_DLLIMPORT FBPropertyBase < float, kFBPT_float > |
FBPropertyFloat |
Property: float |
|
typedef class K_DLLIMPORT FBPropertyBase < FBTime, kFBPT_Time > |
FBPropertyTime |
Property: FBTime
|
|
typedef class K_DLLIMPORT FBPropertyBase < FBTimeSpan, kFBPT_TimeSpan > |
FBPropertyTimeSpan |
Property: FBTimeSpan
|
|
typedef class K_DLLIMPORT FBPropertyBase < kReference, kFBPT_kReference > |
FBPropertykReference |
Property: kReference |
|
typedef class K_DLLIMPORT FBPropertyBase < HFBProperty, kFBPT_Reference > |
FBPropertyReference |
Property: FBProperty * |
|
typedef class K_DLLIMPORT FBPropertyBase < HFBComponent, kFBPT_object > |
_FBPropertyBaseComponent |
Property:
FBPropertyBase(HFBComponent) |
|
typedef class K_DLLIMPORT FBPropertyBaseComponent < HFBComponent > |
FBPropertyComponent |
Property:
FBPropertyBaseComponent(HFBComponent) |
|
typedef FBPropertyComponent * |
HFBPropertyComponent |
Property: FBPropertyComponent
|
|
typedef class K_DLLIMPORT FBPropertyBase < HFBPlug, kFBPT_object > |
_FBPropertyBasePlug |
Property: FBPropertyBase(HFBPlug)
|
|
typedef class FBPropertyBaseComponent < HFBPlug > |
FBPropertyPlug |
Property:
FBPropertyBaseComponent(HFBPlug) |
|
typedef FBPropertyPlug * | HFBPropertyPlug |
Property: FBPropertyPlug |
|
typedef class K_DLLIMPORT FBPropertyBase < FBColor, kFBPT_ColorRGB > |
FBPropertyColor |
FBPropertyColor type definition. |
|
typedef class K_DLLIMPORT FBPropertyBase < FBColorAndAlpha, kFBPT_ColorRGBA > |
FBPropertyColorAndAlpha |
FBPropertyColorAndAlpha type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBase < FBVector2d, kFBPT_Vector2D > |
FBPropertyVector2d |
FBPropertyVector2d type definition. |
|
typedef class K_DLLIMPORT FBPropertyBase < FBVector3d, kFBPT_Vector3D > |
FBPropertyVector3d |
FBPropertyVector3d type definition. |
|
typedef class K_DLLIMPORT FBPropertyBase < FBVector4d, kFBPT_Vector4D > |
FBPropertyVector4d |
FBPropertyVector4d type definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < bool, kFBPT_Action > |
FBPropertyAnimatableAction |
FBPropertyAnimatableAction type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < bool, kFBPT_bool > |
FBPropertyAnimatableBool |
FBPropertyAnimatableBool type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < int, kFBPT_int > |
FBPropertyAnimatableInt |
FBPropertyAnimatableInt type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < long long, kFBPT_int64 > |
FBPropertyAnimatableInt64 |
FBPropertyAnimatableInt64 type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < unsigned long long, kFBPT_uint64 > |
FBPropertyAnimatableUInt64 |
FBPropertyAnimatableUInt64 type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < int, kFBPT_enum > |
FBPropertyAnimatableEnum |
FBPropertyBaseAnimatableEnum
type definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < double, kFBPT_double > |
FBPropertyAnimatableDouble |
FBPropertyBaseAnimatableDouble type
definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < FBTime, kFBPT_Time > |
FBPropertyAnimatableTime |
FBPropertyBaseAnimatableTime type
definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < FBVector2d, kFBPT_Vector2D > |
FBPropertyAnimatableVector2d |
FBPropertyAnimatableVector2D type
definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < FBVector3d, kFBPT_Vector3D > |
FBPropertyAnimatableVector3d |
FBPropertyAnimatableVector3D type
definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < FBVector4d, kFBPT_Vector4D > |
FBPropertyAnimatableVector4d |
FBPropertyAnimatableVector4D type
definition. |
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < FBColor, kFBPT_ColorRGB > |
FBPropertyAnimatableColor |
FBPropertyAnimatableColor type definition.
|
|
typedef class K_DLLIMPORT FBPropertyBaseAnimatable < FBColorAndAlpha, kFBPT_ColorRGBA > |
FBPropertyAnimatableColorAndAlpha |
FBPropertyAnimatableColorAndAlpha type
definition. |
|
Enumerations |
|
enum | FBPropertyType
{ kFBPT_unknown, kFBPT_int, kFBPT_int64, kFBPT_uint64, kFBPT_bool, kFBPT_float, kFBPT_double, kFBPT_charptr, kFBPT_enum, kFBPT_Time, kFBPT_object, kFBPT_event, kFBPT_stringlist, kFBPT_Vector4D, kFBPT_Vector3D, kFBPT_ColorRGB, kFBPT_ColorRGBA, kFBPT_Action, kFBPT_Reference, kFBPT_TimeSpan, kFBPT_kReference, kFBPT_Vector2D } |
Property types. More... |
|
enum | FBPropertyFlag
{ kFBPropertyFlagNotSet = 0, kFBPropertyFlagHideProperty = (1 << 0), kFBPropertyFlagForceStaticProperty = (1 << 1), kFBPropertyFlagDisableProperty = (1 << 2), kFBPropertyFlagAnimated = (1 << 3), kFBPropertyFlagNotSavable = (1 << 4), kFBPropertyFlagReadOnly = (1 << 5), kFBPropertyFlagNotUserDeletable = (1 << 6) } |
Available flags for FBProperty objects. More... |
|
enum | kDefaultEnum { kDefaultItemNone } |
Patch to use the base enum for casting
values . More... |
#define FB_DEFINE_COMPONENT | ( | DllTag, | |||
Type | ) |
Value:
class FB##Type; typedef FB##Type *HFB##Type; \ typedef class DllTag FBPropertyBase< HFB##Type,kFBPT_object > FBPropertyBase##Type; \ typedef class DllTag FBPropertyBaseComponent< HFB##Type > FBProperty##Type
DllTag | Associated DLL. | |
Type | Component to register as a property. |
Definition at line 124 of file fbproperties.h.
#define FB_DEFINE_ENUM | ( | DllTag, | |||
Type | ) | typedef class DllTag FBPropertyBaseEnum< enum FB##Type > FBProperty##Type; |
Define an enum and give it the ability to be a property.
DllTag | Associated DLL. | |
Type | Enum to register as a property. |
Definition at line 133 of file fbproperties.h.
#define FB_DEFINE_LIST | ( | DllTag, | |||
Type | ) | typedef class DllTag FBPropertyBaseList< HFB##Type > FBPropertyBaseList##Type; |
Define a component list.
DllTag | Associated DLL. | |
Type | Component to use as a list item. |
Definition at line 140 of file fbproperties.h.
#define FBImplementPropertyComponent | ( | DllTag, | |||
Type | ) |
Value:
template class DllTag FBSDKNamespaceFunc(FBPropertyBase)< HFB##Type,kFBPT_object >; \ template class DllTag FBSDKNamespaceFunc(FBPropertyBaseComponent)< HFB##Type >;
DllTag | Associated DLL. | |
Type | Class to implement. |
Definition at line 1096 of file fbproperties.h.
#define FBImplementPropertyEnum | ( | DllTag, | |||
Type | ) | template class DllTag FBSDKNamespaceFunc(FBPropertyBaseEnum)< enum FB##Type > |
Implement a property based on an enumeration.
DllTag | Associated DLL. | |
Type | Class to implement. |
Definition at line 1108 of file fbproperties.h.
#define FBImplementPropertyList | ( | DllTag, | |||
Type | ) | template class DllTag FBSDKNamespaceFunc(FBPropertyBaseList) < HFB##Type > |
Implement a property list for a component.
DllTag | Associated DLL. | |
Type | Class to implement list for. |
Definition at line 1119 of file fbproperties.h.
#define FBPropertyInit | ( | Param, | |||
Type, | |||||
PropName, | |||||
Get, | |||||
Set | ) |
Value:
{ \ PropertyAdd(PropName.Init( (void*)Param,#PropName,(Type (*)(void *))Get,(void (*)(void *,Type))Set )); \ }
Param | Owner name. | |
Type | Type of variable. | |
PropName | Variable name. | |
Get | Get function pointer. | |
Set | Set function pointer. |
Definition at line 1194 of file fbproperties.h.
#define FBPropertyInitEvent | ( | Param, | |||
Type, | |||||
SubType, | |||||
PropName | ) |
Value:
{ \
PropertyAdd(PropName.Init( this, IQ(Param,IRegister),#PropName,Type,SubType )); \
}
Param | Owner name. | |
Type | Event Type. | |
SubType | Event SubType. | |
PropName | Variable name. |
Definition at line 1223 of file fbproperties.h.
#define FBPropertyInitEventGlobal | ( | GlobalEventName, | |||
PropName | ) |
Value:
{ \ PropertyAdd(PropName.InitGlobal( #PropName,GlobalEventName )); \ }
GlobalEventName | Name of the global eventEvent Type. | |
PropName | Variable name. |
Definition at line 1232 of file fbproperties.h.
#define FBPropertyInitInternal | ( | Parent, | |||
PropName, | |||||
MBProperty | ) |
Value:
{\ PropertyAdd(PropName.InitInternal( MBProperty ));\ }
Definition at line 1238 of file fbproperties.h.
#define FBPropertyInitInternalEnum | ( | Param, | |||
Type, | |||||
PropName, | |||||
MBProperty, | |||||
Get, | |||||
Set | ) |
Value:
{\ PropName.InitInternal( MBProperty ); \ PropertyAdd(PropName.Init( (void*)Param,#PropName,(Type (*)(void *))Get,(void (*)(void *,Type))Set )); \ }
Definition at line 1244 of file fbproperties.h.
#define FBPropertyInitList | ( | Param, | |||
PropName | ) |
Value:
{ \ PropertyAdd(PropName.Init( Param,#PropName )); \ }
Param | Owner name. | |
PropName | Variable name. |
Definition at line 1203 of file fbproperties.h.
#define FBPropertyInitStringList | ( | Param, | |||
PropName | ) |
Value:
{ \ PropertyAdd(PropName.Init( Param, #PropName )); \ }
Param | Owner name. | |
PropName | Variable name . |
Definition at line 1212 of file fbproperties.h.
#define FBPropertyPublish | ( | Parent, | |||
Prop, | |||||
PropName, | |||||
Get, | |||||
Set | ) |
Value:
{ \ PropertyAdd(Prop.CreateInternal( Parent,PropName,(fbExternalGetSetHandler)Get,(fbExternalGetSetHandler)Set )); \ }
Parent | Owner name. | |
Prop | Variable | |
PropName | Variable Name. | |
Get | Get function pointer. | |
Set | Set function pointer. |
Definition at line 1257 of file fbproperties.h.
#define FBSDK_DLL K_DLLIMPORT |
typedef class K_DLLIMPORT FBPropertyBase< HFBComponent,kFBPT_object > _FBPropertyBaseComponent |
Property: FBPropertyBase(HFBComponent)
Definition at line 1175 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< HFBPlug,kFBPT_object > _FBPropertyBasePlug |
Property: FBPropertyBase(HFBPlug)
Definition at line 1181 of file fbproperties.h.
typedef void(* fbExternalGetSetHandler)(HIObject pObject) |
function pointer
Definition at line 146 of file fbproperties.h.
typedef void(* fbGetSetHandler)(void) |
function pointer
Definition at line 144 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< bool, kFBPT_Action > FBPropertyAnimatableAction |
FBPropertyAnimatableAction type definition.
Definition at line 1419 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< bool, kFBPT_bool > FBPropertyAnimatableBool |
FBPropertyAnimatableBool type definition.
Definition at line 1423 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< FBColor, kFBPT_ColorRGB > FBPropertyAnimatableColor |
FBPropertyAnimatableColor type definition.
Definition at line 1463 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< FBColorAndAlpha, kFBPT_ColorRGBA > FBPropertyAnimatableColorAndAlpha |
FBPropertyAnimatableColorAndAlpha type definition.
Definition at line 1467 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble |
FBPropertyBaseAnimatableDouble type definition.
Definition at line 1443 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< int, kFBPT_enum > FBPropertyAnimatableEnum |
FBPropertyBaseAnimatableEnum type definition.
Definition at line 1439 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< int, kFBPT_in > FBPropertyAnimatableInt |
FBPropertyAnimatableInt type definition.
Definition at line 1427 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< long long, kFBPT_int64 > FBPropertyAnimatableInt64 |
FBPropertyAnimatableInt64 type definition.
Definition at line 1431 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< FBTime, kFBPT_time > FBPropertyAnimatableTime |
FBPropertyBaseAnimatableTime type definition.
Definition at line 1447 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< unsigned long long, kFBPT_uint64 > FBPropertyAnimatableUInt64 |
FBPropertyAnimatableUInt64 type definition.
Definition at line 1435 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< FBVector2d, kFBPT_Vector2D > FBPropertyAnimatableVector2d |
FBPropertyAnimatableVector2D type definition.
Definition at line 1451 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< FBVector3d, kFBPT_Vector3D > FBPropertyAnimatableVector3d |
FBPropertyAnimatableVector3D type definition.
Definition at line 1455 of file fbproperties.h.
typedef FBPropertyBaseAnimatable< FBVector4d, kFBPT_Vector4D > FBPropertyAnimatableVector4d |
FBPropertyAnimatableVector4D type definition.
Definition at line 1459 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< bool,kFBPT_bool > FBPropertyBool |
Property: bool
Definition at line 1128 of file fbproperties.h.
typedef class FBSDK_DLL FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor |
FBPropertyColor type definition.
Definition at line 1262 of file fbproperties.h.
typedef class FBSDK_DLL FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA > FBPropertyColorAndAlpha |
FBPropertyColorAndAlpha type definition.
Definition at line 1267 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBaseComponent< HFBComponent > FBPropertyComponent |
Property: FBPropertyBaseComponent(HFBComponent)
Definition at line 1177 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< double,kFBPT_double > FBPropertyDouble |
Property: double
Definition at line 1158 of file fbproperties.h.
typedef class FBSDK_DLL FBPropertyBaseEnum< enum kDefaultEnum > FBPropertyEnum |
A typedef Definition.
Definition at line 826 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< float,kFBPT_float > FBPropertyFloat |
Property: float
Definition at line 1161 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< int,kFBPT_int > FBPropertyInt |
Property: int
Definition at line 1149 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< long long,kFBPT_int64 > FBPropertyInt64 |
Property: int
Definition at line 1152 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< kReference,kFBPT_kReference > FBPropertykReference |
Property: kReference
Definition at line 1170 of file fbproperties.h.
typedef class FBPropertyBaseComponent< HFBPlug > FBPropertyPlug |
Property: FBPropertyBaseComponent(HFBPlug)
Definition at line 1183 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< HFBProperty,kFBPT_Reference > FBPropertyReference |
Property: FBProperty *
Definition at line 1173 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< char *,kFBPT_charptr > FBPropertyString |
Property class: char * (String).
Definition at line 1125 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< FBTime,kFBPT_Time > FBPropertyTime |
Property: FBTime
Definition at line 1164 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< FBTimeSpan,kFBPT_TimeSpan > FBPropertyTimeSpan |
Property: FBTimeSpan
Definition at line 1167 of file fbproperties.h.
typedef class K_DLLIMPORT FBPropertyBase< unsigned long long,kFBPT_uint64 > FBPropertyUInt64 |
Property: int
Definition at line 1155 of file fbproperties.h.
typedef class FBPropertyBase< FBVector2d, kFBPT_Vector2D > FBPropertyVector2d |
FBPropertyVector2d type definition.
Definition at line 1272 of file fbproperties.h.
typedef class FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d |
FBPropertyVector3d type definition.
Definition at line 1277 of file fbproperties.h.
typedef class FBPropertyBase< FBColor, kFBPT_Vector4D > FBPropertyVector4d |
FBPropertyVector4d type definition.
Definition at line 1283 of file fbproperties.h.
typedef FBPropertyComponent* HFBPropertyComponent |
Property: FBPropertyComponent
Definition at line 1179 of file fbproperties.h.
typedef FBPropertyPlug* HFBPropertyPlug |
Property: FBPropertyPlug
Definition at line 1185 of file fbproperties.h.
enum FBPropertyFlag |
Available flags for FBProperty objects.
Definition at line 108 of file fbproperties.h.
enum FBPropertyType |
Property types.
Definition at line 79 of file fbproperties.h.
enum kDefaultEnum |
Patch to use the base enum for casting values .
Definition at line 821 of file fbproperties.h.