FBProperty Class Reference

#include <fbproperties.h>

Class Description

Property: Base property class.

A property is a holder for function callbacks into the internals of the application.

You cannot instantiate FBProperty objects. To reference a property:

  • Use an instance of an FBComponent object. The methods FBComponent::PropertyCreate and FBComponent::PropertyRemove can be used to modify an object's set of properties. When accessing a FBProperty object via its containing object, you can get or set (assuming it is not read-only) its value directly, for example in Python: myObject.Visibility = True.
  • FBPropertyManager exists in all FBComponent objects, and contains an array of all the registered properties. Use FBProperty::Find to find a property by name. When accessing a property reference directly, its value is obtained via its 'Data' member.
    myProp = myObject.PropertyList.Find( 'Visibility' )
    if myProp: myProp.Data = True

To see how to create a custom property in Python, see CustomProperty.py.

Definition at line 192 of file fbproperties.h.

+ Inheritance diagram for FBProperty:

Public Types

typedef FBPlug ParentClass
 

Public Member Functions

virtual const char * ClassName () override
 internal System vars. More...
 
virtual bool Is (int pTypeId) override
 Is( int pTypeId ) More...
 
virtual void FBDelete () override
 Actual destructor for a FBPlug. More...
 
virtual int GetTypeId () override
 GetTypeId( int pTypeId ) More...
 
virtual ~FBProperty ()
 
 FBProperty ()
 Constructor. More...
 
void SetEnable (bool pValue)
 Set property enable status. More...
 
const char * GetName ()
 Get the property's name. More...
 
void SetName (const char *pName)
 Set the property's name. More...
 
virtual FBPropertyType GetPropertyType ()
 Get the property's type. More...
 
const char * GetPropertyTypeName ()
 Get the property's type name. More...
 
virtual KDataType * GetDataType ()
 Get the property datatype pointer. More...
 
int AsInt ()
 Get the property as an integer. More...
 
bool SetInt (int pInt)
 Set the property from an integer. More...
 
virtual const char * AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
 Get the property value as a string. More...
 
virtual bool SetString (const char *pString)
 Set the property value from a string. More...
 
const char * OriValueAsString ()
 Get the property original value (before any modification) as string. More...
 
bool IsAnimated () const
 Get the property animated flag status. More...
 
bool OriIsAnimated () const
 Get the property original animated flag status (before any modification) More...
 
bool IsMinClamp ()
 Indicate if minimum value clamping will be applied on user input value. More...
 
bool IsMaxClamp ()
 Indicate if maximum value clamping will be applied on user input value. More...
 
bool IsTemporaryProperty ()
 Indicate if a property was created on retrieve because it didn't exist. More...
 
bool AcceptTemporaryProperty (const char *pEnumList[]=((void *) 0), fbExternalGetSetHandler pGet=((void *) 0), fbExternalGetSetHandler pSet=((void *) 0))
 Accept a temporary property as a dynamic property. More...
 
bool IsObjectList ()
 Indicate if is an instance of FBPropertyListObject. More...
 
virtual bool IsReadOnly ()
 Is property read-only? More...
 
virtual const char * EnumList (int pIndex)
 Return the string of an enum value. More...
 
FBStringListGetEnumStringList (bool pCreateIt=false)
 String list for enum properties. More...
 
void NotifyEnumStringListChanged ()
 Notify system that the enum list was modified. More...
 
void ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
 ModifyPropertyFlag. More...
 
FBPropertyFlag GetPropertyFlags ()
 GetPropertyFlags. More...
 
bool GetPropertyFlag (FBPropertyFlag pFlag)
 GetPropertyFlag. More...
 
void SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
 SetMinMax. More...
 
void SetMin (double pMin, bool pForceMinClamp=false)
 SetMin. More...
 
void SetMax (double pMax, bool pForceMaxClamp=false)
 SetMax. More...
 
double GetMin ()
 GetMin. More...
 
double GetMax ()
 GetMax. More...
 
void * GetParent ()
 Get the parent of the object. More...
 
virtual void SetData (void *pData)
 Set the value of the property, passing the type as an argument. More...
 
virtual void GetData (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=((void *) 0)) const
 Get the value of a property. More...
 
virtual bool IsList ()
 Verify if property is of this type. More...
 
virtual bool IsAnimatable ()
 
bool IsInternal () const
 
bool IsUserProperty ()
 
bool IsTextureConnectableProperty ()
 
bool IsReferenceProperty ()
 
Interface for property locking mechanism.

Locking a property or any number of its channel(s) prevents the user from modifying animation on this property.

This means that the user can't add, remove or edit any key on any layer of a locked property/channel. It also means that the user can't change the current value of the property. However, a locked property allows existing animation to flow through. This means that the value of a locked property can change through time as its being driven by existing animation and/or constraints.

int GetSubMemberCount () const
 GetSubMemberCount. More...
 
bool AllowsLocking () const
 AllowsLocking. More...
 
bool HasSomethingLocked () const
 HasSomethingLocked. More...
 
bool IsLocked () const
 IsLocked. More...
 
bool IsMemberLocked (int pIndex) const
 IsMemberLocked. More...
 
void SetLocked (bool pLocked)
 SetLocked. More...
 
void SetMemberLocked (int pIndex, bool pLocked)
 SetMemberLocked. More...
 
- Public Member Functions inherited from IObject
virtual HIObject IQuery (kInterfaceID pInterfaceID, int IsLocal=0)=0
 
virtual void Destroy (int IsLocal=0)=0
 
- Public Member Functions inherited from FBWrapperHolder
 FBWrapperHolder ()
 
virtual ~FBWrapperHolder ()
 
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Static Public Attributes

static int TypeInfo
 

Protected Attributes

FBString mName
 Return to the default scope (private) More...
 
void * mParent
 mParent Parent of the property. More...
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component. More...
 

Additional Inherited Members

- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=((void *) 0), FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=((void *) 0))
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Member Typedef Documentation

Definition at line 194 of file fbproperties.h.

Constructor & Destructor Documentation

virtual ~FBProperty ( )
virtual

Constructor.

Member Function Documentation

bool AcceptTemporaryProperty ( const char *  pEnumList[] = ((void *) 0),
fbExternalGetSetHandler  pGet = ((void *) 0),
fbExternalGetSetHandler  pSet = ((void *) 0) 
)

Accept a temporary property as a dynamic property.

Warning
if there is no call to AcceptTemporaryProperty(), is will be converted to a user property after the file is retrieved.
Returns
true if property was temporary and converted to a user property.
bool AllowsLocking ( ) const

AllowsLocking.

Returns
true if property can be locked
int AsInt ( )

Get the property as an integer.

Returns
The integer version of the property.
virtual const char* AsString ( FBDataAsStringFlag  pFlag = kFBDataAsStringUI)
virtual

Get the property value as a string.

Parameters
pFlagIndicates the returned string to be used for UI or storage. It defaults to kFBDataAsStringUI.
Returns
The string version of the property.

