Declaration for the FBTool class. More...

#include <kaydaradef.h>
#include <fbcontrols/fbcontrols.h>

Classes
class	FBTool
	Tool class. More...

Macros
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...

#define	FBRegisterTool(ClassName, Label, Description, IconFilename)
	Register a tool (will be added to the "Open Reality" > Tools menu).

#define	FBRegisterWindowTool(ClassName, Label, Description, IconFilename)
	Register a tool (will be added to the Windows menu).

#define	FBToolDeclare(ClassName, Parent)
	Tool class declaration.

#define	FBToolImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Tool class implementation.

Enumerations
enum	FBToolPossibleDockPosition { kFBToolPossibleDockPosNone = 0 , kFBToolPossibleDockPosTop = (1 << 0) , kFBToolPossibleDockPosLeft = (1 << 1) , kFBToolPossibleDockPosRight = (1 << 2) , kFBToolPossibleDockPosBottom = (1 << 3) }

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.

K_DLLIMPORT FBTool *	FBShowToolByName (const char *pToolName, bool pResizeWnd=true)
	This function will show a specific tool in the GUI.

K_DLLIMPORT FBTool *	FBShowTool (FBTool *pTool, bool pResizeWnd=true)
	This function will show a specific tool in the GUI.

K_DLLIMPORT bool	FBCloseToolByName (const char *pToolName)
	This function will close a specific tool in the GUI.

K_DLLIMPORT bool	FBCloseTool (FBTool *pTool)
	This function will close a specific tool in the GUI.

K_DLLIMPORT void	FBDestroyToolByName (const char *pToolName)
	This function will destroy a specific tool in the GUI.

K_DLLIMPORT void	FBDestroyTool (FBTool *pTool)
	This function will destroy a specific tool in the GUI.

K_DLLIMPORT void	FBSetToolSizeByName (const char *pToolName, int pWidth, int pHeight)
	This function will set the size of a specific tool in the GUI.

K_DLLIMPORT void	FBSetToolSize (FBTool *pTool, int pWidth, int pHeight)
	This function will set the size of a specific tool in the GUI.

K_DLLIMPORT void	FBGetToolSizeByName (const char *pToolName, int &pWidth, int &pHeight)
	This function will get the size of a specific tool in the GUI.

K_DLLIMPORT void	FBGetToolSize (FBTool *pTool, int &pWidth, int &pHeight)
	This function will get the size of a specific tool in the GUI.

K_DLLIMPORT void	FBSetToolPositionByName (const char *pToolName, int pPosX, int pPosY)
	This function will set the position of a specific tool.

K_DLLIMPORT void	FBSetToolPosition (FBTool *pTool, int pPosX, int pPosY)
	This function will set the position of a specific tool.

K_DLLIMPORT void	FBGetToolPositionByName (const char *pToolName, int &pPosX, int &pPosY)
	This function will get the position of a specific tool.

K_DLLIMPORT void	FBGetToolPosition (FBTool *pTool, int &pPosX, int &pPosY)
	This function will get the position of a specific tool.

Detailed Description

Declaration for the FBTool class.

Definition in file fbtool.h.

Macro Definition Documentation

◆ FBRegisterTool

#define FBRegisterTool	(	ClassName,
		Label,
		Description,
		IconFilename
	)

Value:

    static HIObject RegisterTool##ClassName( HIObject pOwner,const char* pName,void * pData) \
{\
    ClassName *Class = new ClassName( Label ); \
    Class->mAllocated = true; \
    if( Class->FBCreate() ) {\
    return Class->GetHIObject(); \
    } else { \
    delete Class; \
    return NULL; \
    } \
} \
    FBLibraryModule( ClassName )    \
{   \
    FBRegisterObject( ClassName,"UI/Tools",Label,Description,RegisterTool##ClassName, false, IconFilename );\
}

Register a tool (will be added to the "Open Reality" > Tools menu).

Parameters

ClassName	Name of tool class to register.
Label	Short description of tool.
Description	Long description of tool.
IconFilename	Filename of associated icon.

Definition at line 66 of file fbtool.h.

◆ FBRegisterWindowTool

#define FBRegisterWindowTool	(	ClassName,
		Label,
		Description,
		IconFilename
	)

Value:

    static HIObject RegisterTool##ClassName( HIObject pOwner,const char* pName,void * pData) \
{\
    ClassName *Class = new ClassName( Label ); \
    Class->mAllocated = true; \
    if( Class->FBCreate() ) {\
    return Class->GetHIObject(); \
    } else { \
    delete Class; \
    return NULL; \
    } \
} \
    FBLibraryModule( ClassName )    \
{   \
    FBRegisterObject( ClassName,"UI/WindowTools",Label,Description,RegisterTool##ClassName, false, IconFilename );\
}

Register a tool (will be added to the Windows menu).

Parameters

ClassName	Name of tool class to register.
Label	Short description of tool.
Description	Long description of tool.
IconFilename	Filename of associated icon.

Definition at line 89 of file fbtool.h.

◆ FBSDK_DLL

#define FBSDK_DLL K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbtool.h.

◆ FBToolDeclare

#define FBToolDeclare	(	ClassName,
		Parent
	)

Value:

    FBClassDeclare( ClassName,Parent ); \
public: \
    ClassName(const char *pName=NULL):Parent(pName) { FBClassInit; } \
private:

Tool class declaration.

Parameters

ClassName	Name of tool class to declare.
Parent	Name of tool class parent class.

