FBToolLayoutManager Class Reference

Tool Layout Manager class. More...

#include <fbtoollayoutmanager.h>

Inheritance diagram for FBToolLayoutManager:

Public Member Functions
int	GetFactoryLayoutCount ()
	Get the number of factory layouts.
int	GetCustomLayoutCount ()
	Get the number of custom layouts.
const char *	GetLayoutName (int pLayoutIdx)
	Get the layout name associated with the given layout index.
int	GetCurrentLayoutIdx ()
	Get the layout index of the current layout.
const char *	GetCurrentLayoutName ()
	Get the name of the current layout.
bool	SetCurrentLayout (int pLayoutIdx)
	Set the current layout from the given layout index.
bool	SetCurrentLayout (const char *pLayoutName)
	Set the current layout from the given layout name.
const char *	CreateLayout (const char *pLayoutName)
	Create a new layout from the current layout state.
bool	DeleteLayout (int pLayoutIdx)
	Delete the layout associated with the given layout index.
bool	DeleteLayout (const char *pLayoutName)
	Delete the layout with the given layout name.
bool	UpdateCurrentLayout ()
	Update the current layout from the current layout state.
const char *	RenameLayout (const char *pOldLayoutName, const char *pNewLayoutName)
	Rename a layout.
bool	GetAutoUpdateLayout ()
	Get the 'Auto-update Layout' state value.
bool	SetAutoUpdateLayout (bool pAutoUpdate)
	Set the 'Auto-update Layout' state value.
bool	GetPreventDocking ()
	Get the 'Prevent Docking' state value.
bool	SetPreventDocking (bool pPreventDocking)
	Set the 'Prevent Docking' state value.
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 FBToolLayoutManager &	TheOne ()
	Returns the only instance of FBToolLayoutManager.
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)

Protected Member Functions
	FBToolLayoutManager ()
	Constructor.
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.

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.
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

Tool Layout Manager class.

This class allows users to interact with Layouts.

Sample Python code:

from pyfbsdk import *
 
lToolLayoutMan = FBToolLayoutManager()
 
# Delete all existing custom layout
for i in range( lToolLayoutMan.GetCustomLayoutCount() ):
    lToolLayoutMan.DeleteLayout( lToolLayoutMan.GetCustomLayoutCount() - 1 )
 
# Create a new layout
lToolLayoutMan.CreateLayout( "MyLayout" )
 
# Print the names of all the factory layouts
print "Factory layouts:"
print "----------------"
for aLayoutIdx in range(lToolLayoutMan.GetFactoryLayoutCount()):
    print lToolLayoutMan.GetLayoutName(-aLayoutIdx-1)
 
# Print the names of all the custom layouts
print ""
print "Custom layouts:"
print "----------------"
for aLayoutIdx in range(lToolLayoutMan.GetCustomLayoutCount()):
    print lToolLayoutMan.GetLayoutName(aLayoutIdx)
 
# Set the Scripting Layout
lToolLayoutMan.SetCurrentLayout( -2 )
 
# Delete the custom layout
lToolLayoutMan.DeleteLayout( "MyLayout" )

Definition at line 103 of file fbtoollayoutmanager.h.

Constructor & Destructor Documentation

FBToolLayoutManager()

FBToolLayoutManager ( )

protected

Constructor.

Protected constructor, use TheOne() access instead.

Member Function Documentation

CreateLayout()

const char * CreateLayout

(

const char *

pLayoutName

)

Create a new layout from the current layout state.

Parameters

pLayoutName

The new layout name to create.

Returns

The new layout's name (could be different that the one supplied) if the operation is successful, nullptr (C++) or None (Python) otherwise.

DeleteLayout() [1/2]

bool DeleteLayout

(

const char *

pLayoutName

)

Delete the layout with the given layout name.

Deleting a factory layout is not permitted.

Parameters

pLayoutName

The layout name to delete.

Returns

True if the operation is successful, false otherwise.