Reimplemented in FBPropertyBaseAnimatableEnum< tType >, FBPropertyStringList, FBPropertyBaseEnum< tType >, FBPropertyBaseEnum< enum FBNurbType >, FBPropertyBaseEnum< enum FBShadowFrameType >, FBPropertyBaseEnum< enum FBVideoInterlaceMode >, FBPropertyBaseEnum< enum FBStoryTrackRefMode >, FBPropertyBaseEnum< enum FBStoryTrackType >, FBPropertyBaseEnum< enum FBModelShadingMode >, FBPropertyBaseEnum< enum FBModelSelection >, FBPropertyBaseEnum< enum FBGeometryMappingMode >, FBPropertyBaseEnum< enum FBExtrapolationMode >, FBPropertyBaseEnum< enum FBInterpolation >, FBPropertyBaseEnum< enum FBImageFormat >, FBPropertyBaseEnum< enum FBCharacterKeyingMode >, FBPropertyBaseEnum< enum FBCharacterInputType >, FBPropertyBaseEnum< enum FBInsertSegmentMode >, FBPropertyBaseEnum< enum FBStoryClipSolveMode >, FBPropertyBaseEnum< enum FBRootXZMode >, FBPropertyBaseEnum< enum FBRootRMode >, FBPropertyBaseEnum< enum FBShadowType >, FBPropertyBaseEnum< enum FBHUDElementHAlignment >, FBPropertyBaseEnum< enum FBSkeletonResolutionLevel >, FBPropertyBaseEnum< enum FBCharacterRollSolver >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< enum FBPoseType >, FBPropertyBaseEnum< enum FBCharacterExtensionStancePoseMode >, FBPropertyBaseEnum< enum FBNewKeyInterpolationType >, FBPropertyBaseEnum< enum FBRSType >, FBPropertyBaseEnum< enum FBGapMode >, FBPropertyBaseEnum< enum FBTextureBlendMode >, FBPropertyBaseEnum< enum FBTakeSpanOnLoad >, FBPropertyBaseEnum< enum FBTransportSnapMode >, FBPropertyBaseEnum< enum FBSurfaceType >, FBPropertyBaseEnum< enum FBFogMode >, FBPropertyBaseEnum< enum FBCharacterHipsTranslationMode >, FBPropertyBaseEnum< EKeyPropertyBehavior >, FBPropertyBaseEnum< enum FBElementAction >, FBPropertyBaseEnum< enum FBSegmentMode >, FBPropertyBaseEnum< enum FBMarkerType >, FBPropertyBaseEnum< enum FBConnectionType >, FBPropertyBaseEnum< enum FBDeviceSamplingMode >, FBPropertyBaseEnum< enum FBCameraSamplingType >, FBPropertyBaseEnum< enum FBCameraFrameSizeMode >, FBPropertyBaseEnum< enum FBTransportLoopMode >, FBPropertyBaseEnum< enum FBImageInterleaveType >, FBPropertyBaseEnum< enum FBClusterMode >, FBPropertyBaseEnum< ELengthUnitType >, FBPropertyBaseEnum< enum FBGenerationMode >, FBPropertyBaseEnum< enum FBStoryClipMirrorPlane >, FBPropertyBaseEnum< enum FBCameraDistanceMode >, FBPropertyBaseEnum< enum FBLightType >, FBPropertyBaseEnum< enum FBImageType >, FBPropertyBaseEnum< enum FBCharacterContactBehaviour >, FBPropertyBaseEnum< enum FBStoryTrackGhostShowMode >, FBPropertyBaseEnum< enum FBSyncActivationAndVisibilityMode >, FBPropertyBaseEnum< enum FBEventAnimationNodeType >, FBPropertyBaseEnum< enum FBStoryClipShowGhostMode >, FBPropertyBaseEnum< enum FBRootSpeedMode >, FBPropertyBaseEnum< enum FBRootHMode >, FBPropertyBaseEnum< enum FBPlotAllowed >, FBPropertyBaseEnum< enum FBClipEnd >, FBPropertyBaseEnum< enum FBCameraAntiAliasingMethod >, FBPropertyBaseEnum< enum FBCameraSafeAreaMode >, FBPropertyBaseEnum< enum FBCameraResolutionMode >, FBPropertyBaseEnum< enum FBAttenuationType >, FBPropertyBaseEnum< enum FBPlayerControlChangeType >, FBPropertyBaseEnum< enum FBLayerMode >, FBPropertyBaseEnum< enum FBCharacterLoadAnimationMethod >, FBPropertyBaseEnum< enum FBStoryClipGhostTimeMode >, FBPropertyBaseEnum< enum FBVideoFormat >, FBPropertyBaseEnum< enum FBDeckTransportMode >, FBPropertyBaseEnum< enum FBTakeChangeType >, FBPropertyBaseEnum< enum FBUseChnMode >, FBPropertyBaseEnum< enum FBTangentMode >, FBPropertyBaseEnum< enum FBSkeletonLook >, FBPropertyBaseEnum< enum FBConnectionAction >, FBPropertyBaseEnum< enum FBControlSetType >, FBPropertyBaseEnum< enum FBCameraFocusDistanceSource >, FBPropertyBaseEnum< enum FBCameraViewPlaneMode >, FBPropertyBaseEnum< enum FBCameraApertureMode >, FBPropertyBaseEnum< enum FBTransportTimeFormat >, FBPropertyBaseEnum< enum FBAlphaSource >, FBPropertyBaseEnum< enum FBVideoResolution >, FBPropertyBaseEnum< enum FBConsoleChannelType >, FBPropertyBaseEnum< enum FBRigidBodyMode >, FBPropertyBaseEnum< enum FBRenderingPass >, FBPropertyBaseEnum< enum FBTangentClampMode >, FBPropertyBaseEnum< enum FBAnimationNodeConnectorType >, FBPropertyBaseEnum< enum FBPropertyStateEventType >, FBPropertyBaseEnum< enum FBCharacterExtensionRetargetMode >, FBPropertyBaseEnum< enum FBStoryClipChangeType >, FBPropertyBaseEnum< enum FBFCurveEventType >, FBPropertyBaseEnum< enum FBGeometryReferenceMode >, FBPropertyBaseEnum< enum FBTangentWeightMode >, FBPropertyBaseEnum< enum FBTextureMapping >, FBPropertyBaseEnum< enum FBMarkerResolutionLevel >, FBPropertyBaseEnum< enum FBModelRotationOrder >, FBPropertyBaseEnum< enum FBPlayMode >, FBPropertyBaseEnum< enum FBCustomKeyChangeType >, FBPropertyBaseEnum< enum FBCommPortType >, FBPropertyBaseEnum< enum FBFileFormatAndVersion >, FBPropertyBaseEnum< enum FBStoryClipNodeFunction >, FBPropertyBaseEnum< enum FBVideoStorageMode >, FBPropertyBaseEnum< enum FBAccessMode >, FBPropertyBaseEnum< enum FBCameraFilmBackType >, FBPropertyBaseEnum< enum FBFileMonitoringType >, FBPropertyBaseEnum< enum FBTimeReferential >, FBPropertyBaseEnum< enum FBCommandState >, FBPropertyBaseEnum< enum FBControllerMode >, FBPropertyBaseEnum< enum FBStoryClipTimeWarpInterpolatorType >, FBPropertyBaseEnum< enum FBParallelScheduleType >, FBPropertyBaseEnum< enum FBProfilingMode >, FBPropertyBaseEnum< enum FBTangentConstantMode >, FBPropertyBaseEnum< EAreaLightShapes >, FBPropertyBaseEnum< enum FBParity >, FBPropertyBaseEnum< enum FBCameraStereoType >, FBPropertyBaseEnum< enum FBSceneChangeType >, FBPropertyBaseEnum< enum FBVideoProxyMode >, FBPropertyBaseEnum< enum FBDeformerType >, FBPropertyBaseEnum< enum FBTangentCustomIndex >, FBPropertyBaseEnum< enum FBCameraType >, FBPropertyBaseEnum< enum FBHUDElementVAlignment >, FBPropertyBaseEnum< enum FBTextureUseType >, FBPropertyBaseEnum< enum FBImageInterpolationType >, FBPropertyBaseEnum< enum FBSurfaceMode >, FBPropertyBaseEnum< enum FBLayerRotationMode >, and FBPropertyBaseEnum< enum FBMarkerLook >.

virtual const char* ClassName ( )
overridevirtual

internal System vars.

Reimplemented from FBPlug.

virtual const char* EnumList ( int  pIndex)
virtual

Return the string of an enum value.

Parameters
pIndexEnum value to get string for.
Returns
String value of enum specified by pIndex.

Reimplemented in FBPropertyBaseAnimatableEnum< tType >, FBPropertyBaseEnum< tType >, FBPropertyBaseEnum< enum FBNurbType >, FBPropertyBaseEnum< enum FBShadowFrameType >, FBPropertyBaseEnum< enum FBVideoInterlaceMode >, FBPropertyBaseEnum< enum FBStoryTrackRefMode >, FBPropertyBaseEnum< enum FBStoryTrackType >, FBPropertyBaseEnum< enum FBModelShadingMode >, FBPropertyBaseEnum< enum FBModelSelection >, FBPropertyBaseEnum< enum FBGeometryMappingMode >, FBPropertyBaseEnum< enum FBExtrapolationMode >, FBPropertyBaseEnum< enum FBInterpolation >, FBPropertyBaseEnum< enum FBImageFormat >, FBPropertyBaseEnum< enum FBCharacterKeyingMode >, FBPropertyBaseEnum< enum FBCharacterInputType >, FBPropertyBaseEnum< enum FBInsertSegmentMode >, FBPropertyBaseEnum< enum FBStoryClipSolveMode >, FBPropertyBaseEnum< enum FBRootXZMode >, FBPropertyBaseEnum< enum FBRootRMode >, FBPropertyBaseEnum< enum FBShadowType >, FBPropertyBaseEnum< enum FBHUDElementHAlignment >, FBPropertyBaseEnum< enum FBSkeletonResolutionLevel >, FBPropertyBaseEnum< enum FBCharacterRollSolver >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< enum FBPoseType >, FBPropertyBaseEnum< enum FBCharacterExtensionStancePoseMode >, FBPropertyBaseEnum< enum FBNewKeyInterpolationType >, FBPropertyBaseEnum< enum FBRSType >, FBPropertyBaseEnum< enum FBGapMode >, FBPropertyBaseEnum< enum FBTextureBlendMode >, FBPropertyBaseEnum< enum FBTakeSpanOnLoad >, FBPropertyBaseEnum< enum FBTransportSnapMode >, FBPropertyBaseEnum< enum FBSurfaceType >, FBPropertyBaseEnum< enum FBFogMode >, FBPropertyBaseEnum< enum FBCharacterHipsTranslationMode >, FBPropertyBaseEnum< EKeyPropertyBehavior >, FBPropertyBaseEnum< enum FBElementAction >, FBPropertyBaseEnum< enum FBSegmentMode >, FBPropertyBaseEnum< enum FBMarkerType >, FBPropertyBaseEnum< enum FBConnectionType >, FBPropertyBaseEnum< enum FBDeviceSamplingMode >, FBPropertyBaseEnum< enum FBCameraSamplingType >, FBPropertyBaseEnum< enum FBCameraFrameSizeMode >, FBPropertyBaseEnum< enum FBTransportLoopMode >, FBPropertyBaseEnum< enum FBImageInterleaveType >, FBPropertyBaseEnum< enum FBClusterMode >, FBPropertyBaseEnum< ELengthUnitType >, FBPropertyBaseEnum< enum FBGenerationMode >, FBPropertyBaseEnum< enum FBStoryClipMirrorPlane >, FBPropertyBaseEnum< enum FBCameraDistanceMode >, FBPropertyBaseEnum< enum FBLightType >, FBPropertyBaseEnum< enum FBImageType >, FBPropertyBaseEnum< enum FBCharacterContactBehaviour >, FBPropertyBaseEnum< enum FBStoryTrackGhostShowMode >, FBPropertyBaseEnum< enum FBSyncActivationAndVisibilityMode >, FBPropertyBaseEnum< enum FBEventAnimationNodeType >, FBPropertyBaseEnum< enum FBStoryClipShowGhostMode >, FBPropertyBaseEnum< enum FBRootSpeedMode >, FBPropertyBaseEnum< enum FBRootHMode >, FBPropertyBaseEnum< enum FBPlotAllowed >, FBPropertyBaseEnum< enum FBClipEnd >, FBPropertyBaseEnum< enum FBCameraAntiAliasingMethod >, FBPropertyBaseEnum< enum FBCameraSafeAreaMode >, FBPropertyBaseEnum< enum FBCameraResolutionMode >, FBPropertyBaseEnum< enum FBAttenuationType >, FBPropertyBaseEnum< enum FBPlayerControlChangeType >, FBPropertyBaseEnum< enum FBLayerMode >, FBPropertyBaseEnum< enum FBCharacterLoadAnimationMethod >, FBPropertyBaseEnum< enum FBStoryClipGhostTimeMode >, FBPropertyBaseEnum< enum FBVideoFormat >, FBPropertyBaseEnum< enum FBDeckTransportMode >, FBPropertyBaseEnum< enum FBTakeChangeType >, FBPropertyBaseEnum< enum FBUseChnMode >, FBPropertyBaseEnum< enum FBTangentMode >, FBPropertyBaseEnum< enum FBSkeletonLook >, FBPropertyBaseEnum< enum FBConnectionAction >, FBPropertyBaseEnum< enum FBControlSetType >, FBPropertyBaseEnum< enum FBCameraFocusDistanceSource >, FBPropertyBaseEnum< enum FBCameraViewPlaneMode >, FBPropertyBaseEnum< enum FBCameraApertureMode >, FBPropertyBaseEnum< enum FBTransportTimeFormat >, FBPropertyBaseEnum< enum FBAlphaSource >, FBPropertyBaseEnum< enum FBVideoResolution >, FBPropertyBaseEnum< enum FBConsoleChannelType >, FBPropertyBaseEnum< enum FBRigidBodyMode >, FBPropertyBaseEnum< enum FBRenderingPass >, FBPropertyBaseEnum< enum FBTangentClampMode >, FBPropertyBaseEnum< enum FBAnimationNodeConnectorType >, FBPropertyBaseEnum< enum FBPropertyStateEventType >, FBPropertyBaseEnum< enum FBCharacterExtensionRetargetMode >, FBPropertyBaseEnum< enum FBStoryClipChangeType >, FBPropertyBaseEnum< enum FBFCurveEventType >, FBPropertyBaseEnum< enum FBGeometryReferenceMode >, FBPropertyBaseEnum< enum FBTangentWeightMode >, FBPropertyBaseEnum< enum FBTextureMapping >, FBPropertyBaseEnum< enum FBMarkerResolutionLevel >, FBPropertyBaseEnum< enum FBModelRotationOrder >, FBPropertyBaseEnum< enum FBPlayMode >, FBPropertyBaseEnum< enum FBCustomKeyChangeType >, FBPropertyBaseEnum< enum FBCommPortType >, FBPropertyBaseEnum< enum FBFileFormatAndVersion >, FBPropertyBaseEnum< enum FBStoryClipNodeFunction >, FBPropertyBaseEnum< enum FBVideoStorageMode >, FBPropertyBaseEnum< enum FBAccessMode >, FBPropertyBaseEnum< enum FBCameraFilmBackType >, FBPropertyBaseEnum< enum FBFileMonitoringType >, FBPropertyBaseEnum< enum FBTimeReferential >, FBPropertyBaseEnum< enum FBCommandState >, FBPropertyBaseEnum< enum FBControllerMode >, FBPropertyBaseEnum< enum FBStoryClipTimeWarpInterpolatorType >, FBPropertyBaseEnum< enum FBParallelScheduleType >, FBPropertyBaseEnum< enum FBProfilingMode >, FBPropertyBaseEnum< enum FBTangentConstantMode >, FBPropertyBaseEnum< EAreaLightShapes >, FBPropertyBaseEnum< enum FBParity >, FBPropertyBaseEnum< enum FBCameraStereoType >, FBPropertyBaseEnum< enum FBSceneChangeType >, FBPropertyBaseEnum< enum FBVideoProxyMode >, FBPropertyBaseEnum< enum FBDeformerType >, FBPropertyBaseEnum< enum FBTangentCustomIndex >, FBPropertyBaseEnum< enum FBCameraType >, FBPropertyBaseEnum< enum FBHUDElementVAlignment >, FBPropertyBaseEnum< enum FBTextureUseType >, FBPropertyBaseEnum< enum FBImageInterpolationType >, FBPropertyBaseEnum< enum FBSurfaceMode >, FBPropertyBaseEnum< enum FBLayerRotationMode >, and FBPropertyBaseEnum< enum FBMarkerLook >.

