Class ToolItem

Class ToolItem

See Also: Custom Controls, Class ToolImageItem.

class ToolItem

Description:

This class describes the properties of an item in a 3ds max custom toolbar.

Data Members:

public:

ToolItemType type;

See List of Tool Item Types.

int id

The ID for the control.

DWORD helpID

For plug-in developers this id should be set to 0. Basically, the main 3ds max help file contains help tags that are tied to various parts of the 3ds max UI, allowing the right help page to come up when UI help is requested. In particular, if you press the ? button on the toolbar, then press another toolbar button, you'll get help on that button's functionality. This is because internally pressing the button yields a help ID that indexes into the help file. But since the same help ID must be compiled into the help file and into MAX, and since the main 3ds max helpfile can not be rebuilt by developers, they cannot use this functionality.

int w

The width of the button image.

int h

The height of the button image.

int orient;

This data member is available in release 3.0 and later only.

The orientation of the item. One of the following values:

CTB_HORIZ

CTB_VERT

CTB_FLOAT

Methods:

Prototype:

virtual ~ToolItem()

Remarks:

Destructor.