Open Reality Reference Guide
FBFCurveEditorUtility Class Reference

FBFCurveEditor Utility class Utility class allowing different operations on a FBFCurveEditor or on the main FCurveEditor. More...

#include <fbcontrols.h>

Inheritance diagram for FBFCurveEditorUtility:

Public Member Functions

FBPropertyAddExternalCurves (const char *pObjectName, const char *pPropertyName, const FBPropertyType pPropertyType, FBAnimationNode *pFCurve, FBFCurveEditor *pEditor=NULL)
 Add external FCurves to the FCurve Editor, all layers will be copied. More...
 
FBPropertyAddExternalCurves (const char *pObjectName, const char *pPropertyName, FBProperty *pProperty, FBFCurveEditor *pEditor=NULL)
 Add external FCurves to the FCurve Editor, all layers will be copied. More...
 
FBPropertyAddExternalCurves (const char *pObjectName, const char *pPropertyName, const FBPropertyType pPropertyType, FBXSDK_NAMESPACE::FbxAnimCurveNode *pFCurve, FBFCurveEditor *pEditor=NULL)
 Add external FCurves to the FCurve Editor, only the base layer will be copied. More...
 
FBPropertyAddExternalCurves (const char *pObjectName, const char *pPropertyName, FBXSDK_NAMESPACE::FbxProperty *pProperty, FBXSDK_NAMESPACE::FbxAnimStack *pStack=NULL, FBFCurveEditor *pEditor=NULL)
 Add external FCurves to the FCurve Editor, all layers will be copied if the stack is provided. More...
 
bool RemoveExternalCurves (FBProperty *pProperty)
 Remove external FCurve from the FCurve Editor. More...
 
bool UpdateCurves (FBProperty *pProperty, FBAnimationNode *pFCurve)
 Update the FCurve for a particular property, without creating a new property. More...
 
bool UpdateCurves (FBProperty *pProperty, FBProperty *pSrcProperty)
 Update the FCurve for a particular property, without creating a new property. More...
 
bool UpdateCurves (FBProperty *pProperty, FBXSDK_NAMESPACE::FbxAnimCurveNode *pFCurve)
 Update the FCurve for a particular property, without creating a new property. More...
 
bool UpdateCurves (FBProperty *pProperty, FBXSDK_NAMESPACE::FbxProperty *pFbxProperty, FBXSDK_NAMESPACE::FbxAnimStack *pStack)
 Update the FCurve for a particular property, without creating a new property. More...
 
bool GetCurves (FBProperty *pProperty, FBAnimationNode *pFCurve)
 Get the FCurve of a particular property. More...
 
bool GetCurves (FBProperty *pProperty, FBProperty *pDestProperty)
 Get the FCurve of a particular property. More...
 
bool GetCurves (FBProperty *pProperty, FBXSDK_NAMESPACE::FbxAnimCurveNode *pFCurve)
 Get the FCurve of a particular property. More...
 
bool GetCurves (FBProperty *pProperty, FBXSDK_NAMESPACE::FbxProperty *pFbxProperty, FBXSDK_NAMESPACE::FbxAnimStack *pStack)
 Get the FCurve of a particular property. More...
 
bool Frame (bool pSelectedKeysOnly, FBFCurveEditor *pEditor=NULL)
 Frame keys in the FCurve Editor interface. More...
 
bool GetObjects (FBArrayTemplate< FBComponent * > &pObjectList)
 Get all the objects displayed in the left pane of the FCurve Editor. More...
 
bool GetProperties (FBArrayTemplate< FBProperty * > &pProperties, bool pSelectedOnly, FBFCurveEditor *pEditor=NULL)
 Get the displayed properties. More...
 
FBTimeSpan GetTimeSpan (FBFCurveEditor *pEditor=NULL)
 Get the displayed time range of the FCurve Editor. More...
 
bool SetTimeSpan (FBTimeSpan pTimeSpan, FBFCurveEditor *pEditor=NULL)
 Set the displayed time range of the FCurve Editor. More...
 
bool RegisterToFCurveEditorEvent (HICallback pOwner, kICallbackHandler pHandler, FBFCurveEditor *pEditor=NULL)
 Register to FCurve Editor event. More...
 
bool UnregisterToFCurveEditorEvent (HICallback pOwner, kICallbackHandler pHandler, FBFCurveEditor *pEditor=NULL)
 Unregister to FCurve Editor event. More...
 
