Open Reality Reference Guide
FBTool Class Reference

Tool class. More...

#include <fbtool.h>

Inheritance diagram for FBTool:

Public Member Functions

 FBTool (const char *pName=NULL)
 Constructor. More...
 
 FBTool (const char *pName, bool pRegisterTool)
 Constructor used when creating tools not in the Tools menu of MotionBuilder. More...
 
virtual void Destroy (int pIsLocal) override
 Redefine Custom Destroy function. More...
 
virtual bool FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
 Storage/Retrieval of information into the FBX file format. More...
 
virtual bool FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
 
FBToolPossibleDockPosition GetPossibleDockPosition ()
 Get the possible docking position for the tool (concatenated). More...
 
void SetPossibleDockPosition (FBToolPossibleDockPosition pFlags)
 Set the possible docking position for the tool. More...
 
 IQuery_Declare (override)
 
- Public Member Functions inherited from FBLayout
 FBLayout (HIObject pObject=NULL)
 Constructor. More...
 
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. More...
 
virtual bool MoveRegion (const char *pName, int pX, int pY)
 Move a region. More...
 
virtual bool SizeRegion (const char *pName, int pW, int pH)
 Change a region's size. More...
 
virtual bool RemoveRegion (const char *pName)
 Remove a region. More...
 
virtual bool RenameRegion (const char *pOldName, const char *pNewName)
 Rename a region. More...
 
virtual bool GetRegion (const char *pName)
 Verify if a region with pName exists. More...
 
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) More...
 
virtual bool SetControl (const char *pName, FBVisualComponent *pComponent)
 Set control of a region to a visual component. More...
 
virtual bool SetControl (const char *pName, FBVisualComponent &pComponent)
 
virtual void ClearControl (const char *pName)
 Remove a control from a region in a visual component. More...
 
virtual FBVisualComponentGetControl (const char *pName)
 Get control of a region in a visual component. More...
 
virtual HIKtObject GetHIKtObject (const char *pName)
 Set or Get internal toolkit: object. More...
 
virtual bool SetHIKtView (const char *pName, HIKtView pView)
 Set internal toolkit view. More...
 
virtual HIKtView GetHIKtView (const char *pName)
 Get internal toolkit view. More...
 
virtual bool SetView (const char *pName, FBVisualComponent *pComponent)
 Set view. More...
 
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. More...
 
virtual bool SetSplitStyle (const char *pName, FBSplitStyle pRegionType)
 Set a region's splitstyle. More...
 
virtual FBSplitStyle GetSplitStyle (const char *pName)
 Get a region's splitstyle. More...
 
virtual bool SetRegionTitle (const char *pName, const char *pTitle)
 Set a region's title. More...
 
void SetAutoRestructure (bool pAutoRestructure)
 Suspend all automatic layout recomputation. More...
 
void Restructure (bool pNoMove)
 Force a recomputation of all region placements in the layout. More...
 
 IObject_Declare (override)
 
- Public Member Functions inherited from FBVisualComponent
 FBVisualComponent (HIObject pObject)
 Constructor. More...
 
 IObject_Declare (override)
 
 ICallback_Declare (override)
 
virtual HIKtView GetKtView ()
 Get internal toolkit object. More...
 
QWidget * GetQWidgetAddress ()
 Get internal QWidget. More...
 
virtual bool AddChild (FBVisualComponent *pChild, int pId=0)
 Add a child component. More...
 
virtual FBVisualComponentGetChild (int pId=0)
 Get a child component. More...
 
virtual void Refresh (bool pNow=false)
 Refresh component. More...
 
virtual void ViewExpose ()
 Exposed view callback function. More...
 
virtual void ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function. More...
 
virtual bool IsView ()
 Is component a view? More...
 
- Public Member Functions inherited from FBComponent
 FBComponent (HIObject pObject)
 Constructor. More...
 
virtual ~FBComponent ()
 Destructor. More...
 
virtual bool FBCreate ()
 Open Reality Creation function. More...
 
virtual void FBDestroy ()
 Open Reality destruction function. More...
 
virtual void FBDelete () override
 Open Reality deletion function. More...
 
virtual bool SetHIObject (HIObject pObject, bool pSDKComponent) override
 Assign component to an internal pointer. More...
 
