fbsdk/fbproperties.h File Reference
 
 
 
fbsdk/fbproperties.h File Reference

This reference page is linked to from the following overview topics: About the SDK Components, Updated Objects, File Options, Overview of the Architecture, MotionBuilder 2014.


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

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

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 >

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_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),
  kFBPropertyFlagSlavedProperty = (1 << 3), kFBPropertyFlagAnimated = (1 << 4), kFBPropertyFlagNotSavable = (1 << 5), kFBPropertyFlagReadOnly = (1 << 6),
  kFBPropertyFlagNotUserDeletable = (1 << 7), kFBValueAllocated = (1 << 8), kFBDynamicHidden = (1 << 9), kFBSlaveSetByMaster = (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)
  __FB_FORWARD (FBPropertyAnimatable)
  FB_FORWARD (FBBox)
  FB_FORWARD (FBAnimationNode)
  FB_FORWARD (FBTake)
  __FB_FORWARD (FBPropertyEvent)
  FB_FORWARD (FBPropertyStringList)
  __FB_FORWARD (FBPropertyManager)

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 51 of file fbproperties.h.

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

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

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

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

#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 1228 of file fbproperties.h.

#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 1241 of file fbproperties.h.

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

Definition at line 1243 of file fbproperties.h.

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

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 1355 of file fbproperties.h.

#define FBPropertyInitList (   Param,
  PropName 
)
Value:
{ \
    PropertyAdd(PropName.Init( Param,#PropName )); \
    }

Initialize a property: list.

Parameters:
Param Owner name.
PropName Variable name.

Definition at line 1364 of file fbproperties.h.

#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 1373 of file fbproperties.h.

#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 1384 of file fbproperties.h.

#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 1393 of file fbproperties.h.

#define FBPropertyInitInternal (   Parent,
  PropName,
  MBProperty 
)
Value:
{\
    PropertyAdd(PropName.InitInternal( MBProperty ));\
    }

Mapping to internal properties.

Definition at line 1399 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 )); \
    }

Mapping to internal enum properties.

Definition at line 1405 of file fbproperties.h.

#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 1418 of file fbproperties.h.

#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 1429 of file fbproperties.h.


Typedef Documentation

typedef void(* fbGetSetHandler)(void)

function pointer

Definition at line 165 of file fbproperties.h.

typedef void(* fbExternalGetSetHandler)(HIObject pObject)

function pointer

Definition at line 167 of file fbproperties.h.

typedef class FBSDK_DLL FBPropertyBaseEnum< enum kDefaultEnum > FBPropertyEnum

A typedef Definition.

Definition at line 956 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< bool,kFBPT_bool > FBPropertyBool

Property: bool

Definition at line 1288 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< int,kFBPT_int > FBPropertyInt

Property: int

Definition at line 1311 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< long long,kFBPT_int64 > FBPropertyInt64

Property: int

Definition at line 1314 of file fbproperties.h.

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

Property: int

Definition at line 1317 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< double,kFBPT_double > FBPropertyDouble

Property: double

Definition at line 1320 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< float,kFBPT_float > FBPropertyFloat

Property: float

Definition at line 1323 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< FBTime,kFBPT_Time > FBPropertyTime

Property: FBTime

Definition at line 1326 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< FBTimeCode,kFBPT_TimeCode > FBPropertyTimeCode

Property: FBTimeCode

Definition at line 1329 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< FBTimeSpan,kFBPT_TimeSpan > FBPropertyTimeSpan

Property: FBTimeSpan

Definition at line 1332 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< kReference,kFBPT_kReference > FBPropertykReference

Property: kReference

Definition at line 1335 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< FBProperty*,kFBPT_Reference > FBPropertyReference

Property: FBProperty *

Definition at line 1338 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< FBComponent*,kFBPT_object > _FBPropertyBaseComponent

Property: FBPropertyBase(FBComponent*)

Definition at line 1340 of file fbproperties.h.

Property: FBPropertyBaseComponent(FBComponent*)