virtual void FBDelete ( )
overridevirtual

Actual destructor for a FBPlug.

It should never be called from client code. This is meant for internal use only!

Reimplemented from FBPlug.

virtual void GetData ( void *  pData,
int  pSize,
FBEvaluateInfo pEvalInfo = ((void *) 0) 
) const
virtual

Get the value of a property.

Return values
pDataValue to fill with property's current value.
Parameters
pSizeSize of pData buffer
pEvalInfoUsed only with animated properties

Reimplemented in FBPropertyAnimatable, FBPropertyBase< tType, pPT >, FBPropertyBase< enum FBControlSetType, kFBPT_enum >, FBPropertyBase< enum FBCharacterExtensionRetargetMode, kFBPT_enum >, FBPropertyBase< enum FBDeviceSamplingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraDistanceMode, kFBPT_enum >, FBPropertyBase< enum FBCameraType, kFBPT_enum >, FBPropertyBase< enum FBAnimationNodeConnectorType, kFBPT_enum >, FBPropertyBase< enum FBEventAnimationNodeType, kFBPT_enum >, FBPropertyBase< enum FBClusterMode, kFBPT_enum >, FBPropertyBase< enum FBSkeletonResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBCharacterLoadAnimationMethod, kFBPT_enum >, FBPropertyBase< FBMarkerSet *, kFBPT_object >, FBPropertyBase< enum FBAccessMode, kFBPT_enum >, FBPropertyBase< enum FBTangentCustomIndex, kFBPT_enum >, FBPropertyBase< enum FBTangentConstantMode, kFBPT_enum >, FBPropertyBase< enum FBRSType, kFBPT_enum >, FBPropertyBase< enum FBImageType, kFBPT_enum >, FBPropertyBase< FBModelTemplate *, kFBPT_object >, FBPropertyBase< enum FBTakeSpanOnLoad, kFBPT_enum >, FBPropertyBase< enum FBStoryClipNodeFunction, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< enum FBVideoFormat, kFBPT_enum >, FBPropertyBase< enum FBVideoStorageMode, kFBPT_enum >, FBPropertyBase< FBStoryTrack *, kFBPT_object >, FBPropertyBase< enum FBStoryTrackType, kFBPT_enum >, FBPropertyBase< FBModelVertexData *, kFBPT_object >, FBPropertyBase< enum FBProfilingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraSamplingType, kFBPT_enum >, FBPropertyBase< enum FBGapMode, kFBPT_enum >, FBPropertyBase< enum FBFogMode, kFBPT_enum >, FBPropertyBase< FBPointCacheFile *, kFBPT_object >, FBPropertyBase< enum FBCharacterRollSolver, kFBPT_enum >, FBPropertyBase< FBRenderer *, kFBPT_object >, FBPropertyBase< enum FBInsertSegmentMode, kFBPT_enum >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< enum FBCharacterExtensionStancePoseMode, kFBPT_enum >, FBPropertyBase< enum FBUseChnMode, kFBPT_enum >, FBPropertyBase< enum FBTangentClampMode, kFBPT_enum >, FBPropertyBase< enum FBCameraAntiAliasingMethod, kFBPT_enum >, FBPropertyBase< enum FBCameraApertureMode, kFBPT_enum >, FBPropertyBase< enum FBAttenuationType, kFBPT_enum >, FBPropertyBase< enum FBLightType, kFBPT_enum >, FBPropertyBase< enum FBCommPortType, kFBPT_enum >, FBPropertyBase< enum FBTextureUseType, kFBPT_enum >, FBPropertyBase< enum FBConsoleChannelType, kFBPT_enum >, FBPropertyBase< enum FBConnectionAction, kFBPT_enum >, FBPropertyBase< enum FBStoryClipGhostTimeMode, kFBPT_enum >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< enum FBDeckTransportMode, kFBPT_enum >, FBPropertyBase< FBCluster *, kFBPT_object >, FBPropertyBase< enum FBGeometryReferenceMode, kFBPT_enum >, FBPropertyBase< FBConstraint *, kFBPT_object >, FBPropertyBase< enum FBVideoResolution, kFBPT_enum >, FBPropertyBase< FBBox *, kFBPT_object >, FBPropertyBase< enum FBCameraStereoType, kFBPT_enum >, FBPropertyBase< enum FBCharacterKeyingMode, kFBPT_enum >, FBPropertyBase< enum FBGenerationMode, kFBPT_enum >, FBPropertyBase< FBDeviceCameraPacket *, kFBPT_object >, FBPropertyBase< enum FBRootRMode, kFBPT_enum >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< enum FBDeformerType, kFBPT_enum >, FBPropertyBase< enum FBCameraSafeAreaMode, kFBPT_enum >, FBPropertyBase< enum FBCameraFilmBackType, kFBPT_enum >, FBPropertyBase< enum FBHUDElementHAlignment, kFBPT_enum >, FBPropertyBase< enum FBPropertyStateEventType, kFBPT_enum >, FBPropertyBase< FBAssetMng *, kFBPT_object >, FBPropertyBase< FBVideo *, kFBPT_object >, FBPropertyBase< enum FBMarkerLook, kFBPT_enum >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBModelOptical *, kFBPT_object >, FBPropertyBase< enum FBCharacterContactBehaviour, kFBPT_enum >, FBPropertyBase< enum FBConnectionType, kFBPT_enum >, FBPropertyBase< enum FBNewKeyInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBTangentWeightMode, kFBPT_enum >, FBPropertyBase< enum FBTransportSnapMode, kFBPT_enum >, FBPropertyBase< enum FBFileMonitoringType, kFBPT_enum >, FBPropertyBase< enum FBInterpolation, kFBPT_enum >, FBPropertyBase< enum FBSceneChangeType, kFBPT_enum >, FBPropertyBase< enum FBTimeReferential, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackRefMode, kFBPT_enum >, FBPropertyBase< enum FBModelShadingMode, kFBPT_enum >, FBPropertyBase< enum FBGeometryMappingMode, kFBPT_enum >, FBPropertyBase< FBAudioOut *, kFBPT_object >, FBPropertyBase< enum FBTransportLoopMode, kFBPT_enum >, FBPropertyBase< enum FBPlayerControlChangeType, kFBPT_enum >, FBPropertyBase< enum FBCharacterHipsTranslationMode, kFBPT_enum >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBModel *, kFBPT_object >, FBPropertyBase< enum FBSegmentMode, kFBPT_enum >, FBPropertyBase< enum FBStoryClipMirrorPlane, kFBPT_enum >, FBPropertyBase< enum FBStoryClipSolveMode, kFBPT_enum >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< enum FBCustomKeyChangeType, kFBPT_enum >, FBPropertyBase< enum FBImageInterleaveType, kFBPT_enum >, FBPropertyBase< FBDevice *, kFBPT_object >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< enum FBShadowFrameType, kFBPT_enum >, FBPropertyBase< enum FBModelRotationOrder, kFBPT_enum >, FBPropertyBase< enum FBExtrapolationMode, kFBPT_enum >, FBPropertyBase< enum FBTangentMode, kFBPT_enum >, FBPropertyBase< enum FBSurfaceType, kFBPT_enum >, FBPropertyBase< enum FBParity, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< enum FBSkeletonLook, kFBPT_enum >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< enum FBControllerMode, kFBPT_enum >, FBPropertyBase< enum FBMarkerType, kFBPT_enum >, FBPropertyBase< enum FBRootSpeedMode, kFBPT_enum >, FBPropertyBase< enum FBClipEnd, kFBPT_enum >, FBPropertyBase< enum FBTransportTimeFormat, kFBPT_enum >, FBPropertyBase< FBActorFace *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, FBPropertyBase< FBScene *, kFBPT_object >, FBPropertyBase< EKeyPropertyBehavior, kFBPT_enum >, FBPropertyBase< enum FBElementAction, kFBPT_enum >, FBPropertyBase< enum FBPoseType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipTimeWarpInterpolatorType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipShowGhostMode, kFBPT_enum >, FBPropertyBase< enum FBRootXZMode, kFBPT_enum >, FBPropertyBase< enum FBVideoProxyMode, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackGhostShowMode, kFBPT_enum >, FBPropertyBase< enum FBSyncActivationAndVisibilityMode, kFBPT_enum >, FBPropertyBase< FBVideoSwitcher *, kFBPT_object >, FBPropertyBase< enum FBTakeChangeType, kFBPT_enum >, FBPropertyBase< enum FBNurbType, kFBPT_enum >, FBPropertyBase< enum FBCameraViewPlaneMode, kFBPT_enum >, FBPropertyBase< enum FBTextureBlendMode, kFBPT_enum >, FBPropertyBase< FBStoryFolder *, kFBPT_object >, FBPropertyBase< enum FBLayerMode, kFBPT_enum >, FBPropertyBase< enum FBFileFormatAndVersion, kFBPT_enum >, FBPropertyBase< enum FBMarkerResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBShadowType, kFBPT_enum >, FBPropertyBase< FBHUD *, kFBPT_object >, FBPropertyBase< enum FBStoryClipChangeType, kFBPT_enum >, FBPropertyBase< float, kFBPT_float >, FBPropertyBase< enum FBCameraFrameSizeMode, kFBPT_enum >, FBPropertyBase< enum FBTextureMapping, kFBPT_enum >, FBPropertyBase< enum FBImageInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBCharacterInputType, kFBPT_enum >, FBPropertyBase< FBConstructionHistory *, kFBPT_object >, FBPropertyBase< FBFCurve *, kFBPT_object >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< enum FBCommandState, kFBPT_enum >, FBPropertyBase< FBAudioClip *, kFBPT_object >, FBPropertyBase< enum FBParallelScheduleType, kFBPT_enum >, FBPropertyBase< enum FBCameraResolutionMode, kFBPT_enum >, FBPropertyBase< enum FBAlphaSource, kFBPT_enum >, FBPropertyBase< enum FBHUDElementVAlignment, kFBPT_enum >, FBPropertyBase< enum FBSurfaceMode, kFBPT_enum >, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< enum FBRigidBodyMode, kFBPT_enum >, FBPropertyBase< FBTake *, kFBPT_object >, FBPropertyBase< FBCharacter *, kFBPT_object >, FBPropertyBase< FBActor *, kFBPT_object >, FBPropertyBase< enum FBVideoInterlaceMode, kFBPT_enum >, FBPropertyBase< enum FBPlayMode, kFBPT_enum >, FBPropertyBase< enum FBRenderingPass, kFBPT_enum >, FBPropertyBase< enum FBModelSelection, kFBPT_enum >, FBPropertyBase< enum FBFCurveEventType, kFBPT_enum >, FBPropertyBase< enum FBCameraFocusDistanceSource, kFBPT_enum >, FBPropertyBase< FBCamera *, kFBPT_object >, FBPropertyBase< enum FBPlotAllowed, kFBPT_enum >, FBPropertyBase< FBMesh *, kFBPT_object >, FBPropertyBase< FBGeometry *, kFBPT_object >, FBPropertyBase< FBTexture *, kFBPT_object >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< enum FBImageFormat, kFBPT_enum >, FBPropertyBase< FBModelMarkerOptical *, kFBPT_object >, FBPropertyBase< enum FBLayerRotationMode, kFBPT_enum >, FBPropertyBase< FBFolder *, kFBPT_object >, FBPropertyBase< FBAnimationNode *, kFBPT_object >, and FBPropertyBase< enum FBRootHMode, kFBPT_enum >.

