This reference page is linked to from the following overview topics: Python tools: best practices, Tools.
Detailed Description
#include <fbtool.h>
Public Member Functions |
|
| FBTool (char *pName=NULL) | |
| Constructor. |
|
| FBTool (char *pName, bool pRegisterTool) | |
| Constructor used when creating tools not in
the Tools menu of Motion Builder. |
|
| virtual void | Destroy (int pIsLocal) |
| Redefine Custom Destroy function. |
|
| 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 (Implementation) | |
| virtual bool | FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
| Storage/Retrieval of information into the
FBX file format. |
|
| virtual bool | FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
Public Attributes |
|
| FBPropertyInt | StartSize [2] |
| Starting Size. |
|
| FBPropertyInt | MaxSize [2] |
| Maximum Size (Disabled in this version).
|
|
| FBPropertyInt | MinSize [2] |
| Minimum Size. |
|
| FBPropertyInt | StartPos [2] |
| Starting Position. |
|
| FBPropertyString | Name |
| Read Write Property: Unique name of
object. |
|
Constructor & Destructor Documentation
| FBTool | ( | char * | pName = NULL |
) |
Constructor.
- Parameters:
-
pName Name of tool.
| FBTool | ( | char * | pName, |
| bool | pRegisterTool | ||
| ) |
Constructor used when creating tools not in the Tools menu of Motion Builder.
- 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
| virtual void Destroy | ( | int | pIsLocal | ) | [virtual] |
Redefine Custom Destroy function.
Internal use only
- Parameters:
-
pIsLocal Not Used
| virtual bool FbxStore | ( | HFBFbxObject | 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.
| virtual bool FbxRetrieve | ( | HFBFbxObject | pFbxObject, |
| kFbxObjectStore | pStoreWhat | ||
| ) | [virtual] |
| FBToolPossibleDockPosition GetPossibleDockPosition | ( | ) |
Get the possible docking position for the tool (concatenated).
- Returns:
- Get all the docking flags in one call. Flags can be concatenated.
| 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.
| IQuery_Declare | ( | Implementation | ) |
Member Data Documentation
Starting Size.
This is the initial size when the tool is opened. (0:Width, 1:Height. Default = 800x400)
Maximum Size (Disabled in this version).
A value of -1 means no maximum size. (0:Width, 1:Height. Default = -1x-1)
Minimum Size.
A value of -1 means no minimum value. (0:Width, 1:Height. Default = 140x-1).
Starting Position.
This is the initial position when the tool is opened. (0:X, 1:Y. Default for first tool = 450x450)
Read Write Property: Unique name of object.
Reimplemented from FBComponent.
The documentation for this class was generated from the following file:
- fbcontrols/fbtool.h
