Property classes. More...

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

Classes
class	FBProperty
	Property: Base property class. More...

class	FBPropertyEvent
	PropertyEvent: Base event class. More...

class	FBPropertyEventUIIdle
	PropertyEvent: UI idle event. More...

class	FBPropertyEventVideoFrameRendering
	PropertyEvent: Video Frame Rendering Event More...

class	FBPropertyEventConnectionNotify
	PropertyEvent: Global ConnectionNotify event. More...

class	FBPropertyEventConnectionDataNotify
	PropertyEvent: Global ConnectionDataNotify event. More...

class	FBPropertyEventConnectionStateNotify
	PropertyEvent: Global ConnectionStateNotify event. More...

class	FBPropertyEventConnectionKeyingNotify
	PropertyEvent: Global KeyingNotify event. More...

class	FBPropertyBase< tType, pPT >

class	FBPropertyBaseEnum< tType >

class	FBPropertyBasicList

class	FBPropertyBaseList< tType >

class	FBPropertyStringList
	Property: StringList More...

class	FBPropertyManager
	Property Manager. More...

class	FBPropertyBaseComponent< tType >

class	FBPropertyString
	Property class: const char * (String). More...

class	FBPropertyAction
	Property: Action Action property to trigger function. More...

class	FBPropertyAnimatable
	Animatable property base class. More...

class	FBPropertyBaseAnimatable< tType, pPT >

class	FBPropertyBaseAnimatableEnum< tType >

Macros
#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_CLASS_ENUM(EnumName) typedef class FBPropertyBaseEnum< enum __FBClassType::e##EnumName > Property##EnumName;
	Define a private enum and give it the ability to be a property.

#define	FB_DEFINE_LIST(DllTag, Type) typedef class DllTag FBPropertyBaseList< FB##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	FBImplementClassPropertyEnum(DllTag, Class, EnumName) template class DllTag FBSDKNamespaceFunc(FBPropertyBaseEnum)< enum Class::E##EnumName >

#define	FBImplementPropertyList(DllTag, Type) template class DllTag FBSDKNamespaceFunc(FBPropertyBaseList) < FB##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.

#define	FBPropertyInitTextureConnectable(Parent, Prop, PropName)
	Initialize a property: user texture connect 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< 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< FBTimeCode, kFBPT_TimeCode >	FBPropertyTimeCode
	Property: FBTimeCode

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< FBProperty *, kFBPT_Reference >	FBPropertyReference
	Property: FBProperty *

typedef class K_DLLIMPORT FBPropertyBase< FBComponent *, kFBPT_object >	_FBPropertyBaseComponent
	Property: FBPropertyBase(FBComponent*)

typedef class K_DLLIMPORT FBPropertyBaseComponent< FBComponent * >	FBPropertyComponent
	Property: FBPropertyBaseComponent(FBComponent*)

typedef class K_DLLIMPORT FBPropertyBase< FBPlug *, kFBPT_object >	_FBPropertyBasePlug
	Property: FBPropertyBase(FBPlug*)

typedef class FBPropertyBaseComponent< FBPlug * >	FBPropertyPlug
	Property: FBPropertyBaseComponent(FBPlug*)

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< FBTimeCode, kFBPT_TimeCode >	FBPropertyAnimatableTimeCode
	FBPropertyBaseAnimatableTimeCode 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_TimeCode , 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	FBDataAsStringFlag { kFBDataAsStringUI = 0 , kFBDataAsStringPersistence = 1 }
	FBDataAsStringFlag. More...

enum	FBPropertyFlag { kFBPropertyFlagNotSet = 0 , kFBPropertyFlagHideProperty = (1 << 0) , kFBPropertyFlagForceStaticProperty = (1 << 1) , kFBPropertyFlagDisableProperty = (1 << 2) , kFBPropertyFlagDrivenProperty = (1 << 3) , kFBPropertyFlagAnimated = (1 << 4) , kFBPropertyFlagNotSavable = (1 << 5) , kFBPropertyFlagReadOnly = (1 << 6) , kFBPropertyFlagNotUserDeletable = (1 << 7) , kFBValueAllocated = (1 << 8) , kFBDynamicHidden = (1 << 9) , kFBDrivenSetByMain = (1 << 10) , kFBLoadedUserProperty = (1 << 11) }
	Available flags for FBProperty objects. More...

enum	kDefaultEnum { kDefaultItemNone }
	Patch to use the base enum for casting values . More...