virtual KDataType* GetDataType ( )
virtual

Get the property datatype pointer.

Returns
Datatype of property (NULL in the case of the FBProperty is not internal).

Reimplemented in FBPropertyAnimatable.

FBStringList* GetEnumStringList ( bool  pCreateIt = false)

String list for enum properties.

Parameters
pCreateItCreate a new list if necessary.
Returns
the pointer to the string list..
double GetMax ( )

GetMax.

Returns
Maximum value for the property.
double GetMin ( )

GetMin.

Returns
Minimum value for the property.
const char* GetName ( )

Get the property's name.

Returns
The property's name.
void* GetParent ( )
inline

Get the parent of the object.

Returns
Parent object.

Definition at line 420 of file fbproperties.h.

420 { return mParent; }
void * mParent
mParent Parent of the property.
Definition: fbproperties.h:200
bool GetPropertyFlag ( FBPropertyFlag  pFlag)

GetPropertyFlag.

Parameters
pFlagFlag to test if it is True or False.
Returns
If the flag is True, the function returns True and vice-versa.
Warning
Flags are not saved into or read from a FBX file.
FBPropertyFlag GetPropertyFlags ( )

GetPropertyFlags.

Returns
Return all flags at once.
virtual FBPropertyType GetPropertyType ( )
virtual

Get the property's type.

Returns
The property's type.