DeleteLayout() [2/2]

bool DeleteLayout

(

int

pLayoutIdx

)

Delete the layout associated with the given layout index.

Deleting a factory layout is not permitted.

Parameters

pLayoutIdx

The layout index to delete.

Returns

True if the operation is successful, false otherwise.

GetAutoUpdateLayout()

bool GetAutoUpdateLayout

(

)

Get the 'Auto-update Layout' state value.

Returns

The 'Auto-update Layout' state value.

GetCurrentLayoutIdx()

int GetCurrentLayoutIdx

(

)

Get the layout index of the current layout.

Returns

The layout index of the current layout.

GetCurrentLayoutName()

const char * GetCurrentLayoutName

(

)

Get the name of the current layout.

Returns

The name of the current layout.

GetCustomLayoutCount()

int GetCustomLayoutCount

(

)

Get the number of custom layouts.

Returns

The number of custom layouts.

GetFactoryLayoutCount()

int GetFactoryLayoutCount

(

)

Get the number of factory layouts.

Returns

The number of factory layouts.

GetLayoutName()

const char * GetLayoutName

(

int

pLayoutIdx

)

Get the layout name associated with the given layout index.

Parameters

pLayoutIdx

The layout index to query. The factory layouts are using negative indices.

Returns

The layout name if the operation is successful, nullptr (C++) or None (Python) otherwise.

GetPreventDocking()

bool GetPreventDocking

(

)

Get the 'Prevent Docking' state value.

Note: When 'Prevent Docking' state is true, it is possible to temporary allow docking a window by holding the SHIFT key before moving it. When 'Prevent Docking' state is false, it is possible to temporary prevent docking a window by holding the CTRL key before moving it.

Returns

The 'Prevent Docking' state value.

RenameLayout()

const char * RenameLayout	(	const char *	pOldLayoutName,
		const char *	pNewLayoutName
	)

Rename a layout.

Renaming a factory layout is not permitted.

Parameters

pOldLayoutName	The layout's name to rename.
pNewLayoutName	The new layout name.

Returns

The new layout's name (could be different that the one supplied) if the operation is successful, nullptr (C++) or None (Python) otherwise.

SetAutoUpdateLayout()

bool SetAutoUpdateLayout

(

bool

pAutoUpdate

)

Set the 'Auto-update Layout' state value.

Parameters

pAutoUpdate

The 'Auto-update Layout' state value.

Returns

True if the operation is successful, false otherwise.

SetCurrentLayout() [1/2]

bool SetCurrentLayout

(

const char *

pLayoutName

)

Set the current layout from the given layout name.

Parameters

pLayoutName

The layout's name to set as the current layout.

Returns

True if the operation is successful, false otherwise.

SetCurrentLayout() [2/2]

bool SetCurrentLayout

(

int

pLayoutIdx

)

Set the current layout from the given layout index.

Parameters

pLayoutIdx

The layout index to set as the current layout. The factory layouts are using negative indices.

Returns

True if the operation is successful, false otherwise.

SetPreventDocking()

bool SetPreventDocking

(

bool

pPreventDocking

)

Set the 'Prevent Docking' state value.

Note: When 'Prevent Docking' state is true, it is possible to temporary allow docking a window by holding the SHIFT key before moving it. When 'Prevent Docking' state is false, it is possible to temporary prevent docking a window by holding the CTRL key before moving it.

Parameters

pPreventDocking

The 'Prevent Docking' state value.

Returns

True if the operation is successful, false otherwise.

TheOne()

static FBToolLayoutManager & TheOne ( )

static

Returns the only instance of FBToolLayoutManager.

Returns

The only instance of FBToolLayoutManager.

UpdateCurrentLayout()

bool UpdateCurrentLayout

(

)

Update the current layout from the current layout state.

Updating a factory layout is not permitted.

Returns

True if the operation is successful, false otherwise.

---

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

• fbtoollayoutmanager.h