Functions
	K_FORWARD (KEventBase)

	K_FORWARD (KObject)

	K_FORWARD (KProperty)

	K_FORWARD (KEvaluationProperty)

	K_FORWARD (KDataType)

	K_FORWARD (IFBObject)

	K_FORWARD (IRegister)

	FB_FORWARD (FBComponent)

	__FB_FORWARD (FBProperty)

template<class T >
T *	FBCast (FBProperty *pProperty, bool pAutoCreate=false)
	Cast property using it's IObject interface into the proper type.

	__FB_FORWARD (FBPropertyAnimatable)

	FB_FORWARD (FBBox)

	FB_FORWARD (FBAnimationNode)

	FB_FORWARD (FBTake)

	__FB_FORWARD (FBPropertyEvent)

	FB_FORWARD (FBPropertyStringList)

	__FB_FORWARD (FBPropertyManager)

Detailed Description

Property classes.

Properties are callback variables that insert a layer of abstraction between the internal objects and the software development kit.

Definition in file fbproperties.h.

Macro Definition Documentation

◆ FB_DEFINE_CLASS_ENUM

#define FB_DEFINE_CLASS_ENUM ( EnumName ) typedef class FBPropertyBaseEnum< enum __FBClassType::e##EnumName > Property##EnumName;

Define a private enum and give it the ability to be a property.

Parameters

EnumName Name of the Enum to register as a property.

Definition at line 154 of file fbproperties.h.

◆ FB_DEFINE_COMPONENT

#define FB_DEFINE_COMPONENT	(	DllTag,
		Type
	)

Value:

    class FB##Type;                                                                     \
    typedef class DllTag FBPropertyBase< FB##Type*,kFBPT_object > FBPropertyBase##Type; \
    typedef class DllTag FBPropertyBaseComponent< FB##Type* > FBProperty##Type

Define a component and give it the ability to be a property.

Parameters

DllTag	Associated DLL.
Type	Component to register as a property.

Definition at line 139 of file fbproperties.h.

◆ FB_DEFINE_ENUM

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

Parameters

DllTag	Associated DLL.
Type	Enum to register as a property.

Definition at line 148 of file fbproperties.h.

◆ FB_DEFINE_LIST

#define FB_DEFINE_LIST	(	DllTag,
		Type
	)	typedef class DllTag FBPropertyBaseList< FB##Type* > FBPropertyBaseList##Type;

Define a component list.

Parameters

DllTag	Associated DLL.
Type	Component to use as a list item.

Definition at line 161 of file fbproperties.h.

◆ FBImplementClassPropertyEnum

#define FBImplementClassPropertyEnum	(	DllTag,
		Class,
		EnumName
	)	template class DllTag FBSDKNamespaceFunc(FBPropertyBaseEnum)< enum Class::E##EnumName >

Definition at line 1267 of file fbproperties.h.

◆ FBImplementPropertyComponent

#define FBImplementPropertyComponent	(	DllTag,
		Type
	)

Value:

template class DllTag FBSDKNamespaceFunc(FBPropertyBase)< FB##Type*,kFBPT_object >; \

template class DllTag FBSDKNamespaceFunc(FBPropertyBaseComponent)< FB##Type* >;

Implement a property based on a component.

Parameters

DllTag	Associated DLL.
Type	Class to implement.

Definition at line 1257 of file fbproperties.h.

◆ FBImplementPropertyEnum

#define FBImplementPropertyEnum	(	DllTag,
		Type
	)	template class DllTag FBSDKNamespaceFunc(FBPropertyBaseEnum)< enum FB##Type >

Implement a property based on an enumeration.

Parameters

DllTag	Associated DLL.
Type	Class to implement.

Definition at line 1265 of file fbproperties.h.

◆ FBImplementPropertyList

#define FBImplementPropertyList	(	DllTag,
		Type
	)	template class DllTag FBSDKNamespaceFunc(FBPropertyBaseList) < FB##Type* >

Implement a property list for a component.

Parameters

DllTag	Associated DLL.
Type	Class to implement list for.

Definition at line 1274 of file fbproperties.h.

◆ FBPropertyInit

#define FBPropertyInit	(	Param,
		Type,
		PropName,
		Get,
		Set
	)