Reimplemented in FBPropertyBaseAnimatable< tType, pPT >, FBPropertyBaseAnimatable< FBColor, kFBPT_ColorRGB >, FBPropertyBaseAnimatable< int, kFBPT_enum >, FBPropertyBaseAnimatable< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBaseAnimatable< double, kFBPT_double >, FBPropertyBaseAnimatable< bool, kFBPT_bool >, FBPropertyBaseAnimatable< FBVector3d, kFBPT_Vector3D >, FBPropertyStringList, FBPropertyBase< tType, pPT >, FBPropertyBase< enum FBControlSetType, kFBPT_enum >, FBPropertyBase< enum FBCharacterExtensionRetargetMode, kFBPT_enum >, FBPropertyBase< enum FBDeviceSamplingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraDistanceMode, kFBPT_enum >, FBPropertyBase< enum FBCameraType, kFBPT_enum >, FBPropertyBase< enum FBAnimationNodeConnectorType, kFBPT_enum >, FBPropertyBase< enum FBEventAnimationNodeType, kFBPT_enum >, FBPropertyBase< enum FBClusterMode, kFBPT_enum >, FBPropertyBase< enum FBSkeletonResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBCharacterLoadAnimationMethod, kFBPT_enum >, FBPropertyBase< FBMarkerSet *, kFBPT_object >, FBPropertyBase< enum FBAccessMode, kFBPT_enum >, FBPropertyBase< enum FBTangentCustomIndex, kFBPT_enum >, FBPropertyBase< enum FBTangentConstantMode, kFBPT_enum >, FBPropertyBase< enum FBRSType, kFBPT_enum >, FBPropertyBase< enum FBImageType, kFBPT_enum >, FBPropertyBase< FBModelTemplate *, kFBPT_object >, FBPropertyBase< enum FBTakeSpanOnLoad, kFBPT_enum >, FBPropertyBase< enum FBStoryClipNodeFunction, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< enum FBVideoFormat, kFBPT_enum >, FBPropertyBase< enum FBVideoStorageMode, kFBPT_enum >, FBPropertyBase< FBStoryTrack *, kFBPT_object >, FBPropertyBase< enum FBStoryTrackType, kFBPT_enum >, FBPropertyBase< FBModelVertexData *, kFBPT_object >, FBPropertyBase< enum FBProfilingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraSamplingType, kFBPT_enum >, FBPropertyBase< enum FBGapMode, kFBPT_enum >, FBPropertyBase< enum FBFogMode, kFBPT_enum >, FBPropertyBase< FBPointCacheFile *, kFBPT_object >, FBPropertyBase< enum FBCharacterRollSolver, kFBPT_enum >, FBPropertyBase< FBRenderer *, kFBPT_object >, FBPropertyBase< enum FBInsertSegmentMode, kFBPT_enum >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< enum FBCharacterExtensionStancePoseMode, kFBPT_enum >, FBPropertyBase< enum FBUseChnMode, kFBPT_enum >, FBPropertyBase< enum FBTangentClampMode, kFBPT_enum >, FBPropertyBase< enum FBCameraAntiAliasingMethod, kFBPT_enum >, FBPropertyBase< enum FBCameraApertureMode, kFBPT_enum >, FBPropertyBase< enum FBAttenuationType, kFBPT_enum >, FBPropertyBase< enum FBLightType, kFBPT_enum >, FBPropertyBase< enum FBCommPortType, kFBPT_enum >, FBPropertyBase< enum FBTextureUseType, kFBPT_enum >, FBPropertyBase< enum FBConsoleChannelType, kFBPT_enum >, FBPropertyBase< enum FBConnectionAction, kFBPT_enum >, FBPropertyBase< enum FBStoryClipGhostTimeMode, kFBPT_enum >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< enum FBDeckTransportMode, kFBPT_enum >, FBPropertyBase< FBCluster *, kFBPT_object >, FBPropertyBase< enum FBGeometryReferenceMode, kFBPT_enum >, FBPropertyBase< FBConstraint *, kFBPT_object >, FBPropertyBase< enum FBVideoResolution, kFBPT_enum >, FBPropertyBase< FBBox *, kFBPT_object >, FBPropertyBase< enum FBCameraStereoType, kFBPT_enum >, FBPropertyBase< enum FBCharacterKeyingMode, kFBPT_enum >, FBPropertyBase< enum FBGenerationMode, kFBPT_enum >, FBPropertyBase< FBDeviceCameraPacket *, kFBPT_object >, FBPropertyBase< enum FBRootRMode, kFBPT_enum >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< enum FBDeformerType, kFBPT_enum >, FBPropertyBase< enum FBCameraSafeAreaMode, kFBPT_enum >, FBPropertyBase< enum FBCameraFilmBackType, kFBPT_enum >, FBPropertyBase< enum FBHUDElementHAlignment, kFBPT_enum >, FBPropertyBase< enum FBPropertyStateEventType, kFBPT_enum >, FBPropertyBase< FBAssetMng *, kFBPT_object >, FBPropertyBase< FBVideo *, kFBPT_object >, FBPropertyBase< enum FBMarkerLook, kFBPT_enum >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBModelOptical *, kFBPT_object >, FBPropertyBase< enum FBCharacterContactBehaviour, kFBPT_enum >, FBPropertyBase< enum FBConnectionType, kFBPT_enum >, FBPropertyBase< enum FBNewKeyInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBTangentWeightMode, kFBPT_enum >, FBPropertyBase< enum FBTransportSnapMode, kFBPT_enum >, FBPropertyBase< enum FBFileMonitoringType, kFBPT_enum >, FBPropertyBase< enum FBInterpolation, kFBPT_enum >, FBPropertyBase< enum FBSceneChangeType, kFBPT_enum >, FBPropertyBase< enum FBTimeReferential, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackRefMode, kFBPT_enum >, FBPropertyBase< enum FBModelShadingMode, kFBPT_enum >, FBPropertyBase< enum FBGeometryMappingMode, kFBPT_enum >, FBPropertyBase< FBAudioOut *, kFBPT_object >, FBPropertyBase< enum FBTransportLoopMode, kFBPT_enum >, FBPropertyBase< enum FBPlayerControlChangeType, kFBPT_enum >, FBPropertyBase< enum FBCharacterHipsTranslationMode, kFBPT_enum >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBModel *, kFBPT_object >, FBPropertyBase< enum FBSegmentMode, kFBPT_enum >, FBPropertyBase< enum FBStoryClipMirrorPlane, kFBPT_enum >, FBPropertyBase< enum FBStoryClipSolveMode, kFBPT_enum >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< enum FBCustomKeyChangeType, kFBPT_enum >, FBPropertyBase< enum FBImageInterleaveType, kFBPT_enum >, FBPropertyBase< FBDevice *, kFBPT_object >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< enum FBShadowFrameType, kFBPT_enum >, FBPropertyBase< enum FBModelRotationOrder, kFBPT_enum >, FBPropertyBase< enum FBExtrapolationMode, kFBPT_enum >, FBPropertyBase< enum FBTangentMode, kFBPT_enum >, FBPropertyBase< enum FBSurfaceType, kFBPT_enum >, FBPropertyBase< enum FBParity, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< enum FBSkeletonLook, kFBPT_enum >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< enum FBControllerMode, kFBPT_enum >, FBPropertyBase< enum FBMarkerType, kFBPT_enum >, FBPropertyBase< enum FBRootSpeedMode, kFBPT_enum >, FBPropertyBase< enum FBClipEnd, kFBPT_enum >, FBPropertyBase< enum FBTransportTimeFormat, kFBPT_enum >, FBPropertyBase< FBActorFace *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, FBPropertyBase< FBScene *, kFBPT_object >, FBPropertyBase< EKeyPropertyBehavior, kFBPT_enum >, FBPropertyBase< enum FBElementAction, kFBPT_enum >, FBPropertyBase< enum FBPoseType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipTimeWarpInterpolatorType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipShowGhostMode, kFBPT_enum >, FBPropertyBase< enum FBRootXZMode, kFBPT_enum >, FBPropertyBase< enum FBVideoProxyMode, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackGhostShowMode, kFBPT_enum >, FBPropertyBase< enum FBSyncActivationAndVisibilityMode, kFBPT_enum >, FBPropertyBase< FBVideoSwitcher *, kFBPT_object >, FBPropertyBase< enum FBTakeChangeType, kFBPT_enum >, FBPropertyBase< enum FBNurbType, kFBPT_enum >, FBPropertyBase< enum FBCameraViewPlaneMode, kFBPT_enum >, FBPropertyBase< enum FBTextureBlendMode, kFBPT_enum >, FBPropertyBase< FBStoryFolder *, kFBPT_object >, FBPropertyBase< enum FBLayerMode, kFBPT_enum >, FBPropertyBase< enum FBFileFormatAndVersion, kFBPT_enum >, FBPropertyBase< enum FBMarkerResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBShadowType, kFBPT_enum >, FBPropertyBase< FBHUD *, kFBPT_object >, FBPropertyBase< enum FBStoryClipChangeType, kFBPT_enum >, FBPropertyBase< float, kFBPT_float >, FBPropertyBase< enum FBCameraFrameSizeMode, kFBPT_enum >, FBPropertyBase< enum FBTextureMapping, kFBPT_enum >, FBPropertyBase< enum FBImageInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBCharacterInputType, kFBPT_enum >, FBPropertyBase< FBConstructionHistory *, kFBPT_object >, FBPropertyBase< FBFCurve *, kFBPT_object >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< enum FBCommandState, kFBPT_enum >, FBPropertyBase< FBAudioClip *, kFBPT_object >, FBPropertyBase< enum FBParallelScheduleType, kFBPT_enum >, FBPropertyBase< enum FBCameraResolutionMode, kFBPT_enum >, FBPropertyBase< enum FBAlphaSource, kFBPT_enum >, FBPropertyBase< enum FBHUDElementVAlignment, kFBPT_enum >, FBPropertyBase< enum FBSurfaceMode, kFBPT_enum >, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< enum FBRigidBodyMode, kFBPT_enum >, FBPropertyBase< FBTake *, kFBPT_object >, FBPropertyBase< FBCharacter *, kFBPT_object >, FBPropertyBase< FBActor *, kFBPT_object >, FBPropertyBase< enum FBVideoInterlaceMode, kFBPT_enum >, FBPropertyBase< enum FBPlayMode, kFBPT_enum >, FBPropertyBase< enum FBRenderingPass, kFBPT_enum >, FBPropertyBase< enum FBModelSelection, kFBPT_enum >, FBPropertyBase< enum FBFCurveEventType, kFBPT_enum >, FBPropertyBase< enum FBCameraFocusDistanceSource, kFBPT_enum >, FBPropertyBase< FBCamera *, kFBPT_object >, FBPropertyBase< enum FBPlotAllowed, kFBPT_enum >, FBPropertyBase< FBMesh *, kFBPT_object >, FBPropertyBase< FBGeometry *, kFBPT_object >, FBPropertyBase< FBTexture *, kFBPT_object >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< enum FBImageFormat, kFBPT_enum >, FBPropertyBase< FBModelMarkerOptical *, kFBPT_object >, FBPropertyBase< enum FBLayerRotationMode, kFBPT_enum >, FBPropertyBase< FBFolder *, kFBPT_object >, FBPropertyBase< FBAnimationNode *, kFBPT_object >, FBPropertyBase< enum FBRootHMode, kFBPT_enum >, FBPropertyEvent, and FBPropertyListComponentBase.

const char* GetPropertyTypeName ( )

Get the property's type name.

Returns
The property's type name.
int GetSubMemberCount ( ) const

GetSubMemberCount.

Returns
Number of sub-members.
virtual int GetTypeId ( )
overridevirtual

GetTypeId( int pTypeId )

Returns
The TypeInfo of the object

Reimplemented from FBPlug.

bool HasSomethingLocked ( ) const

HasSomethingLocked.

Returns
true if property or any of its members is locked
virtual bool Is ( int  pTypeId)
overridevirtual

Is( int pTypeId )

Parameters
pTypeIdType Identification.
Returns
True if Plug is a Instance of pTypeId.

Reimplemented from FBPlug.

virtual bool IsAnimatable ( )
virtual

Reimplemented in FBPropertyAnimatable.

bool IsAnimated ( ) const

Get the property animated flag status.

bool IsInternal ( ) const
virtual bool IsList ( )
virtual

Verify if property is of this type.

Returns
true if property is of type.

Reimplemented in FBPropertyStringList, and FBPropertyBasicList.

bool IsLocked ( ) const

IsLocked.

Returns
true if property is locked
bool IsMaxClamp ( )

Indicate if maximum value clamping will be applied on user input value.

Returns
true if property the value will be clamped to a maximum value.
bool IsMemberLocked ( int  pIndex) const

IsMemberLocked.

Parameters
pIndexIndex of the sub-member of the property to check.
Returns
true if property sub-member is locked
bool IsMinClamp ( )

Indicate if minimum value clamping will be applied on user input value.

Returns
true if property the value will be clamped to a minimum value.
bool IsObjectList ( )

Indicate if is an instance of FBPropertyListObject.

Warning
A FBPropertyListObject will also return true on a call to 'IsList()'.
virtual bool IsReadOnly ( )
virtual

Is property read-only?

Returns
true if property is read-only.