Definition at line 110 of file fbtool.h.

◆ FBToolImplementation

#define FBToolImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Tool class implementation.

Parameters

ThisComponent Tool class to implement.

Definition at line 119 of file fbtool.h.

Enumeration Type Documentation

◆ FBToolPossibleDockPosition

enum FBToolPossibleDockPosition

Definition at line 125 of file fbtool.h.

Function Documentation

◆ FBCloseTool()

K_DLLIMPORT bool FBCloseTool ( FBTool * pTool )

This function will close a specific tool in the GUI.

Parameters

pTool A pointer to the tool to close.

Returns: True if the tool was closed successfully, false otherwise.

◆ FBCloseToolByName()

K_DLLIMPORT bool FBCloseToolByName ( const char * pToolName )

This function will close a specific tool in the GUI.

Parameters

pToolName The name of the tool as shown in the Open Reality menu.

Returns: True if the tool was closed successfully, false otherwise.

◆ FBDestroyTool()

K_DLLIMPORT void FBDestroyTool ( FBTool * pTool )

This function will destroy a specific tool in the GUI.

Parameters

pTool A pointer to the tool to destroy.

◆ FBDestroyToolByName()

K_DLLIMPORT void FBDestroyToolByName ( const char * pToolName )

This function will destroy a specific tool in the GUI.

Parameters

pToolName The name of the tool as shown in the Open Reality menu.

◆ FBGetToolPosition()

K_DLLIMPORT void FBGetToolPosition	(	FBTool *	pTool,
		int &	pPosX,
		int &	pPosY
	)

This function will get the position of a specific tool.

Parameters

pTool	A pointer to the tool.
pPosX	Current position in X of the tool.
pPosY	Current position in Y of the tool.

◆ FBGetToolPositionByName()

K_DLLIMPORT void FBGetToolPositionByName	(	const char *	pToolName,
		int &	pPosX,
		int &	pPosY
	)

This function will get the position of a specific tool.

Parameters

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.

◆ FBGetToolSize()

K_DLLIMPORT void FBGetToolSize	(	FBTool *	pTool,
		int &	pWidth,
		int &	pHeight
	)

This function will get the size of a specific tool in the GUI.

Parameters

pTool	A pointer to the tool.
pWidth	Current width of the tool.
pHeight	Current height of the tool.

◆ FBGetToolSizeByName()

K_DLLIMPORT void FBGetToolSizeByName	(	const char *	pToolName,
		int &	pWidth,
		int &	pHeight
	)

This function will get the size of a specific tool in the GUI.

Parameters

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.

◆ FBPopNormalTool()

K_DLLIMPORT bool FBPopNormalTool	(	const char *	pToolName,
		bool	pSetFocus = `true`
	)

This function is used to bring up a specific tool in the GUI.

Parameters

pToolName	The name of the tool as shown in the Open Reality menu.
pSetFocus	Indicate if the tool will have the focus.

Returns: If the tool was brought up successfully.

◆ FBSetToolPosition()

K_DLLIMPORT void FBSetToolPosition	(	FBTool *	pTool,
		int	pPosX,
		int	pPosY
	)

This function will set the position of a specific tool.

Parameters

pTool	A pointer to the tool.
pPosX	New position in X for the tool.
pPosY	New position in Y for the tool.

◆ FBSetToolPositionByName()

K_DLLIMPORT void FBSetToolPositionByName	(	const char *	pToolName,
		int	pPosX,
		int	pPosY
	)

This function will set the position of a specific tool.

Parameters

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.

◆ FBSetToolSize()

K_DLLIMPORT void FBSetToolSize	(	FBTool *	pTool,
		int	pWidth,
		int	pHeight
	)

This function will set the size of a specific tool in the GUI.

Parameters

pTool	A pointer to the tool.
pWidth	New width of the tool.
pHeight	New height of the tool.

◆ FBSetToolSizeByName()

K_DLLIMPORT void FBSetToolSizeByName	(	const char *	pToolName,
		int	pWidth,
		int	pHeight
	)

This function will set the size of a specific tool in the GUI.

Parameters

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.

◆ FBShowTool()

K_DLLIMPORT FBTool * FBShowTool	(	FBTool *	pTool,
		bool	pResizeWnd = `true`
	)

This function will show a specific tool in the GUI.

Parameters

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

Returns: A pointer to the FBTool object, NULL otherwise.

◆ FBShowToolByName()

K_DLLIMPORT FBTool * FBShowToolByName	(	const char *	pToolName,
		bool	pResizeWnd = `true`
	)

This function will show a specific tool in the GUI.

Parameters

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

Returns: A pointer to the FBTool object, NULL otherwise.

Classes

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ FBRegisterTool

◆ FBRegisterWindowTool

◆ FBSDK_DLL

◆ FBToolDeclare

◆ FBToolImplementation

Enumeration Type Documentation

◆ FBToolPossibleDockPosition

Function Documentation

◆ FBCloseTool()

◆ FBCloseToolByName()

◆ FBDestroyTool()

◆ FBDestroyToolByName()

◆ FBGetToolPosition()

◆ FBGetToolPositionByName()

◆ FBGetToolSize()

◆ FBGetToolSizeByName()

◆ FBPopNormalTool()

◆ FBSetToolPosition()

◆ FBSetToolPositionByName()

◆ FBSetToolSize()

◆ FBSetToolSizeByName()

◆ FBShowTool()

◆ FBShowToolByName()