Tool class. More...

#include <fbtool.h>

Inheritance diagram for FBTool:

[legend]

Public Member Functions
	FBTool (const char *pName=NULL)
	Constructor.

	FBTool (const char *pName, bool pRegisterTool)
	Constructor used when creating tools not in the Tools menu of MotionBuilder.

virtual void	Destroy (int pIsLocal) override
	Redefine Custom Destroy function.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

FBToolPossibleDockPosition	GetPossibleDockPosition ()
	Get the possible docking position for the tool (concatenated).

void	SetPossibleDockPosition (FBToolPossibleDockPosition pFlags)
	Set the possible docking position for the tool.

	IQuery_Declare (override)

Public Member Functions inherited from FBLayout
	FBLayout (HIObject pObject=NULL)
	Constructor.

virtual bool	AddRegion (const char pName, const char pTitle, int pX, FBAttachType pXType, const char pXRelative, float pMultX, int pY, FBAttachType pYType, const char pYRelative, float pMultY, int pW, FBAttachType pWType, const char pWRelative, float pMultW, int pH, FBAttachType pHType, const char pHRelative, float pMultH)
	Add a region to the layout.

virtual bool	MoveRegion (const char *pName, int pX, int pY)
	Move a region.

virtual bool	SizeRegion (const char *pName, int pW, int pH)
	Change a region's size.

virtual bool	RemoveRegion (const char *pName)
	Remove a region.

virtual bool	RenameRegion (const char pOldName, const char pNewName)
	Rename a region.

virtual bool	GetRegion (const char *pName)
	Verify if a region with pName exists.

virtual bool	GetRegionPositions (const char pName, bool pComputed, int pX, int pY, int pW=NULL, int *pH=NULL)
	Get region pName information (position and size)

virtual bool	SetControl (const char pName, FBVisualComponent pComponent)
	Set control of a region to a visual component.

virtual bool	SetControl (const char *pName, FBVisualComponent &pComponent)

virtual void	ClearControl (const char *pName)
	Remove a control from a region in a visual component.

virtual FBVisualComponent *	GetControl (const char *pName)
	Get control of a region in a visual component.

virtual HIKtObject	GetHIKtObject (const char *pName)
	Set or Get internal toolkit: object.

virtual bool	SetHIKtView (const char *pName, HIKtView pView)
	Set internal toolkit view.

virtual HIKtView	GetHIKtView (const char *pName)
	Get internal toolkit view.

virtual bool	SetView (const char pName, FBVisualComponent pComponent)
	Set view.

virtual bool	SetView (const char *pName, FBVisualComponent &pComponent)

virtual bool	SetBorder (const char *pName, FBBorderStyle pType, bool pShowTitle, bool pInSet, int pWidth, int pSpacing, float pMaxAngle, int pCornerRadius)
	Set border properties for a region.

virtual bool	SetSplitStyle (const char *pName, FBSplitStyle pRegionType)
	Set a region's splitstyle.

virtual FBSplitStyle	GetSplitStyle (const char *pName)
	Get a region's splitstyle.

virtual bool	SetRegionTitle (const char pName, const char pTitle)
	Set a region's title.

void	SetAutoRestructure (bool pAutoRestructure)
	Suspend all automatic layout recomputation.

void	Restructure (bool pNoMove)
	Force a recomputation of all region placements in the layout.

	IObject_Declare (override)

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

	IObject_Declare (override)

	ICallback_Declare (override)

virtual HIKtView	GetKtView ()
	Get internal toolkit object.

QWidget *	GetQWidgetAddress ()
	Get internal QWidget.

virtual bool	AddChild (FBVisualComponent *pChild, int pId=0)
	Add a child component.

virtual FBVisualComponent *	GetChild (int pId=0)
	Get a child component.

virtual void	Refresh (bool pNow=false)
	Refresh component.

virtual void	ViewExpose ()
	Exposed view callback function.

virtual void	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function.

virtual bool	IsView ()
	Is component a view?

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 *)

Public Attributes
FBPropertyInt	StartSize [2]
	Read Write Property: Starting Size. This is the initial size when the tool is opened. (0:Width, 1:Height. Default = 800x400)

FBPropertyInt	MaxSize [2]
	Read Write Property: Maximum Size (Disabled in this version). A value of -1 means no maximum size. (0:Width, 1:Height. Default = -1x-1)

FBPropertyInt	MinSize [2]
	Read Write Property: Minimum Size. A value of -1 means no minimum value. (0:Width, 1:Height. Default = 140x-1).

FBPropertyInt	StartPos [2]
	Read Write Property: Starting Position. This is the initial position when the tool is opened. (0:X, 1:Y. Default for first tool = 450x450)

FBPropertyString	Name
	Read-Only Property: Tool Name