Reimplemented in FBPropertyBase< tType, pPT >, FBPropertyBase< enum FBControlSetType, kFBPT_enum >, FBPropertyBase< enum FBCharacterExtensionRetargetMode, kFBPT_enum >, FBPropertyBase< enum FBDeviceSamplingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraDistanceMode, kFBPT_enum >, FBPropertyBase< enum FBCameraType, kFBPT_enum >, FBPropertyBase< enum FBAnimationNodeConnectorType, kFBPT_enum >, FBPropertyBase< enum FBEventAnimationNodeType, kFBPT_enum >, FBPropertyBase< enum FBClusterMode, kFBPT_enum >, FBPropertyBase< enum FBSkeletonResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBCharacterLoadAnimationMethod, kFBPT_enum >, FBPropertyBase< FBMarkerSet *, kFBPT_object >, FBPropertyBase< enum FBAccessMode, kFBPT_enum >, FBPropertyBase< enum FBTangentCustomIndex, kFBPT_enum >, FBPropertyBase< enum FBTangentConstantMode, kFBPT_enum >, FBPropertyBase< enum FBRSType, kFBPT_enum >, FBPropertyBase< enum FBImageType, kFBPT_enum >, FBPropertyBase< FBModelTemplate *, kFBPT_object >, FBPropertyBase< enum FBTakeSpanOnLoad, kFBPT_enum >, FBPropertyBase< enum FBStoryClipNodeFunction, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< enum FBVideoFormat, kFBPT_enum >, FBPropertyBase< enum FBVideoStorageMode, kFBPT_enum >, FBPropertyBase< FBStoryTrack *, kFBPT_object >, FBPropertyBase< enum FBStoryTrackType, kFBPT_enum >, FBPropertyBase< FBModelVertexData *, kFBPT_object >, FBPropertyBase< enum FBProfilingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraSamplingType, kFBPT_enum >, FBPropertyBase< enum FBGapMode, kFBPT_enum >, FBPropertyBase< enum FBFogMode, kFBPT_enum >, FBPropertyBase< FBPointCacheFile *, kFBPT_object >, FBPropertyBase< enum FBCharacterRollSolver, kFBPT_enum >, FBPropertyBase< FBRenderer *, kFBPT_object >, FBPropertyBase< enum FBInsertSegmentMode, kFBPT_enum >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< enum FBCharacterExtensionStancePoseMode, kFBPT_enum >, FBPropertyBase< enum FBUseChnMode, kFBPT_enum >, FBPropertyBase< enum FBTangentClampMode, kFBPT_enum >, FBPropertyBase< enum FBCameraAntiAliasingMethod, kFBPT_enum >, FBPropertyBase< enum FBCameraApertureMode, kFBPT_enum >, FBPropertyBase< enum FBAttenuationType, kFBPT_enum >, FBPropertyBase< enum FBLightType, kFBPT_enum >, FBPropertyBase< enum FBCommPortType, kFBPT_enum >, FBPropertyBase< enum FBTextureUseType, kFBPT_enum >, FBPropertyBase< enum FBConsoleChannelType, kFBPT_enum >, FBPropertyBase< enum FBConnectionAction, kFBPT_enum >, FBPropertyBase< enum FBStoryClipGhostTimeMode, kFBPT_enum >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< enum FBDeckTransportMode, kFBPT_enum >, FBPropertyBase< FBCluster *, kFBPT_object >, FBPropertyBase< enum FBGeometryReferenceMode, kFBPT_enum >, FBPropertyBase< FBConstraint *, kFBPT_object >, FBPropertyBase< enum FBVideoResolution, kFBPT_enum >, FBPropertyBase< FBBox *, kFBPT_object >, FBPropertyBase< enum FBCameraStereoType, kFBPT_enum >, FBPropertyBase< enum FBCharacterKeyingMode, kFBPT_enum >, FBPropertyBase< enum FBGenerationMode, kFBPT_enum >, FBPropertyBase< FBDeviceCameraPacket *, kFBPT_object >, FBPropertyBase< enum FBRootRMode, kFBPT_enum >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< enum FBDeformerType, kFBPT_enum >, FBPropertyBase< enum FBCameraSafeAreaMode, kFBPT_enum >, FBPropertyBase< enum FBCameraFilmBackType, kFBPT_enum >, FBPropertyBase< enum FBHUDElementHAlignment, kFBPT_enum >, FBPropertyBase< enum FBPropertyStateEventType, kFBPT_enum >, FBPropertyBase< FBAssetMng *, kFBPT_object >, FBPropertyBase< FBVideo *, kFBPT_object >, FBPropertyBase< enum FBMarkerLook, kFBPT_enum >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBModelOptical *, kFBPT_object >, FBPropertyBase< enum FBCharacterContactBehaviour, kFBPT_enum >, FBPropertyBase< enum FBConnectionType, kFBPT_enum >, FBPropertyBase< enum FBNewKeyInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBTangentWeightMode, kFBPT_enum >, FBPropertyBase< enum FBTransportSnapMode, kFBPT_enum >, FBPropertyBase< enum FBFileMonitoringType, kFBPT_enum >, FBPropertyBase< enum FBInterpolation, kFBPT_enum >, FBPropertyBase< enum FBSceneChangeType, kFBPT_enum >, FBPropertyBase< enum FBTimeReferential, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackRefMode, kFBPT_enum >, FBPropertyBase< enum FBModelShadingMode, kFBPT_enum >, FBPropertyBase< enum FBGeometryMappingMode, kFBPT_enum >, FBPropertyBase< FBAudioOut *, kFBPT_object >, FBPropertyBase< enum FBTransportLoopMode, kFBPT_enum >, FBPropertyBase< enum FBPlayerControlChangeType, kFBPT_enum >, FBPropertyBase< enum FBCharacterHipsTranslationMode, kFBPT_enum >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBModel *, kFBPT_object >, FBPropertyBase< enum FBSegmentMode, kFBPT_enum >, FBPropertyBase< enum FBStoryClipMirrorPlane, kFBPT_enum >, FBPropertyBase< enum FBStoryClipSolveMode, kFBPT_enum >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< enum FBCustomKeyChangeType, kFBPT_enum >, FBPropertyBase< enum FBImageInterleaveType, kFBPT_enum >, FBPropertyBase< FBDevice *, kFBPT_object >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< enum FBShadowFrameType, kFBPT_enum >, FBPropertyBase< enum FBModelRotationOrder, kFBPT_enum >, FBPropertyBase< enum FBExtrapolationMode, kFBPT_enum >, FBPropertyBase< enum FBTangentMode, kFBPT_enum >, FBPropertyBase< enum FBSurfaceType, kFBPT_enum >, FBPropertyBase< enum FBParity, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< enum FBSkeletonLook, kFBPT_enum >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< enum FBControllerMode, kFBPT_enum >, FBPropertyBase< enum FBMarkerType, kFBPT_enum >, FBPropertyBase< enum FBRootSpeedMode, kFBPT_enum >, FBPropertyBase< enum FBClipEnd, kFBPT_enum >, FBPropertyBase< enum FBTransportTimeFormat, kFBPT_enum >, FBPropertyBase< FBActorFace *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, FBPropertyBase< FBScene *, kFBPT_object >, FBPropertyBase< EKeyPropertyBehavior, kFBPT_enum >, FBPropertyBase< enum FBElementAction, kFBPT_enum >, FBPropertyBase< enum FBPoseType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipTimeWarpInterpolatorType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipShowGhostMode, kFBPT_enum >, FBPropertyBase< enum FBRootXZMode, kFBPT_enum >, FBPropertyBase< enum FBVideoProxyMode, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackGhostShowMode, kFBPT_enum >, FBPropertyBase< enum FBSyncActivationAndVisibilityMode, kFBPT_enum >, FBPropertyBase< FBVideoSwitcher *, kFBPT_object >, FBPropertyBase< enum FBTakeChangeType, kFBPT_enum >, FBPropertyBase< enum FBNurbType, kFBPT_enum >, FBPropertyBase< enum FBCameraViewPlaneMode, kFBPT_enum >, FBPropertyBase< enum FBTextureBlendMode, kFBPT_enum >, FBPropertyBase< FBStoryFolder *, kFBPT_object >, FBPropertyBase< enum FBLayerMode, kFBPT_enum >, FBPropertyBase< enum FBFileFormatAndVersion, kFBPT_enum >, FBPropertyBase< enum FBMarkerResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBShadowType, kFBPT_enum >, FBPropertyBase< FBHUD *, kFBPT_object >, FBPropertyBase< enum FBStoryClipChangeType, kFBPT_enum >, FBPropertyBase< float, kFBPT_float >, FBPropertyBase< enum FBCameraFrameSizeMode, kFBPT_enum >, FBPropertyBase< enum FBTextureMapping, kFBPT_enum >, FBPropertyBase< enum FBImageInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBCharacterInputType, kFBPT_enum >, FBPropertyBase< FBConstructionHistory *, kFBPT_object >, FBPropertyBase< FBFCurve *, kFBPT_object >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< enum FBCommandState, kFBPT_enum >, FBPropertyBase< FBAudioClip *, kFBPT_object >, FBPropertyBase< enum FBParallelScheduleType, kFBPT_enum >, FBPropertyBase< enum FBCameraResolutionMode, kFBPT_enum >, FBPropertyBase< enum FBAlphaSource, kFBPT_enum >, FBPropertyBase< enum FBHUDElementVAlignment, kFBPT_enum >, FBPropertyBase< enum FBSurfaceMode, kFBPT_enum >, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< enum FBRigidBodyMode, kFBPT_enum >, FBPropertyBase< FBTake *, kFBPT_object >, FBPropertyBase< FBCharacter *, kFBPT_object >, FBPropertyBase< FBActor *, kFBPT_object >, FBPropertyBase< enum FBVideoInterlaceMode, kFBPT_enum >, FBPropertyBase< enum FBPlayMode, kFBPT_enum >, FBPropertyBase< enum FBRenderingPass, kFBPT_enum >, FBPropertyBase< enum FBModelSelection, kFBPT_enum >, FBPropertyBase< enum FBFCurveEventType, kFBPT_enum >, FBPropertyBase< enum FBCameraFocusDistanceSource, kFBPT_enum >, FBPropertyBase< FBCamera *, kFBPT_object >, FBPropertyBase< enum FBPlotAllowed, kFBPT_enum >, FBPropertyBase< FBMesh *, kFBPT_object >, FBPropertyBase< FBGeometry *, kFBPT_object >, FBPropertyBase< FBTexture *, kFBPT_object >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< enum FBImageFormat, kFBPT_enum >, FBPropertyBase< FBModelMarkerOptical *, kFBPT_object >, FBPropertyBase< enum FBLayerRotationMode, kFBPT_enum >, FBPropertyBase< FBFolder *, kFBPT_object >, FBPropertyBase< FBAnimationNode *, kFBPT_object >, and FBPropertyBase< enum FBRootHMode, kFBPT_enum >.

bool IsReferenceProperty ( )
bool IsTemporaryProperty ( )

Indicate if a property was created on retrieve because it didn't exist.

Warning
if there is no call to AcceptTemporaryProperty(), is will be converted to a user property after the file is retrieved.
Returns
true if property is temporary.
bool IsTextureConnectableProperty ( )
bool IsUserProperty ( )
void ModifyPropertyFlag ( FBPropertyFlag  pFlag,
bool  pValue 
)

ModifyPropertyFlag.

Parameters
pFlagThe flag to switch to True or False.
pValueThe value to set about this flag.
Warning
Flags are not saved into or read from a FBX file.
void NotifyEnumStringListChanged ( )

Notify system that the enum list was modified.

bool OriIsAnimated ( ) const

Get the property original animated flag status (before any modification)

const char* OriValueAsString ( )

Get the property original value (before any modification) as string.

Returns
returns the original value of the property in string with format same as AsString(kDataAsStringPersistence)
virtual void SetData ( void *  pData)
virtual

Set the value of the property, passing the type as an argument.

Parameters
pDataValue to affect property with.