Value:

    { \
    PropertyAdd(PropName.Init( (void*)Param,#PropName,(Type (*)(void *))Get,(void (*)(void *,Type))Set )); \
    }

Initialize a property: default.

Parameters

Param	Owner name.
Type	Type of variable.
PropName	Variable name.
Get	Get function pointer.
Set	Set function pointer.

Definition at line 1373 of file fbproperties.h.

◆ FBPropertyInitEvent

#define FBPropertyInitEvent	(	Param,
		Type,
		SubType,
		PropName
	)

Value:

    { \
    PropertyAdd(PropName.Init( this, IQ(Param,IRegister),#PropName,Type,SubType )); \
    }

Initialize a property: event.

Parameters

Param	Owner name.
Type	Event Type.
SubType	Event SubType.
PropName	Variable name.

Definition at line 1402 of file fbproperties.h.

◆ FBPropertyInitEventGlobal

#define FBPropertyInitEventGlobal	(	GlobalEventName,
		PropName
	)

Value:

    { \
    PropertyAdd(PropName.InitGlobal( #PropName,GlobalEventName )); \
    }

Initialize a property: global event.

Parameters

GlobalEventName	Name of the global eventEvent Type.
PropName	Variable name.

Definition at line 1411 of file fbproperties.h.

◆ FBPropertyInitInternal

#define FBPropertyInitInternal	(	Parent,
		PropName,
		MBProperty
	)

Value:

    {\
    PropertyAdd(PropName.InitInternal( MBProperty ));\
    }

Mapping to internal properties.

Definition at line 1417 of file fbproperties.h.

◆ FBPropertyInitInternalEnum

#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 )); \
    }

Mapping to internal enum properties.

Definition at line 1423 of file fbproperties.h.

◆ FBPropertyInitList

#define FBPropertyInitList	(	Param,
		PropName
	)

Value:

    { \
    PropertyAdd(PropName.Init( Param,#PropName )); \
    }

Initialize a property: list.

Parameters

Param	Owner name.
PropName	Variable name.

Definition at line 1382 of file fbproperties.h.

◆ FBPropertyInitStringList

#define FBPropertyInitStringList	(	Param,
		PropName
	)

Value:

    { \
    PropertyAdd(PropName.Init( Param, #PropName )); \
    }

Initialize a property: string list.

Parameters

Param	Owner name.
PropName	Variable name .

Definition at line 1391 of file fbproperties.h.

◆ FBPropertyInitTextureConnectable

#define FBPropertyInitTextureConnectable	(	Parent,
		Prop,
		PropName
	)

Value:

    { \
    PropertyAdd(Prop.CreateTextureConnectable( Parent,PropName )); \
    }

Initialize a property: user texture connect property.

Only support Color, ColorAndAlpha, Number, Vector, Vector2, Vector4 data type for user texture connectable property!

Remarks: Need initialize the property before assign a value for it, otherwise may get assert failure.

Parameters

Parent	Owner name.
Prop	Variable
PropName	Variable Name.

Definition at line 1447 of file fbproperties.h.

◆ FBPropertyPublish

#define FBPropertyPublish	(	Parent,
		Prop,
		PropName,
		Get,
		Set
	)

Value:

    { \
    PropertyAdd(Prop.CreateInternal( Parent,PropName,(fbExternalGetSetHandler)Get,(fbExternalGetSetHandler)Set )); \
    }

Publish a property.

Parameters

Parent	Owner name.
Prop	Variable
PropName	Variable Name.
Get	Get function pointer.
Set	Set function pointer.

Definition at line 1436 of file fbproperties.h.

◆ FBSDK_DLL

#define FBSDK_DLL K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 51 of file fbproperties.h.

Typedef Documentation

◆ _FBPropertyBaseComponent

typedef class K_DLLIMPORT FBPropertyBase< FBComponent*,kFBPT_object > _FBPropertyBaseComponent

Property: FBPropertyBase(FBComponent*)

Definition at line 1358 of file fbproperties.h.

◆ _FBPropertyBasePlug

typedef class K_DLLIMPORT FBPropertyBase< FBPlug*,kFBPT_object > _FBPropertyBasePlug

Property: FBPropertyBase(FBPlug*)

Definition at line 1362 of file fbproperties.h.

◆ fbExternalGetSetHandler

typedef void(* fbExternalGetSetHandler) (HIObject pObject)

function pointer

Definition at line 167 of file fbproperties.h.

◆ fbGetSetHandler

typedef void(* fbGetSetHandler) (void)

function pointer

Definition at line 165 of file fbproperties.h.

◆ FBPropertyAnimatableAction

typedef FBPropertyBaseAnimatable< bool, kFBPT_Action > FBPropertyAnimatableAction

FBPropertyAnimatableAction type definition.

Definition at line 1726 of file fbproperties.h.

◆ FBPropertyAnimatableBool

typedef FBPropertyBaseAnimatable< bool, kFBPT_bool > FBPropertyAnimatableBool

FBPropertyAnimatableBool type definition.

Definition at line 1730 of file fbproperties.h.

◆ FBPropertyAnimatableColor

typedef FBPropertyBaseAnimatable< FBColor, kFBPT_ColorRGB > FBPropertyAnimatableColor

FBPropertyAnimatableColor type definition.

Definition at line 1774 of file fbproperties.h.

◆ FBPropertyAnimatableColorAndAlpha

typedef FBPropertyBaseAnimatable< FBColorAndAlpha, kFBPT_ColorRGBA > FBPropertyAnimatableColorAndAlpha

FBPropertyAnimatableColorAndAlpha type definition.

Definition at line 1778 of file fbproperties.h.

◆ FBPropertyAnimatableDouble

typedef FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble

FBPropertyBaseAnimatableDouble type definition.

Definition at line 1750 of file fbproperties.h.

◆ FBPropertyAnimatableEnum

typedef FBPropertyBaseAnimatable< int, kFBPT_enum > FBPropertyAnimatableEnum

FBPropertyBaseAnimatableEnum type definition.

Definition at line 1746 of file fbproperties.h.

◆ FBPropertyAnimatableInt

typedef FBPropertyBaseAnimatable< int, kFBPT_in > FBPropertyAnimatableInt

FBPropertyAnimatableInt type definition.

Definition at line 1734 of file fbproperties.h.

◆ FBPropertyAnimatableInt64

typedef FBPropertyBaseAnimatable< long long, kFBPT_int64 > FBPropertyAnimatableInt64

FBPropertyAnimatableInt64 type definition.

Definition at line 1738 of file fbproperties.h.

◆ FBPropertyAnimatableTime

typedef FBPropertyBaseAnimatable< FBTime, kFBPT_time > FBPropertyAnimatableTime

FBPropertyBaseAnimatableTime type definition.

Definition at line 1754 of file fbproperties.h.

◆ FBPropertyAnimatableTimeCode

typedef FBPropertyBaseAnimatable< FBTimeCode, kFBPT_timecode > FBPropertyAnimatableTimeCode

FBPropertyBaseAnimatableTimeCode type definition.

Definition at line 1758 of file fbproperties.h.

◆ FBPropertyAnimatableUInt64

typedef FBPropertyBaseAnimatable< unsigned long long, kFBPT_uint64 > FBPropertyAnimatableUInt64

FBPropertyAnimatableUInt64 type definition.

Definition at line 1742 of file fbproperties.h.

◆ FBPropertyAnimatableVector2d

typedef FBPropertyBaseAnimatable< FBVector2d, kFBPT_Vector2D > FBPropertyAnimatableVector2d

FBPropertyAnimatableVector2D type definition.

Definition at line 1762 of file fbproperties.h.

◆ FBPropertyAnimatableVector3d

typedef FBPropertyBaseAnimatable< FBVector3d, kFBPT_Vector3D > FBPropertyAnimatableVector3d

FBPropertyAnimatableVector3D type definition.

Definition at line 1766 of file fbproperties.h.

◆ FBPropertyAnimatableVector4d

typedef FBPropertyBaseAnimatable< FBVector4d, kFBPT_Vector4D > FBPropertyAnimatableVector4d

FBPropertyAnimatableVector4D type definition.

Definition at line 1770 of file fbproperties.h.

◆ FBPropertyBool

typedef class K_DLLIMPORT FBPropertyBase< bool,kFBPT_bool > FBPropertyBool

Property: bool

Definition at line 1306 of file fbproperties.h.

◆ FBPropertyColor

typedef class FBSDK_DLL FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor

FBPropertyColor type definition.

Definition at line 1452 of file fbproperties.h.

◆ FBPropertyColorAndAlpha

typedef class FBSDK_DLL FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA > FBPropertyColorAndAlpha

FBPropertyColorAndAlpha type definition.

Definition at line 1457 of file fbproperties.h.

◆ FBPropertyComponent

typedef class K_DLLIMPORT FBPropertyBaseComponent< FBComponent* > FBPropertyComponent

Property: FBPropertyBaseComponent(FBComponent*)

Definition at line 1360 of file fbproperties.h.

◆ FBPropertyDouble

typedef class K_DLLIMPORT FBPropertyBase< double,kFBPT_double > FBPropertyDouble

Property: double

Definition at line 1338 of file fbproperties.h.

◆ FBPropertyEnum

typedef class FBSDK_DLL FBPropertyBaseEnum< enum kDefaultEnum > FBPropertyEnum

A typedef Definition.

Definition at line 978 of file fbproperties.h.

◆ FBPropertyFloat

typedef class K_DLLIMPORT FBPropertyBase< float,kFBPT_float > FBPropertyFloat

Property: float

Definition at line 1341 of file fbproperties.h.

◆ FBPropertyInt

typedef class K_DLLIMPORT FBPropertyBase< int,kFBPT_int > FBPropertyInt

Property: int

Definition at line 1329 of file fbproperties.h.

◆ FBPropertyInt64

typedef class K_DLLIMPORT FBPropertyBase< long long,kFBPT_int64 > FBPropertyInt64

Property: int

Definition at line 1332 of file fbproperties.h.

◆ FBPropertykReference

typedef class K_DLLIMPORT FBPropertyBase< kReference,kFBPT_kReference > FBPropertykReference

Property: kReference

Definition at line 1353 of file fbproperties.h.

◆ FBPropertyPlug

typedef class FBPropertyBaseComponent< FBPlug * > FBPropertyPlug

Property: FBPropertyBaseComponent(FBPlug*)

Definition at line 1364 of file fbproperties.h.

◆ FBPropertyReference

typedef class K_DLLIMPORT FBPropertyBase< FBProperty*,kFBPT_Reference > FBPropertyReference

Property: FBProperty *

Definition at line 1356 of file fbproperties.h.

◆ FBPropertyTime

typedef class K_DLLIMPORT FBPropertyBase< FBTime,kFBPT_Time > FBPropertyTime

Property: FBTime

Definition at line 1344 of file fbproperties.h.

◆ FBPropertyTimeCode

typedef class K_DLLIMPORT FBPropertyBase< FBTimeCode,kFBPT_TimeCode > FBPropertyTimeCode

Property: FBTimeCode

Definition at line 1347 of file fbproperties.h.

◆ FBPropertyTimeSpan

typedef class K_DLLIMPORT FBPropertyBase< FBTimeSpan,kFBPT_TimeSpan > FBPropertyTimeSpan

Property: FBTimeSpan

Definition at line 1350 of file fbproperties.h.

◆ FBPropertyUInt64

typedef class K_DLLIMPORT FBPropertyBase< unsigned long long,kFBPT_uint64 > FBPropertyUInt64

Property: int

Definition at line 1335 of file fbproperties.h.

◆ FBPropertyVector2d

typedef class FBPropertyBase< FBVector2d, kFBPT_Vector2D > FBPropertyVector2d

FBPropertyVector2d type definition.

Definition at line 1462 of file fbproperties.h.

◆ FBPropertyVector3d

typedef class FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d

FBPropertyVector3d type definition.

Definition at line 1467 of file fbproperties.h.

◆ FBPropertyVector4d

typedef class FBPropertyBase< FBColor, kFBPT_Vector4D > FBPropertyVector4d

FBPropertyVector4d type definition.

Definition at line 1473 of file fbproperties.h.

Enumeration Type Documentation

◆ FBDataAsStringFlag

enum FBDataAsStringFlag

FBDataAsStringFlag.

Enumerator
kFBDataAsStringUI	Convert data to string type for UI display.
kFBDataAsStringPersistence	Convert data to string type for storage.

Definition at line 109 of file fbproperties.h.

◆ FBPropertyFlag

enum FBPropertyFlag

Available flags for FBProperty objects.

Note: Property flags are not saved into FBX files.

Enumerator
kFBPropertyFlagHideProperty	This flag is used to show/hide the property in the propertiview. However, when turn on/off HidePropertry flag, this property won't show/hide unless you reload the UI. The nodes hidden by this flag are removed from UI.
kFBPropertyFlagDrivenProperty	This is property is connected and driven by other same type of main property, and it always ask value from its main property.
kFBPropertyFlagNotSavable	Should not be saved to or loaded from an FBX file.
kFBValueAllocated	The value has been allocated and must be delete in destructor.
kFBDynamicHidden	This flag is used to show/hide the property in the propertiview. When turn on/ff DynamicHidden flag, this property will show/hide. The nodes hidden by this flag still exist in UI.
kFBDrivenSetByMain	Driven property can be modified, valid only when the main property is modified.
kFBLoadedUserProperty	This property is loaded from file.

Definition at line 118 of file fbproperties.h.

◆ FBPropertyType

enum FBPropertyType

Property types.

Enumerator
kFBPT_unknown	unknow.
kFBPT_int	int.
kFBPT_int64	int 64 bits.
kFBPT_uint64	unsigned int 64 bits.
kFBPT_bool	bool.
kFBPT_float	float.
kFBPT_double	double.
kFBPT_charptr	charptr.
kFBPT_enum	enum.
kFBPT_Time	time.
kFBPT_TimeCode	timecode.
kFBPT_object	object.
kFBPT_event	event.
kFBPT_stringlist	stringlist.
kFBPT_Vector4D	vector4d.
kFBPT_Vector3D	vector3d.
kFBPT_ColorRGB	colorrgb.
kFBPT_ColorRGBA	colorrgba.
kFBPT_Action	action.
kFBPT_Reference	reference.
kFBPT_TimeSpan	timespan.
kFBPT_kReference	kReference.
kFBPT_Vector2D	vector2d.

Definition at line 79 of file fbproperties.h.

◆ kDefaultEnum

enum kDefaultEnum

Patch to use the base enum for casting values .

Enumerator
kDefaultItemNone	None.

Definition at line 973 of file fbproperties.h.

Function Documentation

◆ FBCast()

T * FBCast	(	FBProperty *	pProperty,
		bool	pAutoCreate = `false`
	)

inline

Cast property using it's IObject interface into the proper type.

Parameters

pProperty	Property pointer to be cast into the proper type.
pAutoCreate	Create object if it doesn't exist? (default = false)

Returns: SDK object for pProperty.

Definition at line 485 of file fbproperties.h.

References FBGetFBObject().

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ FB_DEFINE_CLASS_ENUM

◆ FB_DEFINE_COMPONENT

◆ FB_DEFINE_ENUM

◆ FB_DEFINE_LIST

◆ FBImplementClassPropertyEnum

◆ FBImplementPropertyComponent

◆ FBImplementPropertyEnum

◆ FBImplementPropertyList

◆ FBPropertyInit

◆ FBPropertyInitEvent

◆ FBPropertyInitEventGlobal

◆ FBPropertyInitInternal

◆ FBPropertyInitInternalEnum

◆ FBPropertyInitList

◆ FBPropertyInitStringList

◆ FBPropertyInitTextureConnectable

◆ FBPropertyPublish

◆ FBSDK_DLL

Typedef Documentation

◆ _FBPropertyBaseComponent

◆ _FBPropertyBasePlug

◆ fbExternalGetSetHandler

◆ fbGetSetHandler

◆ FBPropertyAnimatableAction

◆ FBPropertyAnimatableBool

◆ FBPropertyAnimatableColor

◆ FBPropertyAnimatableColorAndAlpha

◆ FBPropertyAnimatableDouble

◆ FBPropertyAnimatableEnum

◆ FBPropertyAnimatableInt

◆ FBPropertyAnimatableInt64

◆ FBPropertyAnimatableTime

◆ FBPropertyAnimatableTimeCode

◆ FBPropertyAnimatableUInt64

◆ FBPropertyAnimatableVector2d

◆ FBPropertyAnimatableVector3d

◆ FBPropertyAnimatableVector4d

◆ FBPropertyBool

◆ FBPropertyColor

◆ FBPropertyColorAndAlpha

◆ FBPropertyComponent

◆ FBPropertyDouble

◆ FBPropertyEnum

◆ FBPropertyFloat

◆ FBPropertyInt

◆ FBPropertyInt64

◆ FBPropertykReference

◆ FBPropertyPlug

◆ FBPropertyReference

◆ FBPropertyTime

◆ FBPropertyTimeCode

◆ FBPropertyTimeSpan

◆ FBPropertyUInt64

◆ FBPropertyVector2d

◆ FBPropertyVector3d

◆ FBPropertyVector4d

Enumeration Type Documentation

◆ FBDataAsStringFlag

◆ FBPropertyFlag

◆ FBPropertyType

◆ kDefaultEnum

Function Documentation

◆ FBCast()