virtual int PropertyAdd (FBProperty *pProperty)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
 Add a reference property to the component's property manager. More...
 
void PropertyRemove (FBProperty *pProperty)
 Remove a Property from the component's Property manager. More...
 
void PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
FBPropertyPropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
 Create user or dynamic property. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
void SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
void EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
void DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
void SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessObjectNamespace. More...
 
virtual const char * ClassName () override
 Get the class name. More...
 
virtual bool UseCustomPropertyViewSet () const
 Use the custom property viewSet or not. More...
 
const char * GetFullName (void)
 Get the full name. More...
 
void SetOwnerNamespace (FBNamespace *pOwnerNSObj)
 Set the owner Namespace object. More...
 
FBNamespaceGetOwnerNamespace (void)
 Get the owner Namespace object. More...
 
FBFileReferenceGetOwnerFileReference (void)
 Get the owner FileReference object. More...
 
void HardSelect ()
 HardSelect. More...
 
virtual bool Is (int pTypeId) override
 Returns true if object is of type TypeId. More...
 
virtual int GetTypeId () override
 GetTypeId( int pTypeId ) More...
 
- Public Member Functions inherited from FBWrapperHolder
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
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) More...
 
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) More...
 
FBPropertyInt MinSize [2]
 Read Write Property: Minimum Size. A value of -1 means no minimum value. (0:Width, 1:Height. Default = 140x-1). More...
 
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) More...
 
FBPropertyString Name
 Read-Only Property: Tool Name More...
 
FBPropertyString DisplayName
 Read Write Property: Tool Display Name (Caption on the tool's title bar) More...
 
- Public Attributes inherited from FBLayout
FBPropertyEvent OnInput
 Event: Input. More...
 
FBPropertyEvent OnPaint
 Event: Paint layout. More...
 
FBPropertyEvent OnIdle
 Event: Idle. More...
 
FBPropertyEvent OnShow
 Event: Show layout. More...
 
FBPropertyEvent OnResize
 Event: Resize layout. More...
 
- Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region Region
 
struct K_DLLEXPORT FBVisualComponent::__Border Border
 
FBPropertyString Caption
 Property: Widget caption. More...
 
FBPropertyBool Visible
 Read Write Property: Is visual component visible? More...
 
FBPropertyBool ReadOnly
 Read Write Property: Is visual component read only? More...
 
FBPropertyBool Enabled
 Read Write Property: Is visual enabled? More...
 
FBPropertyString Hint
 Read Write Property: Hint to show. More...
 
FBPropertyInt Left
 Read Write Property: Left coordinate. More...
 
FBPropertyInt Top
 Read Write Property: Top coordinate. More...
 
FBPropertyInt Width
 Read Write Property: Width. More...
 
FBPropertyInt Height
 Read Write Property: Height. More...
 
FBPropertyEvent OnEnter
 Event: On mouse enter. More...
 
FBPropertyEvent OnExit
 Event: On mouse exit. More...
 
- Public Attributes inherited from FBComponent
FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyListComponent Components
 List: List of components. More...
 
FBPropertyListComponent Parents
 List: Parents. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
FBPropertyString LongName
 Read Write Property: Name and namespace for object.
More...
 
FBPropertyFolder Folder
 Read Write Property: The folder that contain this component. More...
 

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. More...
 
- Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject GetHIKtObject ()
 Get internal toolkit object. More...
 
- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
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. More...
 
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. More...
 
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. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component.
More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Detailed Description

Tool class.

Definition at line 112 of file fbtool.h.

Constructor & Destructor Documentation

◆ FBTool() [1/2]

FBTool ( const char *  pName = NULL)

Constructor.

Parameters
pNameName of tool.

◆ FBTool() [2/2]

FBTool ( const char *  pName,
bool  pRegisterTool 
)

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

Parameters
pNameName of tool, must be an unique name.
pRegisterToolTells 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
pIsLocalNot Used

◆ FbxStore()

virtual bool FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
)
virtual

Storage/Retrieval of information into the FBX file format.

Parameters
pFbxObjectObject to interface with FBX file format.
pStoreWhatAttributes 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
pFlagsSet 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 156 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 152 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 153 of file fbtool.h.

◆ Name

Read-Only Property: Tool Name

Definition at line 155 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 154 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 151 of file fbtool.h.


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