Reimplemented in FBPropertyAnimatable, FBPropertyBase< tType, pPT >, FBPropertyBase< enum FBControlSetType, kFBPT_enum >, FBPropertyBase< enum FBCharacterExtensionRetargetMode, kFBPT_enum >, FBPropertyBase< enum FBDeviceSamplingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraDistanceMode, kFBPT_enum >, FBPropertyBase< enum FBCameraType, kFBPT_enum >, FBPropertyBase< enum FBAnimationNodeConnectorType, kFBPT_enum >, FBPropertyBase< enum FBEventAnimationNodeType, kFBPT_enum >, FBPropertyBase< enum FBClusterMode, kFBPT_enum >, FBPropertyBase< enum FBSkeletonResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBCharacterLoadAnimationMethod, kFBPT_enum >, FBPropertyBase< FBMarkerSet *, kFBPT_object >, FBPropertyBase< enum FBAccessMode, kFBPT_enum >, FBPropertyBase< enum FBTangentCustomIndex, kFBPT_enum >, FBPropertyBase< enum FBTangentConstantMode, kFBPT_enum >, FBPropertyBase< enum FBRSType, kFBPT_enum >, FBPropertyBase< enum FBImageType, kFBPT_enum >, FBPropertyBase< FBModelTemplate *, kFBPT_object >, FBPropertyBase< enum FBTakeSpanOnLoad, kFBPT_enum >, FBPropertyBase< enum FBStoryClipNodeFunction, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< enum FBVideoFormat, kFBPT_enum >, FBPropertyBase< enum FBVideoStorageMode, kFBPT_enum >, FBPropertyBase< FBStoryTrack *, kFBPT_object >, FBPropertyBase< enum FBStoryTrackType, kFBPT_enum >, FBPropertyBase< FBModelVertexData *, kFBPT_object >, FBPropertyBase< enum FBProfilingMode, kFBPT_enum >, FBPropertyBase< enum FBCameraSamplingType, kFBPT_enum >, FBPropertyBase< enum FBGapMode, kFBPT_enum >, FBPropertyBase< enum FBFogMode, kFBPT_enum >, FBPropertyBase< FBPointCacheFile *, kFBPT_object >, FBPropertyBase< enum FBCharacterRollSolver, kFBPT_enum >, FBPropertyBase< FBRenderer *, kFBPT_object >, FBPropertyBase< enum FBInsertSegmentMode, kFBPT_enum >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< enum FBCharacterExtensionStancePoseMode, kFBPT_enum >, FBPropertyBase< enum FBUseChnMode, kFBPT_enum >, FBPropertyBase< enum FBTangentClampMode, kFBPT_enum >, FBPropertyBase< enum FBCameraAntiAliasingMethod, kFBPT_enum >, FBPropertyBase< enum FBCameraApertureMode, kFBPT_enum >, FBPropertyBase< enum FBAttenuationType, kFBPT_enum >, FBPropertyBase< enum FBLightType, kFBPT_enum >, FBPropertyBase< enum FBCommPortType, kFBPT_enum >, FBPropertyBase< enum FBTextureUseType, kFBPT_enum >, FBPropertyBase< enum FBConsoleChannelType, kFBPT_enum >, FBPropertyBase< enum FBConnectionAction, kFBPT_enum >, FBPropertyBase< enum FBStoryClipGhostTimeMode, kFBPT_enum >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< enum FBDeckTransportMode, kFBPT_enum >, FBPropertyBase< FBCluster *, kFBPT_object >, FBPropertyBase< enum FBGeometryReferenceMode, kFBPT_enum >, FBPropertyBase< FBConstraint *, kFBPT_object >, FBPropertyBase< enum FBVideoResolution, kFBPT_enum >, FBPropertyBase< FBBox *, kFBPT_object >, FBPropertyBase< enum FBCameraStereoType, kFBPT_enum >, FBPropertyBase< enum FBCharacterKeyingMode, kFBPT_enum >, FBPropertyBase< enum FBGenerationMode, kFBPT_enum >, FBPropertyBase< FBDeviceCameraPacket *, kFBPT_object >, FBPropertyBase< enum FBRootRMode, kFBPT_enum >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< enum FBDeformerType, kFBPT_enum >, FBPropertyBase< enum FBCameraSafeAreaMode, kFBPT_enum >, FBPropertyBase< enum FBCameraFilmBackType, kFBPT_enum >, FBPropertyBase< enum FBHUDElementHAlignment, kFBPT_enum >, FBPropertyBase< enum FBPropertyStateEventType, kFBPT_enum >, FBPropertyBase< FBAssetMng *, kFBPT_object >, FBPropertyBase< FBVideo *, kFBPT_object >, FBPropertyBase< enum FBMarkerLook, kFBPT_enum >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBModelOptical *, kFBPT_object >, FBPropertyBase< enum FBCharacterContactBehaviour, kFBPT_enum >, FBPropertyBase< enum FBConnectionType, kFBPT_enum >, FBPropertyBase< enum FBNewKeyInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBTangentWeightMode, kFBPT_enum >, FBPropertyBase< enum FBTransportSnapMode, kFBPT_enum >, FBPropertyBase< enum FBFileMonitoringType, kFBPT_enum >, FBPropertyBase< enum FBInterpolation, kFBPT_enum >, FBPropertyBase< enum FBSceneChangeType, kFBPT_enum >, FBPropertyBase< enum FBTimeReferential, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackRefMode, kFBPT_enum >, FBPropertyBase< enum FBModelShadingMode, kFBPT_enum >, FBPropertyBase< enum FBGeometryMappingMode, kFBPT_enum >, FBPropertyBase< FBAudioOut *, kFBPT_object >, FBPropertyBase< enum FBTransportLoopMode, kFBPT_enum >, FBPropertyBase< enum FBPlayerControlChangeType, kFBPT_enum >, FBPropertyBase< enum FBCharacterHipsTranslationMode, kFBPT_enum >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBModel *, kFBPT_object >, FBPropertyBase< enum FBSegmentMode, kFBPT_enum >, FBPropertyBase< enum FBStoryClipMirrorPlane, kFBPT_enum >, FBPropertyBase< enum FBStoryClipSolveMode, kFBPT_enum >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< enum FBCustomKeyChangeType, kFBPT_enum >, FBPropertyBase< enum FBImageInterleaveType, kFBPT_enum >, FBPropertyBase< FBDevice *, kFBPT_object >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< enum FBShadowFrameType, kFBPT_enum >, FBPropertyBase< enum FBModelRotationOrder, kFBPT_enum >, FBPropertyBase< enum FBExtrapolationMode, kFBPT_enum >, FBPropertyBase< enum FBTangentMode, kFBPT_enum >, FBPropertyBase< enum FBSurfaceType, kFBPT_enum >, FBPropertyBase< enum FBParity, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< enum FBSkeletonLook, kFBPT_enum >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< enum FBControllerMode, kFBPT_enum >, FBPropertyBase< enum FBMarkerType, kFBPT_enum >, FBPropertyBase< enum FBRootSpeedMode, kFBPT_enum >, FBPropertyBase< enum FBClipEnd, kFBPT_enum >, FBPropertyBase< enum FBTransportTimeFormat, kFBPT_enum >, FBPropertyBase< FBActorFace *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, FBPropertyBase< FBScene *, kFBPT_object >, FBPropertyBase< EKeyPropertyBehavior, kFBPT_enum >, FBPropertyBase< enum FBElementAction, kFBPT_enum >, FBPropertyBase< enum FBPoseType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipTimeWarpInterpolatorType, kFBPT_enum >, FBPropertyBase< enum FBStoryClipShowGhostMode, kFBPT_enum >, FBPropertyBase< enum FBRootXZMode, kFBPT_enum >, FBPropertyBase< enum FBVideoProxyMode, kFBPT_enum >, FBPropertyBase< enum FBStoryTrackGhostShowMode, kFBPT_enum >, FBPropertyBase< enum FBSyncActivationAndVisibilityMode, kFBPT_enum >, FBPropertyBase< FBVideoSwitcher *, kFBPT_object >, FBPropertyBase< enum FBTakeChangeType, kFBPT_enum >, FBPropertyBase< enum FBNurbType, kFBPT_enum >, FBPropertyBase< enum FBCameraViewPlaneMode, kFBPT_enum >, FBPropertyBase< enum FBTextureBlendMode, kFBPT_enum >, FBPropertyBase< FBStoryFolder *, kFBPT_object >, FBPropertyBase< enum FBLayerMode, kFBPT_enum >, FBPropertyBase< enum FBFileFormatAndVersion, kFBPT_enum >, FBPropertyBase< enum FBMarkerResolutionLevel, kFBPT_enum >, FBPropertyBase< enum FBShadowType, kFBPT_enum >, FBPropertyBase< FBHUD *, kFBPT_object >, FBPropertyBase< enum FBStoryClipChangeType, kFBPT_enum >, FBPropertyBase< float, kFBPT_float >, FBPropertyBase< enum FBCameraFrameSizeMode, kFBPT_enum >, FBPropertyBase< enum FBTextureMapping, kFBPT_enum >, FBPropertyBase< enum FBImageInterpolationType, kFBPT_enum >, FBPropertyBase< enum FBCharacterInputType, kFBPT_enum >, FBPropertyBase< FBConstructionHistory *, kFBPT_object >, FBPropertyBase< FBFCurve *, kFBPT_object >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< enum FBCommandState, kFBPT_enum >, FBPropertyBase< FBAudioClip *, kFBPT_object >, FBPropertyBase< enum FBParallelScheduleType, kFBPT_enum >, FBPropertyBase< enum FBCameraResolutionMode, kFBPT_enum >, FBPropertyBase< enum FBAlphaSource, kFBPT_enum >, FBPropertyBase< enum FBHUDElementVAlignment, kFBPT_enum >, FBPropertyBase< enum FBSurfaceMode, kFBPT_enum >, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< enum FBRigidBodyMode, kFBPT_enum >, FBPropertyBase< FBTake *, kFBPT_object >, FBPropertyBase< FBCharacter *, kFBPT_object >, FBPropertyBase< FBActor *, kFBPT_object >, FBPropertyBase< enum FBVideoInterlaceMode, kFBPT_enum >, FBPropertyBase< enum FBPlayMode, kFBPT_enum >, FBPropertyBase< enum FBRenderingPass, kFBPT_enum >, FBPropertyBase< enum FBModelSelection, kFBPT_enum >, FBPropertyBase< enum FBFCurveEventType, kFBPT_enum >, FBPropertyBase< enum FBCameraFocusDistanceSource, kFBPT_enum >, FBPropertyBase< FBCamera *, kFBPT_object >, FBPropertyBase< enum FBPlotAllowed, kFBPT_enum >, FBPropertyBase< FBMesh *, kFBPT_object >, FBPropertyBase< FBGeometry *, kFBPT_object >, FBPropertyBase< FBTexture *, kFBPT_object >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< enum FBImageFormat, kFBPT_enum >, FBPropertyBase< FBModelMarkerOptical *, kFBPT_object >, FBPropertyBase< enum FBLayerRotationMode, kFBPT_enum >, FBPropertyBase< FBFolder *, kFBPT_object >, FBPropertyBase< FBAnimationNode *, kFBPT_object >, and FBPropertyBase< enum FBRootHMode, kFBPT_enum >.

