FBTool Class Reference

#include <fbtool.h>

FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool FBTool

Inheritance diagram for FBTool:

[legend]

List of all members.

---

Detailed Description

Tool class.

Definition at line 102 of file 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.
virtual bool	FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.
virtual bool	FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.
Public Attributes
FBPropertyInt	StartSize [2]
	Starting Size. This is the initial size when the tool is opened. (0:Width, 1:Height. Default = 800x400).
FBPropertyInt	MaxSize [2]
	Maximum Size (Disabled in this version). A value of -1 means no maximum size. (0:Width, 1:Height. Default = -1x-1).
FBPropertyInt	MinSize [2]
	Minimum Size. A value of -1 means no minimum value. (0:Width, 1:Height. Default = 140x-1).
FBPropertyInt	StartPos [2]
	Starting Position. This is the initial position when the tool is opened. (0:X, 1:Y. Default for first tool = 450x450).
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]

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.

---

Member Data Documentation

FBPropertyInt StartSize[2]

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

Definition at line 131 of file fbtool.h.

FBPropertyInt MaxSize[2]

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

Definition at line 132 of file fbtool.h.

FBPropertyInt MinSize[2]

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

Definition at line 133 of file fbtool.h.

FBPropertyInt StartPos[2]

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

Definition at line 134 of file fbtool.h.

FBPropertyString Name

Read Write Property: Unique name of object.

Reimplemented from FBComponent.

Definition at line 135 of file fbtool.h.

---

Please send us your comments about this page.