Declaration for the FBTool class. More...
Go to the source code of this file.
Classes | |
class | FBTool |
Tool class. More... | |
Macros | |
#define | FBSDK_DLL K_DLLIMPORT |
Be sure that FBSDK_DLL is defined only once... More... | |
#define | FBRegisterTool(ClassName, Label, Description, IconFilename) |
Register a tool. More... | |
#define | FBToolDeclare(ClassName, Parent) |
Tool class declaration. More... | |
#define | FBToolImplementation(ThisComponent) FBClassImplementation( ThisComponent ) |
Tool class implementation. More... | |
Functions | |
FB_FORWARD (FBFbxObject) | |
__FB_FORWARD (FBTool) | |
K_DLLIMPORT bool | FBPopNormalTool (const char *pToolName, bool pSetFocus=true) |
This function is used to bring up a specific tool in the GUI. More... | |
K_DLLIMPORT FBTool * | FBShowToolByName (const char *pToolName, bool pResizeWnd=true) |
This function will show a specific tool in the GUI. More... | |
K_DLLIMPORT FBTool * | FBShowTool (FBTool *pTool, bool pResizeWnd=true) |
This function will show a specific tool in the GUI. More... | |
K_DLLIMPORT bool | FBCloseToolByName (const char *pToolName) |
This function will close a specific tool in the GUI. More... | |
K_DLLIMPORT bool | FBCloseTool (FBTool *pTool) |
This function will close a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBDestroyToolByName (const char *pToolName) |
This function will destroy a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBDestroyTool (FBTool *pTool) |
This function will destroy a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBSetToolSizeByName (const char *pToolName, int pWidth, int pHeight) |
This function will set the size of a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBSetToolSize (FBTool *pTool, int pWidth, int pHeight) |
This function will set the size of a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBGetToolSizeByName (const char *pToolName, int &pWidth, int &pHeight) |
This function will get the size of a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBGetToolSize (FBTool *pTool, int &pWidth, int &pHeight) |
This function will get the size of a specific tool in the GUI. More... | |
K_DLLIMPORT void | FBSetToolPositionByName (const char *pToolName, int pPosX, int pPosY) |
This function will set the position of a specific tool. More... | |
K_DLLIMPORT void | FBSetToolPosition (FBTool *pTool, int pPosX, int pPosY) |
This function will set the position of a specific tool. More... | |
K_DLLIMPORT void | FBGetToolPositionByName (const char *pToolName, int &pPosX, int &pPosY) |
This function will get the position of a specific tool. More... | |
K_DLLIMPORT void | FBGetToolPosition (FBTool *pTool, int &pPosX, int &pPosY) |
This function will get the position of a specific tool. More... | |
#define FBRegisterTool | ( | ClassName, | |
Label, | |||
Description, | |||
IconFilename | |||
) |
Register a tool.
ClassName | Name of tool class to register. |
Label | Short description of tool. |
Description | Long description of tool. |
IconFilename | Filename of associated icon. |
#define FBSDK_DLL K_DLLIMPORT |
#define FBToolDeclare | ( | ClassName, | |
Parent | |||
) |
Tool class declaration.
ClassName | Name of tool class to declare. |
Parent | Name of tool class parent class. |
#define FBToolImplementation | ( | ThisComponent | ) | FBClassImplementation( ThisComponent ) |
K_DLLIMPORT bool FBCloseTool | ( | FBTool * | pTool | ) |
This function will close a specific tool in the GUI.
pTool | A pointer to the tool to close. |
K_DLLIMPORT bool FBCloseToolByName | ( | const char * | pToolName | ) |
This function will close a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
K_DLLIMPORT void FBDestroyTool | ( | FBTool * | pTool | ) |
This function will destroy a specific tool in the GUI.
pTool | A pointer to the tool to destroy. |
K_DLLIMPORT void FBDestroyToolByName | ( | const char * | pToolName | ) |
This function will destroy a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
K_DLLIMPORT void FBGetToolPosition | ( | FBTool * | pTool, |
int & | pPosX, | ||
int & | pPosY | ||
) |
This function will get the position of a specific tool.
pTool | A pointer to the tool. |
pPosX | Current position in X of the tool. |
pPosY | Current position in Y of the tool. |
K_DLLIMPORT void FBGetToolPositionByName | ( | const char * | pToolName, |
int & | pPosX, | ||
int & | pPosY | ||
) |
This function will get the position of a specific tool.
pToolName | The name of the tool as shown in the Open Reality menu. |
pPosX | Current position in X of the tool. |
pPosY | Current position in Y of the tool. |
K_DLLIMPORT void FBGetToolSize | ( | FBTool * | pTool, |
int & | pWidth, | ||
int & | pHeight | ||
) |
This function will get the size of a specific tool in the GUI.
pTool | A pointer to the tool. |
pWidth | Current width of the tool. |
pHeight | Current height of the tool. |
K_DLLIMPORT void FBGetToolSizeByName | ( | const char * | pToolName, |
int & | pWidth, | ||
int & | pHeight | ||
) |
This function will get the size of a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
pWidth | Current width of the tool. |
pHeight | Current height of the tool. |
K_DLLIMPORT bool FBPopNormalTool | ( | const char * | pToolName, |
bool | pSetFocus = true |
||
) |
This function is used to bring up a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
pSetFocus | Indicate if the tool will have the focus. |
K_DLLIMPORT void FBSetToolPosition | ( | FBTool * | pTool, |
int | pPosX, | ||
int | pPosY | ||
) |
This function will set the position of a specific tool.
pTool | A pointer to the tool. |
pPosX | New position in X for the tool. |
pPosY | New position in Y for the tool. |
K_DLLIMPORT void FBSetToolPositionByName | ( | const char * | pToolName, |
int | pPosX, | ||
int | pPosY | ||
) |
This function will set the position of a specific tool.
pToolName | The name of the tool as shown in the Open Reality menu. |
pPosX | New position in X for the tool. |
pPosY | New position in Y for the tool. |
K_DLLIMPORT void FBSetToolSize | ( | FBTool * | pTool, |
int | pWidth, | ||
int | pHeight | ||
) |
This function will set the size of a specific tool in the GUI.
pTool | A pointer to the tool. |
pWidth | New width of the tool. |
pHeight | New height of the tool. |
K_DLLIMPORT void FBSetToolSizeByName | ( | const char * | pToolName, |
int | pWidth, | ||
int | pHeight | ||
) |
This function will set the size of a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
pWidth | New width of the tool. |
pHeight | New height of the tool. |
This function will show a specific tool in the GUI.
pTool | A pointer to the tool to show. |
pResizeWnd | Adjust the size of the tool window if needed (if started too close to the end of the screen for example). |
K_DLLIMPORT FBTool* FBShowToolByName | ( | const char * | pToolName, |
bool | pResizeWnd = true |
||
) |
This function will show a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
pResizeWnd | Adjust the size of the tool window if needed (if started too close to the end of the screen for example). |