FBPropertyString	DisplayName
	Read Write Property: Tool Display Name (Caption on the tool's title bar)

Public Attributes inherited from FBLayout
FBPropertyEvent	OnInput
	Event: Input.

FBPropertyEvent	OnPaint
	Event: Paint layout.

FBPropertyEvent	OnIdle
	Event: Idle.

FBPropertyEvent	OnShow
	Event: Show layout.

FBPropertyEvent	OnResize
	Event: Resize layout.

Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region	Region

struct K_DLLEXPORT FBVisualComponent::__Border	Border

FBPropertyString	Caption
	Property: Widget caption.

FBPropertyBool	Visible
	Read Write Property: Is visual component visible?

FBPropertyBool	ReadOnly
	Read Write Property: Is visual component read only?

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled?

FBPropertyString	Hint
	Read Write Property: Hint to show.

FBPropertyInt	Left
	Read Write Property: Left coordinate.

FBPropertyInt	Top
	Read Write Property: Top coordinate.

FBPropertyInt	Width
	Read Write Property: Width.

FBPropertyInt	Height
	Read Write Property: Height.

FBPropertyEvent	OnEnter
	Event: On mouse enter.

FBPropertyEvent	OnExit
	Event: On mouse exit.

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.

Additional Inherited Members
Public Types inherited from FBLayout
enum	FBSplitStyle { kFBNoSplit = 0 , kFBHSplit = 1 , kFBVSplit = 2 , kFBHVSplit = 3 }
	Type of split style (sub-division) for layout. 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)

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

Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject	GetHIKtObject ()
	Get internal toolkit 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

Tool class.

Definition at line 135 of file fbtool.h.

Constructor & Destructor Documentation

◆ FBTool() [1/2]

FBTool ( const char * pName = NULL )

Constructor.

Parameters

pName Name of tool.

◆ FBTool() [2/2]

FBTool	(	const char *	pName,
		bool	pRegisterTool
	)

Constructor used when creating tools not in the Tools menu of MotionBuilder.

Parameters

pName	Name of tool, must be an unique name.
pRegisterTool	Tells if we should register the tool on the toolmanager. You can later call Showtool to pop it.

Member Function Documentation

◆ Destroy()

virtual void Destroy ( int pIsLocal )

overridevirtual

Redefine Custom Destroy function.

Internal use only

Parameters

pIsLocal Not Used

◆ FbxStore()

virtual bool FbxStore	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

virtual

Storage/Retrieval of information into the FBX file format.

Parameters

pFbxObject	Object to interface with FBX file format.
pStoreWhat	Attributes to store in FBX file.

◆ GetPossibleDockPosition()

FBToolPossibleDockPosition GetPossibleDockPosition ( )

Get the possible docking position for the tool (concatenated).

Returns: Get all the docking flags in one call. Flags can be concatenated.

◆ SetPossibleDockPosition()

void SetPossibleDockPosition ( FBToolPossibleDockPosition pFlags )

Set the possible docking position for the tool.

Be sure to call this function once the tool is visible, a good place to call it is when the OnShow event of the layout is called.

Parameters

pFlags Set the docking position flag values. Note: this function overwrites all flags with those passed in parameter.

Member Data Documentation

◆ DisplayName

FBPropertyString DisplayName

Read Write Property: Tool Display Name (Caption on the tool's title bar)

Definition at line 179 of file fbtool.h.

◆ MaxSize

FBPropertyInt MaxSize[2]

Read Write Property: Maximum Size (Disabled in this version). A value of -1 means no maximum size. (0:Width, 1:Height. Default = -1x-1)

Definition at line 175 of file fbtool.h.

◆ MinSize

FBPropertyInt MinSize[2]

Read Write Property: Minimum Size. A value of -1 means no minimum value. (0:Width, 1:Height. Default = 140x-1).

Definition at line 176 of file fbtool.h.

◆ Name

FBPropertyString Name

Read-Only Property: Tool Name

Definition at line 178 of file fbtool.h.

◆ StartPos

FBPropertyInt StartPos[2]

Read Write Property: Starting Position. This is the initial position when the tool is opened. (0:X, 1:Y. Default for first tool = 450x450)

Definition at line 177 of file fbtool.h.

◆ StartSize

FBPropertyInt StartSize[2]

Read Write Property: Starting Size. This is the initial size when the tool is opened. (0:Width, 1:Height. Default = 800x400)

Definition at line 174 of file fbtool.h.

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

fbtool.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBTool() [1/2]

◆ FBTool() [2/2]

Member Function Documentation

◆ Destroy()

◆ FbxStore()

◆ GetPossibleDockPosition()

◆ SetPossibleDockPosition()

Member Data Documentation

◆ DisplayName

◆ MaxSize

◆ MinSize

◆ Name

◆ StartPos

◆ StartSize