Custom manager class for user controlled observer objects. More...

#include <fbcomponent.h>

Inheritance diagram for FBCustomManager:

[legend]

Public Types
typedef FBComponent	__FBParentClass

typedef FBCustomManager	__FBClassType

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

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

	FBCustomManager ()
	return to the default scope (private)

void	RegisterManager ()
	Instantiating the manager is not enough.

virtual bool	FBCreate () override
	Open Reality Creation function.

virtual bool	Init ()
	This method is called upon the loading of the plugin, right after FBCreate is called.

virtual bool	Open ()
	Now all the basic initialization is done, but we have yet to load any FBX files or even create the GUI.

virtual bool	Clear ()
	This callback is used when the scene is cleared.

virtual bool	Close ()
	The application is shutting down.

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 int	GetInternalClassId ()

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)

Public Attributes
DataFBCustomManager *	mLocalPtr

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
static int	TypeInfo

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

Additional Inherited Members
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

Custom manager class for user controlled observer objects.

This class is used to create a singleton object that has a lifetime similar to the one of the application. Meaning that it is created early in the initialization of the application and survives across File->Open and File->New, being destroyed upon shutdown of the application.

The manager object is notified by the application at certain points in time, such as when the scene is cleared or the application is shutting down.

Manager objects are not saved or mentioned in the FBX files created. Its behavior can be controlled via custom configuration files.

Definition at line 1300 of file fbcomponent.h.

Member Typedef Documentation

◆ __FBClassType

typedef FBCustomManager __FBClassType

Definition at line 1301 of file fbcomponent.h.

◆ __FBParentClass

typedef FBComponent __FBParentClass

Definition at line 1301 of file fbcomponent.h.

Constructor & Destructor Documentation

◆ FBCustomManager()

ClassName *return FBCustomManager ( )

return to the default scope (private)

Constructor.

Member Function Documentation

◆ ClassName()

virtual const char * ClassName ( )

inlineoverridevirtual

Get the class name.

Returns: The class name (i.e. "FBComponent").

Reimplemented from FBComponent.

Definition at line 1301 of file fbcomponent.h.

◆ Clear()

virtual bool Clear ( )

virtual

This callback is used when the scene is cleared.

This may be from a new file being loaded (not appended to the current one), a File->New or the application being shutdown.

◆ Close()

virtual bool Close ( )

virtual

The application is shutting down.

Time to cleanup anything that references system resources.

◆ FBCreate()

virtual bool FBCreate ( )

overridevirtual

Open Reality Creation function.

Returns: Outcome of creation (true/false).

Reimplemented from FBComponent.

◆ GetTypeId()

virtual int GetTypeId ( )

inlineoverridevirtual

GetTypeId( int pTypeId )

Returns: The TypeInfo of the object

Reimplemented from FBComponent.

Definition at line 1301 of file fbcomponent.h.

◆ Init()

virtual bool Init ( )

virtual

This method is called upon the loading of the plugin, right after FBCreate is called.

Since it happens very early in the lifespan of the application, not all the initialization is done. So access to system objects is very limited.

◆ Is()

Is ( int pTypeId )

inlineoverridevirtual

Returns true if object is of type TypeId.

Parameters

pTypeId TypeId to compare object to.

Returns: Result of the comparison.

Reimplemented from FBComponent.

Definition at line 1301 of file fbcomponent.h.

◆ Open()

virtual bool Open ( )

virtual

Now all the basic initialization is done, but we have yet to load any FBX files or even create the GUI.

/warning if Init does not return true, the 'Close()' method will not be called.

◆ RegisterManager()

void RegisterManager ( )

Instantiating the manager is not enough.

It also need to be registered in the list of all managers. This call is done automatically via the use of the macro 'FBRegisterCustomManager'.

Member Data Documentation

◆ mLocalPtr

DataFBCustomManager* mLocalPtr

Definition at line 1301 of file fbcomponent.h.

◆ TypeInfo

int TypeInfo

static

Definition at line 1301 of file fbcomponent.h.

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

fbcomponent.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ __FBClassType

◆ __FBParentClass

Constructor & Destructor Documentation

◆ FBCustomManager()

Member Function Documentation

◆ ClassName()

◆ Clear()

◆ Close()

◆ FBCreate()

◆ GetTypeId()

◆ Init()

◆ Is()

◆ Open()

◆ RegisterManager()

Member Data Documentation

◆ mLocalPtr

◆ TypeInfo