Python in Cinema 4D¶
Introduction¶
c4dpy
is available to execute python code with the Cinema 4D API outside of Cinema 4D.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 3.9.1+ (pipelines/8936:778d593, Jan 25 2021, 20:35:13) [MSC v.1900 64 bit (AMD64)]
Mac OS: Python version 3.9.1+ (pipelines/8936:778d593, Jan 25 2021, 20:35:13) [Clang 12.0.0 (clang-1200.0.32.29)]
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 Libraries. Learn how to expose third party Python libraries to the Python environments of Cinema 4D.
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:
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).