FBFCurveEditorUtility Class Reference

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

#include <pyfbsdk_generated.h>

Inheritance diagram for FBFCurveEditorUtility:

Public Member Functions
bool	Frame (bool pSelectedKeysOnly, FBFCurveEditor pEditor=None)
	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< FB > pProperties, bool pSelectedOnly, FBFCurveEditor pEditor=None)
	Get the displayed properties.
FBTimeSpan	GetTimeSpan (FBFCurveEditor pEditor=None)
	Get the displayed time range of the FCurve Editor.
bool	SetTimeSpan (FBTimeSpan pTimeSpan, FBFCurveEditor pEditor=None)
	Set the displayed time range of the FCurve Editor.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
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.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Additional Inherited Members
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

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

Member Function Documentation

Frame()

bool Frame	(	bool	pSelectedKeysOnly,
		FBFCurveEditor	pEditor = None
	)

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.

Returns

True if successful, false otherwise.

Note

pEditor is currently not supported in this implementation, as the FBFCurveEditor is still in development.

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< FB >	pProperties,
		bool	pSelectedOnly,
		FBFCurveEditor	pEditor = None
	)

Get the displayed properties.

Parameters

pProperties	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 = None

)

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.

SetTimeSpan()

bool SetTimeSpan	(	FBTimeSpan	pTimeSpan,
		FBFCurveEditor	pEditor = None
	)

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.