Development for Linux

Requirements

Plugin development on Linux is supported only on Ubuntu 14.04 LTS and CentOS 7.0 The following components are required:

  • Cinema 4D R20 SDK : GCC 6.3.1 / glibc 2.17 / Python 2.7.9 or greater / SCons 2 or greater
  • Cinema 4D R19 SDK : GCC 4.8.3 / glibc 2.12 / Python 2.7.5 or greater / SCons 2 or greater

Environment

The web site http://www.vfxplatform.com describes a Linux runtime reference environment. As Cinema 4D links statically to almost all external libraries, there should be no real problem meeting this reference platform.

Plugin Suffix

The following suffixes are supposed to be used for compiled plugins:

  • Cinema 4D R20 SDK : .xso64
  • Cinema 4D R19 SDK : .so64

Best Practice

Linux Specific Code

Linux specific code can be guarded with the macro MAXON_TARGET_LINUX:

#ifdef MAXON_TARGET_LINUX
#endif

Building Plugins for R20

Building the SDK examples provided with Cinema 4D on Linux is done through the following steps:

  1. Unzip the sdk.zip file to a location of your choice (in the following the path $HOME/C4D_SDK/SDK_20 is used).
    $ cp sdk.zip ~/C4D_SDK
    $ cd ~/C4D_SDK && unzip -d SDK_20 ./sdk.zip
  2. Choose the appropriate project tool archive and install the project tool to a location of your choice. In the following a user's local "bin" folder is used.
    • For CentOS 7:
      $ mkdir ~/bin
      $ cp cinema4d_r20_project_tool_centos7.tar.xz ~/bin
      $ cd ~/bin && tar xJvf cinema4d_r20_project_tool_centos7.tar.xz
    • For Ubuntu 14.04:
      $ mkdir ~/bin
      $ cp cinema4d_r20_project_tool_ubu1404.tar.xz ~/bin
      $ cd ~/bin && tar xJvf cinema4d_r20_project_tool_ubu1404.tar.xz
  3. Run the Project Tool to create the project files for the SCons build system. This is done by running the project tool and pointing it to the location where the sdk archive in installed.
    $ cd ~/bin/sdk_project_tool
    $ export LD_LIBRARY_PATH=$PWD/lib64 && ./kernel_app_release64 g_updateproject=~/C4D_SDK/SDK_20
  4. Build the frameworks and the plugins contained.
    $ cd ~/src/maxon_plugin_dev
    $ cd plugins/project && python link_sconscript_plugins.py && cd ../..
    $ scons -f plugins/project/SConstruct.plugins

Building Plugins for R19

Building the SDK examples provided with Cinema 4D on Linux is done through the following steps:

  1. Create a base directory for development (in the following steps the path $HOME/C4D_SDK/SDK_19 is used).
    $ mkdir ~/C4D_SDK/SDK_19
  2. Copy the Cinema 4D frameworks and example files:
    $ cp -r /opt/maxon/cinema4d/<version>/bin/frameworks ~/C4D_SDK/SDK_19
    $ cp -r /opt/maxon/cinema4d/<version>/bin/plugins ~/C4D_SDK/SDK_19
  3. Create a symbolic link to the frameworks
    $ cd ~/C4D_SDK/SDK_19/plugins/cinema4dsdk
    $ ln -s ../../frameworks
  4. Create a symbolic link to the main build file:
    $ cd ~/C4D_SDK/SDK_19/plugins
    $ ln -s cinema4dsdk/SConstruct
  5. Start the build process
    $ scons

Compiler Remarks

The main project file "SConstruct.plugins" expects the GCC executable files to be in /usr/local/gcc/gcc/bin. Creating symbolic link to gcc and g++ is recommended rather than editing "SConstruct.plugins" To look for a specific gcc version residing in /usr/local/gcc/<gcc-version>/bin use:

$ scons -f plugins/project/SConstruct.plugins gcc_version=<gcc-version>

Running on Terminal

Cinema 4D for Linux is solely available as command-line render (c4d_clr) and is supposed to run in a terminal window without GUI. Assuming Cinema 4D is installed in /opt/maxon/cinema4d/<c4d-version>/, the command line is:

$ cd /opt/maxon/cinema4d/<c4d-version>/bin
$ . ./setup_c4d_env && ./Commandline <optional arguments>

Running Plugins

It is possible to start Cinema 4D to run and debug a plugin:

  • set the command line argument g_additionalModulePath to make sure that this Cinema 4D executable will find and load the plugin.

Additionally one can set the command line argument g_runUnitTests to automatically execute custom unit tests.

Debugging

The binary plugin build for debugging is created specifying config="debug64".

$ scons -f plugins/project/SConstruct.plugins config="debug64"

The Terminal window displays messages printed with DiagnosticOutput(). See Debug and Output Functions.

For general information on debugging see Debugging.