c4d_commanddata.h File Reference

Classes

struct  RestoreLayoutSecret
 
struct  CommandInformationData
 
class  CommandData
 

Macros

#define PLUGINFLAG_COMMAND_HOTKEY
 
#define PLUGINFLAG_COMMAND_OPTION_DIALOG
 
#define PLUGINFLAG_COMMAND_STICKY
 
#define PLUGINFLAG_COMMAND_ICONGADGET
 
#define MSG_COMMANDINFORMATION
 
#define MSG_BODYPAINTEXCHANGE
 
#define TOOLHOTKEY_RECEIVER
 

Functions

Bool RegisterCommandPlugin (Int32 id, const maxon::String &str, Int32 info, BaseBitmap *icon, const maxon::String &help, CommandData *dat)
 
Bool RegisterManagerInformation (Int32 id, const maxon::String &str, Int32 info)
 

Macro Definition Documentation

◆ TOOLHOTKEY_RECEIVER

#define TOOLHOTKEY_RECEIVER

Special tool hotkey overwrite for command plugins.

Function Documentation

◆ RegisterCommandPlugin()

Bool RegisterCommandPlugin ( Int32  id,
const maxon::String str,
Int32  info,
BaseBitmap icon,
const maxon::String help,
CommandData dat 
)

Registers a command plugin.

Parameters
[in]idA unique plugin ID. Must be obtained from http://www.plugincafe.com
[in]strThe name of the plugin.
To affect the order that plugins are displayed in menus add "#$n" as a prefix to this name, where n is a number.
Lower numbers are displayed before higher numbers. If name is "--" it will show up as a menu separator.
[in]infoThe command plugin info flags: PLUGINFLAG_COMMAND PLUGINFLAG
[in]iconThe icon for the command. The bitmap is copied.
The icon should be of size 32x32, but will be scaled if needed.
It must also be 24 bits and should if possible include an alpha to support pattern backgrounds.
[in]helpThe tool tips and status bar help text for the command.
When using strings it is advised to use the resources string (.str) files and the GeLoadString() function.
This keeps the plugin easy to localize for any language to support and makes full use of the language features of Cinema 4D.
[in]datThe command data instance for the plugin. Cinema 4D takes over the ownership of the pointed command data.
Returns
true if the command plugin was registered, otherwise false.

◆ RegisterManagerInformation()

Bool RegisterManagerInformation ( Int32  id,
const maxon::String str,
Int32  info 
)

Registers manager information for use when registering shortcuts with AddShortcut().

Parameters
[in]idA unique plugin ID. Must be obtained from http://www.plugincafe.com
[in]strThe manager name.
[in]infoThe manager info flags: PLUGINFLAG
Returns
true if the manager was registered, otherwise false.