void SetEnable ( bool  pValue)

Set property enable status.

bool SetInt ( int  pInt)

Set the property from an integer.

Parameters
pIntInt to set property from.
Returns
True if it was possible.
void SetLocked ( bool  pLocked)

SetLocked.

Parameters
pLockedTrue if the property is to be locked, false if it is to be unlocked.
void SetMax ( double  pMax,
bool  pForceMaxClamp = false 
)

SetMax.

Parameters
pMaxMaximum value of the property.
pForceMaxClampForce clamping to maximum value of the property.
void SetMemberLocked ( int  pIndex,
bool  pLocked 
)

SetMemberLocked.

Parameters
pIndexIndex of the sub-member of the property to lock or unlock.
pLockedTrue if the sub-member is to be locked, false if it is to be unlocked.
void SetMin ( double  pMin,
bool  pForceMinClamp = false 
)

SetMin.

Parameters
pMinMinimum value of the property.
pForceMinClampForce clamping to minimum value of the property.
void SetMinMax ( double  pMin,
double  pMax,
bool  pForceMinClamp = false,
bool  pForceMaxClamp = false 
)

SetMinMax.

Parameters
pMinMinimum value of the property.
pMaxMaximum value of the property.
pForceMinClampForce clamping to minimum value of the property.
pForceMaxClampForce clamping to maximum value of the property.
void SetName ( const char *  pName)

Set the property's name.

Parameters
pNameNew name for the property.
virtual bool SetString ( const char *  pString)
virtual

Set the property value from a string.

Parameters
pStringString to set property value from, with format same as AsString(kFBDataAsStringPersistence)
Returns
True if it was possible.

Reimplemented in FBPropertyBaseAnimatableEnum< tType >, FBPropertyStringList, FBPropertyBaseEnum< tType >, FBPropertyBaseEnum< enum FBNurbType >, FBPropertyBaseEnum< enum FBShadowFrameType >, FBPropertyBaseEnum< enum FBVideoInterlaceMode >, FBPropertyBaseEnum< enum FBStoryTrackRefMode >, FBPropertyBaseEnum< enum FBStoryTrackType >, FBPropertyBaseEnum< enum FBModelShadingMode >, FBPropertyBaseEnum< enum FBModelSelection >, FBPropertyBaseEnum< enum FBGeometryMappingMode >, FBPropertyBaseEnum< enum FBExtrapolationMode >, FBPropertyBaseEnum< enum FBInterpolation >, FBPropertyBaseEnum< enum FBImageFormat >, FBPropertyBaseEnum< enum FBCharacterKeyingMode >, FBPropertyBaseEnum< enum FBCharacterInputType >, FBPropertyBaseEnum< enum FBInsertSegmentMode >, FBPropertyBaseEnum< enum FBStoryClipSolveMode >, FBPropertyBaseEnum< enum FBRootXZMode >, FBPropertyBaseEnum< enum FBRootRMode >, FBPropertyBaseEnum< enum FBShadowType >, FBPropertyBaseEnum< enum FBHUDElementHAlignment >, FBPropertyBaseEnum< enum FBSkeletonResolutionLevel >, FBPropertyBaseEnum< enum FBCharacterRollSolver >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< enum FBPoseType >, FBPropertyBaseEnum< enum FBCharacterExtensionStancePoseMode >, FBPropertyBaseEnum< enum FBNewKeyInterpolationType >, FBPropertyBaseEnum< enum FBRSType >, FBPropertyBaseEnum< enum FBGapMode >, FBPropertyBaseEnum< enum FBTextureBlendMode >, FBPropertyBaseEnum< enum FBTakeSpanOnLoad >, FBPropertyBaseEnum< enum FBTransportSnapMode >, FBPropertyBaseEnum< enum FBSurfaceType >, FBPropertyBaseEnum< enum FBFogMode >, FBPropertyBaseEnum< enum FBCharacterHipsTranslationMode >, FBPropertyBaseEnum< EKeyPropertyBehavior >, FBPropertyBaseEnum< enum FBElementAction >, FBPropertyBaseEnum< enum FBSegmentMode >, FBPropertyBaseEnum< enum FBMarkerType >, FBPropertyBaseEnum< enum FBConnectionType >, FBPropertyBaseEnum< enum FBDeviceSamplingMode >, FBPropertyBaseEnum< enum FBCameraSamplingType >, FBPropertyBaseEnum< enum FBCameraFrameSizeMode >, FBPropertyBaseEnum< enum FBTransportLoopMode >, FBPropertyBaseEnum< enum FBImageInterleaveType >, FBPropertyBaseEnum< enum FBClusterMode >, FBPropertyBaseEnum< ELengthUnitType >, FBPropertyBaseEnum< enum FBGenerationMode >, FBPropertyBaseEnum< enum FBStoryClipMirrorPlane >, FBPropertyBaseEnum< enum FBCameraDistanceMode >, FBPropertyBaseEnum< enum FBLightType >, FBPropertyBaseEnum< enum FBImageType >, FBPropertyBaseEnum< enum FBCharacterContactBehaviour >, FBPropertyBaseEnum< enum FBStoryTrackGhostShowMode >, FBPropertyBaseEnum< enum FBSyncActivationAndVisibilityMode >, FBPropertyBaseEnum< enum FBEventAnimationNodeType >, FBPropertyBaseEnum< enum FBStoryClipShowGhostMode >, FBPropertyBaseEnum< enum FBRootSpeedMode >, FBPropertyBaseEnum< enum FBRootHMode >, FBPropertyBaseEnum< enum FBPlotAllowed >, FBPropertyBaseEnum< enum FBClipEnd >, FBPropertyBaseEnum< enum FBCameraAntiAliasingMethod >, FBPropertyBaseEnum< enum FBCameraSafeAreaMode >, FBPropertyBaseEnum< enum FBCameraResolutionMode >, FBPropertyBaseEnum< enum FBAttenuationType >, FBPropertyBaseEnum< enum FBPlayerControlChangeType >, FBPropertyBaseEnum< enum FBLayerMode >, FBPropertyBaseEnum< enum FBCharacterLoadAnimationMethod >, FBPropertyBaseEnum< enum FBStoryClipGhostTimeMode >, FBPropertyBaseEnum< enum FBVideoFormat >, FBPropertyBaseEnum< enum FBDeckTransportMode >, FBPropertyBaseEnum< enum FBTakeChangeType >, FBPropertyBaseEnum< enum FBUseChnMode >, FBPropertyBaseEnum< enum FBTangentMode >, FBPropertyBaseEnum< enum FBSkeletonLook >, FBPropertyBaseEnum< enum FBConnectionAction >, FBPropertyBaseEnum< enum FBControlSetType >, FBPropertyBaseEnum< enum FBCameraFocusDistanceSource >, FBPropertyBaseEnum< enum FBCameraViewPlaneMode >, FBPropertyBaseEnum< enum FBCameraApertureMode >, FBPropertyBaseEnum< enum FBTransportTimeFormat >, FBPropertyBaseEnum< enum FBAlphaSource >, FBPropertyBaseEnum< enum FBVideoResolution >, FBPropertyBaseEnum< enum FBConsoleChannelType >, FBPropertyBaseEnum< enum FBRigidBodyMode >, FBPropertyBaseEnum< enum FBRenderingPass >, FBPropertyBaseEnum< enum FBTangentClampMode >, FBPropertyBaseEnum< enum FBAnimationNodeConnectorType >, FBPropertyBaseEnum< enum FBPropertyStateEventType >, FBPropertyBaseEnum< enum FBCharacterExtensionRetargetMode >, FBPropertyBaseEnum< enum FBStoryClipChangeType >, FBPropertyBaseEnum< enum FBFCurveEventType >, FBPropertyBaseEnum< enum FBGeometryReferenceMode >, FBPropertyBaseEnum< enum FBTangentWeightMode >, FBPropertyBaseEnum< enum FBTextureMapping >, FBPropertyBaseEnum< enum FBMarkerResolutionLevel >, FBPropertyBaseEnum< enum FBModelRotationOrder >, FBPropertyBaseEnum< enum FBPlayMode >, FBPropertyBaseEnum< enum FBCustomKeyChangeType >, FBPropertyBaseEnum< enum FBCommPortType >, FBPropertyBaseEnum< enum FBFileFormatAndVersion >, FBPropertyBaseEnum< enum FBStoryClipNodeFunction >, FBPropertyBaseEnum< enum FBVideoStorageMode >, FBPropertyBaseEnum< enum FBAccessMode >, FBPropertyBaseEnum< enum FBCameraFilmBackType >, FBPropertyBaseEnum< enum FBFileMonitoringType >, FBPropertyBaseEnum< enum FBTimeReferential >, FBPropertyBaseEnum< enum FBCommandState >, FBPropertyBaseEnum< enum FBControllerMode >, FBPropertyBaseEnum< enum FBStoryClipTimeWarpInterpolatorType >, FBPropertyBaseEnum< enum FBParallelScheduleType >, FBPropertyBaseEnum< enum FBProfilingMode >, FBPropertyBaseEnum< enum FBTangentConstantMode >, FBPropertyBaseEnum< EAreaLightShapes >, FBPropertyBaseEnum< enum FBParity >, FBPropertyBaseEnum< enum FBCameraStereoType >, FBPropertyBaseEnum< enum FBSceneChangeType >, FBPropertyBaseEnum< enum FBVideoProxyMode >, FBPropertyBaseEnum< enum FBDeformerType >, FBPropertyBaseEnum< enum FBTangentCustomIndex >, FBPropertyBaseEnum< enum FBCameraType >, FBPropertyBaseEnum< enum FBHUDElementVAlignment >, FBPropertyBaseEnum< enum FBTextureUseType >, FBPropertyBaseEnum< enum FBImageInterpolationType >, FBPropertyBaseEnum< enum FBSurfaceMode >, FBPropertyBaseEnum< enum FBLayerRotationMode >, and FBPropertyBaseEnum< enum FBMarkerLook >.

Member Data Documentation

FBString mName
protected

Return to the default scope (private)

mName Property unique name.

Definition at line 194 of file fbproperties.h.

void* mParent
protected

mParent Parent of the property.

Definition at line 200 of file fbproperties.h.

int TypeInfo
static

Definition at line 194 of file fbproperties.h.


The documentation for this class was generated from the following file: