就业培训     下载中心     Wiki     联络 登录   注册

---

注意

One can check with GeGetVersionType() and GeGetCinemaInfo() the version of the host Cinema 4D application to make sure plugins are only loaded in a suitable environment.

Currently the return value of PluginStart() is not evaluated.

PluginMessage

PluginMessage() receives various messages during startup, shutdown and while Cinema 4D is running.

It is possible to send a custom message to PluginMessage() of all loaded plugins with:

• GePluginMessage() : Sends a plugin message to other plugins.

优先级

The PluginStart() and PluginEnd() functions of all plugins are called one after another. The plugin priority defines the order in which these functions are called. This is useful to make sure that a given plugin is called before or after a certain other plugin. For most plugins this is typically not needed.

• C4DMSG_PRIORITY is send to get the priority of the receiving plugin.

The priority is set using this macro:

• SetPluginPriority : Sets the priority for the plugin.

The priorities are:

• C4DPL_INIT_PRIORITY_XTENSIONS : Base priority for extensions.
• C4DPL_INIT_PRIORITY_OBJECTS : Base priority for objects.
• C4DPL_INIT_PRIORITY_MODELING : Base priority for modeling.
• C4DPL_INIT_PRIORITY_SHADER : Base priority for shader modules.
• C4DPL_INIT_PRIORITY_ADVANCEDRENDER : Base priority for the Advanced Render module.
• C4DPL_INIT_PRIORITY_MOCCA : Base priority for MOCCA.
• C4DPL_INIT_PRIORITY_NEWMAN : Base priority for Cinema 4D managers.
• C4DPL_INIT_PRIORITY_SLA : Base priority for SLA.
• C4DPL_INIT_PRIORITY_MODULES : Base priority for modules.
• C4DPL_INIT_PRIORITY_PLUGINS : Base priority for plugins.

注意

Higher priorities are initialized first.

C4DMSG_PRIORITY is not relevant for Python plugins.

初始化资源

If a plugin uses any resource files in its "res" folder, these resources have to be loaded when Cinema 4D starts. This is done using GeResource::Init() .

• C4DPL_INIT_SYS is sent to initialize the system.

As this is one of the earliest message, this is the best time to register custom data types and SNHook plugins. This message is not sent to Python plugins.

After the C4DPL_INIT_SYS 消息， PluginStart() will be called.

开始

During startup the following messages are sent:

• C4DPL_STARTACTIVITY is sent to all plugins after PluginStart() of all plugins was called. Here code can be executed that relies on all other plugins to be loaded.
• C4DPL_PROGRAM_STARTED is sent when the application has been started and is ready.

菜单布局

Before Cinema 4D finishes its start ( C4DPL_PROGRAM_STARTED ) it is possible to modify its menus to add new menu entries.

• C4DPL_BUILDMENU is sent when the menus are built during startup.

// create a custom menu entry BaseContainer menu; 菜单。 InsData ( MENURESOURCE_SUBTITLE , "Custom Menu" );

// adds the command to create a cube to the custom menu const String commandString = "PLUGIN_CMD_" + String::IntToString ( Ocube ); 菜单。 InsData ( MENURESOURCE_COMMAND , commandString);

// add new menu entry mainMenu-> InsData ( MENURESOURCE_SUBMENU , menu); return true ; break ; }

命令行自变量

警告

Command line arguments can be defined and accessed with MAXON API configuration variables. See Configuration Variables .

The command line arguments used to start Cinema 4D can be parsed after the application has started.

• C4DPL_COMMANDLINEARGS is sent to let plugins parse the command line arguments.

The data of the message is C4DPL_CommandLineArgs :

• C4DPL_CommandLineArgs::argc : Number of arguments in argv.
• C4DPL_CommandLineArgs::argv : Argument array.
• C4DPL_CommandLineArgs::argc_w : Number of arguments in argv_w (Unicode encoding, Windows only).
• C4DPL_CommandLineArgs::argv_w : Argument array (Unicode encoding, Windows only).
• C4DPL_CommandLineArgs::orig : The complete argument string.
• C4DPL_CommandLineArgs::orig_w : The complete Unicode argument string (Unicode encoding, Windows only).

// loop through all command line arguments for ( Int32 i = 0; i < args-> argc ; i++) { // check if argument is set if (!args-> argv [i]) continue ;

// check if this is the "custom" argument if (strcmp(args-> argv [i], "-custom" ) == 0) { // set to nullptr so it won't confuse other modules args-> argv [i] = nullptr ;

// get the argument that is the next command line element i++; const String argument = String (args-> argv [i]);

// print result ApplicationOutput ( "Argument: " + argument);

// set to nullptr so it won't confuse other modules args-> argv [i] = nullptr ; } } return true ; break ; }

设备改变

When a device is added to or removed from the machine, a plugin message is sent.

• C4DPL_DEVICECHANGE is sent when a device has changed.

The data of the message is C4DPL_DeviceChange :

• C4DPL_DeviceChange::name : The name of the device.
• C4DPL_DeviceChange::eject : True if the device was ejected, otherwise false.

// check if name is valid if (name->GetLength() > 0) { // check if the device was removed or added if (dc-> eject ) ApplicationOutput ( "Device " + *name + " was removed" ); else ApplicationOutput ( "Device " + *name + " was added" ); } return true ; break ; }

注意

This message is triggered twice per event.

Shutdown

The following messages are sent during Cinema 4D 's shutdown.

• C4DPL_ENDPROGRAM : Cinema 4D is about to close.
• C4DPL_ENDACTIVITY is sent before PluginEnd() of any plugin is called. This allows to free any resources and close threads. At this point, all classes and plugins still exist. For example dialogs, BaseContainers, threads and complex data types should be deleted here. Preferences should be stored and all processes be terminated.
• C4DPL_SHUTDOWNTHREADS : Sent to all plugins before the threading system of Cinema 4D is shut down. Afterwards no threads should be started.

PluginEnd

PluginEnd() is called before a plugin is unloaded and is the last opportunity to free resources. Here low level cleanup should be done e.g. for Strings and Filenames. Also imported DLLs should be unloaded here.

延伸阅读

• 一般插件功能概述
• 一般插件信息手册