- Public Member Functions inherited from FBComponent
 FBComponent (HIObject pObject)
 Constructor. More...
 
virtual ~FBComponent ()
 Destructor. More...
 
virtual bool FBCreate ()
 Open Reality Creation function. More...
 
virtual void FBDestroy ()
 Open Reality destruction function. More...
 
virtual void FBDelete () override
 Open Reality deletion function. More...
 
virtual bool SetHIObject (HIObject pObject, bool pSDKComponent) override
 Assign component to an internal pointer. More...
 
virtual int PropertyAdd (FBProperty *pProperty)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
 Add a reference property to the component's property manager. More...
 
void PropertyRemove (FBProperty *pProperty)
 Remove a Property from the component's Property manager. More...
 
void PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
FBPropertyPropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
 Create user or dynamic property. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
void SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
void EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
void DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
void SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessObjectNamespace. More...
 
virtual const char * ClassName () override
 Get the class name. More...
 
virtual bool UseCustomPropertyViewSet () const
 Use the custom property viewSet or not. More...
 
const char * GetFullName (void)
 Get the full name. More...
 
void SetOwnerNamespace (FBNamespace *pOwnerNSObj)
 Set the owner Namespace object. More...
 
FBNamespaceGetOwnerNamespace (void)
 Get the owner Namespace object. More...
 
FBFileReferenceGetOwnerFileReference (void)
 Get the owner FileReference object. More...
 
void HardSelect ()
 HardSelect. More...
 
virtual bool Is (int pTypeId) override
 Returns true if object is of type TypeId. More...
 
virtual int GetTypeId () override
 GetTypeId( int pTypeId ) More...
 
- Public Member Functions inherited from FBWrapperHolder
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Static Public Member Functions

static FBFCurveEditorUtilityTheOne ()
 Get the global object for this class. More...
 
- Static Public Member Functions inherited from FBComponent
static int GetInternalClassId ()
 
static void FBComponentSetName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetName (FBComponent *pObject)
 
static void FBComponentSetLongName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetLongName (FBComponent *pObject)
 

Additional Inherited Members

- Public Attributes inherited from FBComponent
FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyListComponent Components
 List: List of components. More...
 
FBPropertyListComponent Parents
 List: Parents. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
FBPropertyString LongName
 Read Write Property: Name and namespace for object.
More...
 
FBPropertyFolder Folder
 Read Write Property: The folder that contain this component. More...
 
- Static Public Attributes inherited from FBComponent
static int TypeInfo
 Contains the Type information of the object. More...
 
- 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=NULL, void *pDataOld=NULL, 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=NULL, void *pDataOld=NULL, 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=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
 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...
 
- 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...
 
- 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...
 

Detailed Description

FBFCurveEditor Utility class Utility class allowing different operations on a FBFCurveEditor or on the main FCurveEditor.

Definition at line 2231 of file fbcontrols.h.

Member Function Documentation

◆ AddExternalCurves() [1/4]

FBProperty* AddExternalCurves ( const char *  pObjectName,
const char *  pPropertyName,
const FBPropertyType  pPropertyType,
FBAnimationNode pFCurve,
FBFCurveEditor pEditor = NULL 
)

Add external FCurves to the FCurve Editor, all layers will be copied.

Parameters
pObjectNameName of the object that will contain the property/curves.
pPropertyNameName of the property that will contain the curves. A search will be done to see if that property exists, if so, it will be used, otherwise a new one will be created.
pPropertyTypeProperty type for the new property.
pFCurveOriginal FCurves to be copied.
pEditorPointer to a FBFCurveEditor for adding the FCurve to that custom editor, if required. The default FCurve Editor will always add the external FCurves.
Returns
A pointer to a FBProperty object if successful, NULL otherwise.

◆ AddExternalCurves() [2/4]

FBProperty* AddExternalCurves ( const char *  pObjectName,
const char *  pPropertyName,
const FBPropertyType  pPropertyType,
FBXSDK_NAMESPACE::FbxAnimCurveNode *  pFCurve,
FBFCurveEditor pEditor = NULL 
)

Add external FCurves to the FCurve Editor, only the base layer will be copied.

