Python in Cinema 4D

Introduction

A separate Python installation is not needed. Python is integrated into Cinema 4D and runs out of the box.

Python can be found in different parts of the Cinema 4D eco-system.

It can be used to extend, automate or improve workflow by creating custom scripts or plugins.

Being all the functions of the “c4d” module calling their C++ equivalent, executing a Python code, invoking only Cinema 4D SDK functions, takes almost the same time of the equivalent C++ code.

A python interpreter called c4dpy is available to execute python code with the Cinema 4D API outside of Cinema 4D.

Moreover c4dpy bring extra features such as Autocompletion or Debugging for Python Script (Plugin are not supported). See the c4dpy manual.

Version

The Cinema 4D Python interpreter versions are:

• Windows: Python version 2.7.14 (default, May 3 2018, 18:05:57) Build with MSC v.1500 64 bit (AMD64) (Microsoft Visual Studio 2008)

• Mac OS: Python version 2.7.14 (default, May 5 2018, 00:43:48) Build with GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.37)

General

There are general places where Python can be found within the Cinema 4D eco-system:

• c4dpy. A custom python interpreter which supports Cinema 4D modules.

• Python_init.py. An optional python file called before plugin registration.

• Python Libraries. Information about 3rd party libraries / modules.

• Python Console. The Python Console / interpreter within Cinema 4D.

• Python Script Manager. The Script manager to edit and run scripts within Cinema 4D.

Embedded

Python is embedded in various places of Cinema 4D, such as:

• Python Scripting Tag.

• Python Xpresso Node.

• Python Interaction Tag.

• Python Visual Selector Tag.

• Python Character Tag.

• Python Generator.

• Python Effector.

• Python Field Object / Layer.

• Python Sketch and Toon Material.

Note

Use of Python in these situations is context-specific, which means some functions/methods are not possible to be called (e.g. insert new object in a document from a Python Tag). See Threading Information.

Plugins

In addition Python in Cinema 4D can be used to creates the following plugins in order to extend and create new Cinema 4D component:

• PluginMessage catches some specific Cinema 4D event like (e.g. start of Cinema 4D, end of Cinema 4D, etc…).

• BitmapLoaderData creates a bitmap importer (e.g. Py-Xample).

• BitmapSaverData creates a bitmap exporter (e.g. Py-Xample).

• CommandData creates a command (e.g. Py-TextureBaker).

• FalloffData creates a Falloff. Falloff are no more exposed in R20+. (e.g. Py-NoiseFalloff).

• MessageData catches some CoreMessage or creates a global timer (e.g. c4d.plugins.MessageData).

• ToolData creates a tool (e.g. Py-LiquidPainter).

• SculptBrushToolData creates a brush (not only limited to sculpting) (e.g. all examples prefixed with py-sculpt such as Py-Sculpt Grab Brush).

• NodeData creates a BaseList2D object.

  • TagData creates a tag (e.g. Py-LookAtCamera).

  • ObjectData creates an object. It can be:

    • A generator delivering a c4d.PolygonObject (e.g. Py-RoundedTube).

    • A generator delivering a c4d.SplineObject (e.g. Py-DoubleCircle).

    • A polygon modifier (e.g. Py-SpherifyModifier).

    • A particle modifier (e.g. Py-Gravitation).

  • ShaderData creates a shader (e.g. Py-Fresnel).

  • SceneLoaderData creates a scene importer.

  • SceneSaverData creates a scene exporter (e.g. Py-IESMeta).

  • PreferenceData creates global preferences (e.g. Py-Preference).