Plugin Types

Table of Contents

• About
• Data and Algorithms
  • Custom Data Types
  • Custom Algorithms and Commands
• Application
  • GUI & User Interaction
  • Media Import/Export
  • Miscellaneous
• 3D
  • BaseDocument related
  • Tools
  • Scene Import/Export
  • Rendering
  • Character animation
• Modules
  • XPRESSO
  • MoGraph
  • Sculpting
• Further Reading

About

The following plugin classes can be implemented to add new functionality to Cinema 4D. Such plugins are either based on NodeData, other Cinema API plugin hooks or Maxon API interfaces.

See also Interface Basics, Common Plugin Concepts and NodeData Overview.

Data and Algorithms

Custom Data Types

Custom data types can be used to store information in Cinema 4D objects or scenes.

• CustomDataTypeClass, ResourceDataTypeClass: A custom data type that can be used in containers and descriptions.
• NodeData: A custom node. See NodeData Overview
• MAXON_DATATYPE: A new Maxon API data type. See MAXON Data Type.

Custom Algorithms and Commands

Custom algorithms and commands can be implemented with these interfaces:

• maxon::StreamConversionInterface: A custom data conversion algorithm (compression, encryption, etc.). See Stream Conversions Manual.
• maxon::BlendFunctionInterface: A custom blend function. See BlendFunctionInterface Manual.
• maxon::CommandClassInterface: A implementation of a standardized commands. See Commands Manual.

Application

GUI & User Interaction

The GUI can be extended with these plugin types:

• CommandData: A custom commands that appears in the GUI. See Command Utility Manual.
• GeDialog: A custom dialog window. Such a dialog instance must be stored in a CommandData plugin. See GeDialog Manual.
• GeUserArea: A custom GUI element to be used in a GeDialog. See GeUserArea Manual.
• CustomGuiData: A custom GUI element that can be used in dialogs and descriptions.
• MessageData: A hook to receive GUI messages. See Core Messages Manual.

Media Import/Export

Support for custom media files is implemented with:

• BitmapSaverData / BitmapLoaderData: A hook to import/export custom image formats. Deprecated.
• maxon::MediaInputInterface: A custom media loader. See Media Sessions Manual.
• maxon::MediaSessionFileFormatHandlerInterface: A custom media input from a file. See FileFormatHandler Manual.
• maxon::MediaOutputUrlInterface: A custom media output to a file. See Media Sessions Manual.
• maxon::FileFormatInterface: A custom file format.

Miscellaneous

Further extensions of the application are:

• PrefsDialogObject: A new preference category in the Cinema 4D Preferences dialog.

3D

BaseDocument related

A Cinema 4D 3D scene is composed of various scene elements. It is possible to create custom scene elements with:

• TagData: A custom tag. See BaseTag and VariableTag Manual.
• ObjectData: A custom object e.g. generator, deformer, spline and particle modifier. See BaseObject Manual.
• ShaderData: A custom shader. BaseShader Manual.
• MaterialData: A custom material. See BaseMaterial Manual.
• CTrackData: A custom animation track. See CTrack Manual.
• SceneHookData: A custom scene hook that is executed during various stages of the scene pipeline.
• FalloffData: A custom falloff. Deprecated. See MoGraph below.
• maxon::MeshAttributeClassInterface: A custom mesh attribute. See Mesh Attributes Interfaces.
• maxon::CustomDataTagClassInterface, maxon::CustomDataTagDisplayInterface: A custom CustomDataTag. See CustomDataTag Manual.
• maxon::BasicMicroNode: Base class for a custom core node. See Core Nodes Implementation.

Tools

Custom tools allow the user to interact with the 3D scene:

• ToolData: A custom editor tool.
• DescriptionToolData: A modeling tool.
• BrushToolData: A custom CA brush.
• SnapData: A custom snap mode.

Scene Import/Export

These plugins allow to load and save 3D scenes:

• SceneSaverData / SceneLoaderData: A custom importer/exporter for 3D formats.

Rendering

Rendering-related plugins are implemented with:

• VideoPostData: A plugin that is executed during rendering. This is used to implement custom render engines or post effects.
• maxon::FilterInterface, maxon::FilterContextInterface and maxon::FilterImageInterface are base interfaces for render filters like the denoiser.

Character animation

Character animation related plugins are implemented with:

• maxon::AutoWeightInterface: An interface that is the base for custom weighting algorithms used with the Weight Manager.

Modules

XPRESSO

XPRESSO can be extended with:

• GvOperatorData: A custom GraphView operator.

MoGraph

MoGraph can be extended with:

• EffectorData: A custom MoGraph effector.
• FieldLayerData: A custom field layer. See FieldLayerData Manual.
• FieldData: A custom field object. See FieldData Manual.

Sculpting

The sculpting system can be extended with:

• SculptBrushModifierData: A custom sculpt brush modifier.
• SculptBrushToolData: A custom sculpt brush.

Further Reading

• Development Overview
• Development Requirements
• Interface Basics
• Common Plugin Concepts
• NodeData Overview