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

#include <fbcontrols.h>

Inheritance diagram for FBFCurveEditorUtility:

[legend]

Public Member Functions
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.

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.

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.

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.

bool	RemoveExternalCurves (FBProperty *pProperty)
	Remove external FCurve from the FCurve Editor.

bool	UpdateCurves (FBProperty pProperty, FBAnimationNode pFCurve)
	Update the FCurve for a particular property, without creating a new property.

bool	UpdateCurves (FBProperty pProperty, FBProperty pSrcProperty)
	Update the FCurve for a particular property, without creating a new property.

bool	UpdateCurves (FBProperty pProperty, FBXSDK_NAMESPACE::FbxAnimCurveNode pFCurve)
	Update the FCurve for a particular property, without creating a new property.

bool	UpdateCurves (FBProperty pProperty, FBXSDK_NAMESPACE::FbxProperty pFbxProperty, FBXSDK_NAMESPACE::FbxAnimStack *pStack)
	Update the FCurve for a particular property, without creating a new property.

bool	GetCurves (FBProperty pProperty, FBAnimationNode pFCurve)
	Get the FCurve of a particular property.

bool	GetCurves (FBProperty pProperty, FBProperty pDestProperty)
	Get the FCurve of a particular property.

bool	GetCurves (FBProperty pProperty, FBXSDK_NAMESPACE::FbxAnimCurveNode pFCurve)
	Get the FCurve of a particular property.

bool	GetCurves (FBProperty pProperty, FBXSDK_NAMESPACE::FbxProperty pFbxProperty, FBXSDK_NAMESPACE::FbxAnimStack *pStack)
	Get the FCurve of a particular property.

bool	Frame (bool pSelectedKeysOnly, FBFCurveEditor *pEditor=NULL)
	Frame keys in the FCurve Editor interface.

bool	GetObjects (FBArrayTemplate< FBComponent * > &pObjectList)
	Get all the objects displayed in the left pane of the FCurve Editor.

bool	GetProperties (FBArrayTemplate< FBProperty * > &pProperties, bool pSelectedOnly, FBFCurveEditor *pEditor=NULL)
	Get the displayed properties.

FBTimeSpan	GetTimeSpan (FBFCurveEditor *pEditor=NULL)
	Get the displayed time range of the FCurve Editor.

bool	SetTimeSpan (FBTimeSpan pTimeSpan, FBFCurveEditor *pEditor=NULL)
	Set the displayed time range of the FCurve Editor.

bool	RegisterToFCurveEditorEvent (HICallback pOwner, kICallbackHandler pHandler, FBFCurveEditor *pEditor=NULL)
	Register to FCurve Editor event.

bool	UnregisterToFCurveEditorEvent (HICallback pOwner, kICallbackHandler pHandler, FBFCurveEditor *pEditor=NULL)
	Unregister to FCurve Editor event.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Static Public Member Functions
static FBFCurveEditorUtility &	TheOne ()
	Get the global object for this class.

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.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

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.

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

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

Definition at line 2301 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

pObjectName	Name of the object that will contain the property/curves.
pPropertyName	Name 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.
pPropertyType	Property type for the new property.
pFCurve	Original FCurves to be copied.
pEditor	Pointer 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

pObjectName	Name of the object that will contain the property/curves.
pPropertyName	Name 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
pPropertyType	Property type for the new property.
pFCurve	Original FCurves to be copied.
pEditor	Pointer 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

pObjectName	Name of the object that will contain the property/curves.
pPropertyName	Name 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
pProperty	Property containing the original FCurves; all layers will be copied.
pEditor	Pointer 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

pObjectName	Name of the object that will contain the property/curves.
pPropertyName	Name 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
pProperty	Property containing the original FCurves.
pStack	Animation stack for getting all the animation layers, NULL to use only the base layer.
pEditor	Pointer 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

pSelectedKeysOnly	If true, only the selected keys will be framed, otherwise all keys will be framed.
pEditor	Pointer 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

pProperty	Property to get the curves from.
pFCurve	FCurve 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

pProperty	Property to get the curves from.
pDestProperty	Property 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

pProperty	Property to get the curves from.
pFCurve	FCurve 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

pProperty	Property to get the curves from.
pFbxProperty	Property that will receive the data from the property.
pStack	Animation 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

pObjectList A 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

pPropertyList	Array that will contain the properties displayed.
pSelectedOnly	If true, only the selected properties will be returned.
pEditor	Pointer 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

pEditor Pointer 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

pOwner	Owner of the callback that will be called when an event is sent from the FCurve Editor.
pHandler	Callback to call when receiving an event.
pEditor	Pointer 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

pProperty Property 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

pTimeSpan	The time span that will be set.
pEditor	Pointer 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

pOwner	Owner of the callback to unregister.
pHandler	Callback to unregister.
pEditor	Pointer 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

pProperty	Property to update.
pFCurve	Original 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

pProperty	Property to update.
pSrcProperty	Original 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

pProperty	Property to update.
pFCurve	Original 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

pProperty	Property to update.
pFbxProperty	Property to get the curves from.
pStack	Animation 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:

fbcontrols.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddExternalCurves() [1/4]

◆ AddExternalCurves() [2/4]

◆ AddExternalCurves() [3/4]

◆ AddExternalCurves() [4/4]

◆ Frame()

◆ GetCurves() [1/4]

◆ GetCurves() [2/4]

◆ GetCurves() [3/4]

◆ GetCurves() [4/4]

◆ GetObjects()

◆ GetProperties()

◆ GetTimeSpan()

◆ RegisterToFCurveEditorEvent()

◆ RemoveExternalCurves()

◆ SetTimeSpan()

◆ TheOne()

◆ UnregisterToFCurveEditorEvent()

◆ UpdateCurves() [1/4]

◆ UpdateCurves() [2/4]

◆ UpdateCurves() [3/4]

◆ UpdateCurves() [4/4]