Parameters
pObjectNameName of the object that will contain the property/curves.
pPropertyNameName of the property that will contain the curves. A search will be done to see if that property exists, if so, it will be used, otherwise a new one will be created
pPropertyTypeProperty type for the new property.
pFCurveOriginal FCurves to be copied.
pEditorPointer to a FBFCurveEditor for adding the FCurve to that custom editor, if required. The default FCurve Editor will always add the external FCurves.
Returns
A pointer to a FBProperty object if successful, NULL otherwise.

◆ AddExternalCurves() [3/4]

FBProperty* AddExternalCurves ( const char *  pObjectName,
const char *  pPropertyName,
FBProperty pProperty,
FBFCurveEditor pEditor = NULL 
)

Add external FCurves to the FCurve Editor, all layers will be copied.

Parameters
pObjectNameName of the object that will contain the property/curves.
pPropertyNameName of the property that will contain the curves. A search will be done to see if that property exists, if so, it will be used, otherwise a new one will be created
pPropertyProperty containing the original FCurves; all layers will be copied.
pEditorPointer to a FBFCurveEditor for adding the FCurve to that custom editor, if required. The default FCurve Editor will always add the external FCurves.
Returns
A pointer to a FBProperty object if successful, NULL otherwise.

◆ AddExternalCurves() [4/4]

FBProperty* AddExternalCurves ( const char *  pObjectName,
const char *  pPropertyName,
FBXSDK_NAMESPACE::FbxProperty *  pProperty,
FBXSDK_NAMESPACE::FbxAnimStack *  pStack = NULL,
FBFCurveEditor pEditor = NULL 
)

Add external FCurves to the FCurve Editor, all layers will be copied if the stack is provided.

Parameters
pObjectNameName of the object that will contain the property/curves.
pPropertyNameName of the property that will contain the curves. A search will be done to see if that property exists, if so, it will be used, otherwise a new one will be created
pPropertyProperty containing the original FCurves.
pStackAnimation stack for getting all the animation layers, NULL to use only the base layer.
pEditorPointer to a FBFCurveEditor for adding the FCurve to that custom editor, if required. The default FCurve Editor will always add the external FCurves.
Returns
A pointer to a FBProperty object if successful, NULL otherwise.

◆ Frame()

bool Frame ( bool  pSelectedKeysOnly,
FBFCurveEditor pEditor = NULL 
)

Frame keys in the FCurve Editor interface.

Parameters
pSelectedKeysOnlyIf true, only the selected keys will be framed, otherwise all keys will be framed.
pEditorPointer to a FBFCurveEditor for framing the keys in that custom editor, NULL to frame in the default editor.
Note
pEditor is currently not supported in this implementation, as the FBFCurveEditor is still in development.
Returns
True if successful, false otherwise.

◆ GetCurves() [1/4]

bool GetCurves ( FBProperty pProperty,
FBAnimationNode pFCurve 
)

Get the FCurve of a particular property.

This will copy all layers.

Parameters
pPropertyProperty to get the curves from.
pFCurveFCurve that will receive the data from the property.
Returns
True if successful, false otherwise.

◆ GetCurves() [2/4]

bool GetCurves ( FBProperty pProperty,
FBProperty pDestProperty 
)

Get the FCurve of a particular property.

This will copy all layers.

Parameters
pPropertyProperty to get the curves from.
pDestPropertyProperty that will receive the data from the source property.
Returns
True if successful, false otherwise.

◆ GetCurves() [3/4]

bool GetCurves ( FBProperty pProperty,
FBXSDK_NAMESPACE::FbxAnimCurveNode *  pFCurve 
)

Get the FCurve of a particular property.

Only the base layer will be copied.

Parameters
pPropertyProperty to get the curves from.
pFCurveFCurve that will receive the data from the property.
Returns
True if successful, false otherwise.

◆ GetCurves() [4/4]

bool GetCurves ( FBProperty pProperty,
FBXSDK_NAMESPACE::FbxProperty *  pFbxProperty,
FBXSDK_NAMESPACE::FbxAnimStack *  pStack 
)

Get the FCurve of a particular property.

All layers will be copied if the stack is provided.

Parameters
pPropertyProperty to get the curves from.
pFbxPropertyProperty that will receive the data from the property.
pStackAnimation stack for getting all the animation layers, NULL to use only the base layer.
Returns
True if successful, false otherwise.

◆ GetObjects()

bool GetObjects ( FBArrayTemplate< FBComponent * > &  pObjectList)

Get all the objects displayed in the left pane of the FCurve Editor.

Parameters
pObjectListA list that will be filled with the objects displayed in the FCurve Editor.
Returns
True if successful, false otherwise.