Definition at line 1342 of file fbproperties.h.

typedef class K_DLLIMPORT FBPropertyBase< FBPlug*,kFBPT_object > _FBPropertyBasePlug

Property: FBPropertyBase(FBPlug*)

Definition at line 1344 of file fbproperties.h.

Property: FBPropertyBaseComponent(FBPlug*)

Definition at line 1346 of file fbproperties.h.

typedef class FBSDK_DLL FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor

FBPropertyColor type definition.

Definition at line 1434 of file fbproperties.h.

typedef class FBSDK_DLL FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA > FBPropertyColorAndAlpha

FBPropertyColorAndAlpha type definition.

Definition at line 1439 of file fbproperties.h.

typedef class FBPropertyBase< FBVector2d, kFBPT_Vector2D > FBPropertyVector2d

FBPropertyVector2d type definition.

Definition at line 1444 of file fbproperties.h.

typedef class FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d

FBPropertyVector3d type definition.

Definition at line 1449 of file fbproperties.h.

typedef class FBPropertyBase< FBColor, kFBPT_Vector4D > FBPropertyVector4d

FBPropertyVector4d type definition.

Definition at line 1455 of file fbproperties.h.

FBPropertyAnimatableAction type definition.

Definition at line 1664 of file fbproperties.h.

FBPropertyAnimatableBool type definition.

Definition at line 1668 of file fbproperties.h.

FBPropertyAnimatableInt type definition.

Definition at line 1672 of file fbproperties.h.

typedef FBPropertyBaseAnimatable< long long, kFBPT_int64 > FBPropertyAnimatableInt64

FBPropertyAnimatableInt64 type definition.

Definition at line 1676 of file fbproperties.h.

typedef FBPropertyBaseAnimatable< unsigned long long, kFBPT_uint64 > FBPropertyAnimatableUInt64

FBPropertyAnimatableUInt64 type definition.

Definition at line 1680 of file fbproperties.h.

typedef FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble

FBPropertyBaseAnimatableDouble type definition.

Definition at line 1688 of file fbproperties.h.

FBPropertyBaseAnimatableTime type definition.

Definition at line 1692 of file fbproperties.h.

FBPropertyBaseAnimatableTimeCode type definition.

Definition at line 1696 of file fbproperties.h.

FBPropertyAnimatableVector2D type definition.

Definition at line 1700 of file fbproperties.h.

FBPropertyAnimatableVector3D type definition.

Definition at line 1704 of file fbproperties.h.

FBPropertyAnimatableVector4D type definition.

Definition at line 1708 of file fbproperties.h.

FBPropertyAnimatableColor type definition.

Definition at line 1712 of file fbproperties.h.

FBPropertyAnimatableColorAndAlpha type definition.

Definition at line 1716 of file fbproperties.h.


Enumeration Type Documentation

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.

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.

Available flags for FBProperty objects.

Note:
Property flags are not saved into FBX files.
Enumerator:
kFBPropertyFlagNotSet 
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.

kFBPropertyFlagForceStaticProperty 
kFBPropertyFlagDisableProperty 
kFBPropertyFlagSlavedProperty 

This is property is connected and slaved by other same type of master property, and it always ask value from its master property.

kFBPropertyFlagAnimated 
kFBPropertyFlagNotSavable 

Should not be saved to or loaded from an FBX file.

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

kFBSlaveSetByMaster 

Slave property can be modified, valid only when the master property is modified.

kFBLoadedUserProperty 

This property is loaded from file.

Definition at line 118 of file fbproperties.h.

Patch to use the base enum for casting values .

Enumerator:
kDefaultItemNone 

None.

Definition at line 951 of file fbproperties.h.


Function Documentation

K_FORWARD ( KEventBase  )
K_FORWARD ( KObject  )
K_FORWARD ( KProperty  )
K_FORWARD ( KEvaluationProperty  )
K_FORWARD ( KDataType  )
K_FORWARD ( IFBObject  )
K_FORWARD ( IRegister  )

Go to the source code of this file.