◆ GetProperties()

bool GetProperties ( FBArrayTemplate< FBProperty * > &  pProperties,
bool  pSelectedOnly,
FBFCurveEditor pEditor = NULL 
)

Get the displayed properties.

Parameters
pPropertyListArray that will contain the properties displayed.
pSelectedOnlyIf true, only the selected properties will be returned.
pEditorPointer to a FBFCurveEditor for getting the properties in that custom editor, NULL to frame in the default editor.
Returns
True if successful, false otherwise.

◆ GetTimeSpan()

FBTimeSpan GetTimeSpan ( FBFCurveEditor pEditor = NULL)

Get the displayed time range of the FCurve Editor.

Parameters
pEditorPointer to a FBFCurveEditor where the time span will be get, NULL to get the time span from the default editor.
Returns
FCurve Editor time span, default FBTimeSpan if not successful.

◆ RegisterToFCurveEditorEvent()

bool RegisterToFCurveEditorEvent ( HICallback  pOwner,
kICallbackHandler  pHandler,
FBFCurveEditor pEditor = NULL 
)

Register to FCurve Editor event.

Parameters
pOwnerOwner of the callback that will be called when an event is sent from the FCurve Editor.
pHandlerCallback to call when receiving an event.
pEditorPointer to a FBFCurveEditor to receive the event from that editor, NULL to receive those from the default editor.
Returns
True if successful, false otherwise.

◆ RemoveExternalCurves()

bool RemoveExternalCurves ( FBProperty pProperty)

Remove external FCurve from the FCurve Editor.

Parameters
pPropertyProperty to remove.
Returns
True if successful, false otherwise.

◆ SetTimeSpan()

bool SetTimeSpan ( FBTimeSpan  pTimeSpan,
FBFCurveEditor pEditor = NULL 
)

Set the displayed time range of the FCurve Editor.

Parameters
pTimeSpanThe time span that will be set.
pEditorPointer to a FBFCurveEditor where the time span will be set, NULL to set the time span on the default editor.
Returns
True if successful, false otherwise.

◆ TheOne()

static FBFCurveEditorUtility& TheOne ( )
static

Get the global object for this class.

Returns
the global object.

◆ UnregisterToFCurveEditorEvent()

bool UnregisterToFCurveEditorEvent ( HICallback  pOwner,
kICallbackHandler  pHandler,
FBFCurveEditor pEditor = NULL 
)

Unregister to FCurve Editor event.

Parameters
pOwnerOwner of the callback to unregister.
pHandlerCallback to unregister.
pEditorPointer to the FBFCurveEditor that should be unregistered, NULL to unregister the default editor.
Returns
True if successful, false otherwise.

◆ UpdateCurves() [1/4]

bool UpdateCurves ( FBProperty pProperty,
FBAnimationNode pFCurve 
)

Update the FCurve for a particular property, without creating a new property.

All layers will be copied.

Parameters
pPropertyProperty to update.
pFCurveOriginal FCurves to be copied.
Returns
True if successful, false otherwise.

◆ UpdateCurves() [2/4]

bool UpdateCurves ( FBProperty pProperty,
FBProperty pSrcProperty 
)

Update the FCurve for a particular property, without creating a new property.

All layers will be copied.

Parameters
pPropertyProperty to update.
pSrcPropertyOriginal FCurves from the property to be copied.
Returns
True if successful, false otherwise.

◆ UpdateCurves() [3/4]

bool UpdateCurves ( FBProperty pProperty,
FBXSDK_NAMESPACE::FbxAnimCurveNode *  pFCurve 
)

Update the FCurve for a particular property, without creating a new property.

Only the base layer will be copied.

Parameters
pPropertyProperty to update.
pFCurveOriginal FCurves to be copied.
Returns
True if successful, false otherwise.

◆ UpdateCurves() [4/4]

bool UpdateCurves ( FBProperty pProperty,
FBXSDK_NAMESPACE::FbxProperty *  pFbxProperty,
FBXSDK_NAMESPACE::FbxAnimStack *  pStack 
)

Update the FCurve for a particular property, without creating a new property.

All layers will be copied if the stack is provided.

Parameters
pPropertyProperty to update.
pFbxPropertyProperty to get the curves from.
pStackAnimation stack for getting all the animation layers, NULL to use only the base layer.
Returns
True if successful, false otherwise.

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