SDK Change Notes for Cinema 4D 2023.1

Table of Contents

• Overview
  • Major Changes
  • Minor Changes
• API Changes
  • asset.framework
  • cinema.framework
  • cinema_hybrid.framework
  • core.framework
  • corenodes.framework
  • exchange.framework
  • image.framework
  • misc.framework
  • neutron.framework
  • nodes.framework
  • python.framework
  • volume.framework

Summarizes the API and API documentation changes made between Cinema 4D versions 2023.0.0 and 2023.1.0.

Overview

For an an overview of the required development environment for this release on Windows, MacOS, or Linux, see Development Environments.

Major Changes

Updated	The OpenColorIO (OCIO) API exposure has been finalized. Not yet included is the ability to access the raw OCIO profiles associated with a BaseDocument instance. This feature will be added with 2023.2.0.
Added	Added Color Management Manual : Convert color data between color spaces and color formats provided by the maxon API or loaded from disk.
Added	Added OpenColorIO Manual : Convert colors with the color profiles provided by the OpenColorIO (OCIO) configuration of a scene.
Added	Added the examples.image example to the Extended SDK on GitHub.

Minor Changes

Updated	The manner in which assets are being referenced in the maxon::URLSCHEME_ASSET scheme has changed. The older referencing scheme is still functional for referencing assets but the new scheme improves error messages for non-resolving asset URLs. See maxon::URLSCHEME_ASSET for details.
Updated	Updated the maxon::UrlScheme documentation for the maxon::UrlInterface type. Missing schemes will be added with 2023.2 to url.h .
Updated	Updated the BaseShader Manual in the Access and Structure section to clarify the structure of nested shaders.
Updated	Updated the Development for macOS manual to more precisely define the steps required for building under more recent versions of macOS and Xcode.

API Changes

Summarizes the technical changes made to the public APIs of Cinema 4D within the scope of these change notes.

asset.framework

Added

asset_command.h

asset_command.h

Added:

New file for CommandAssetInterface and its metadata attributes.

Added

maxon::KeywordAssetInterface

asset_keyword.h

Added:

static MAXON_METHOD Result<LiteralId> HasKeyword(const AssetDescription& target, const Id& keywordId);

cinema.framework

Added

customgui_listview.h

customgui_filename.h

Added:

#define FILENAME_HELPSTRING 10006 
#define TREEVIEW_NO_ENTER_FORWARD 'noef'

Added

MaterialPreviewData

customgui_matpreview.h

Added:

static void CopyLinearWorkflow(const BaseDocument *src, BaseDocument *previewDocument);

Added

DescriptionImExportVerifyFilename

lib_description.h

Added:

struct DescriptionImExportVerifyFilename : public DescriptionBaseMessage

Added

SceneColorConverter

lib_scene_color_converter.h

Added:

enum class CONVERSION_FLAGS

Added

BaseOverride

lib_takesystem.h

Added:

maxon::Result<GeData> GetOverrideParam(const DescID& pIdx) const;
maxon::Result<void> SetOverrideParam(const DescID& pIdx, const GeData& d);

Added

osymmetrygenerator.h

osymmetrygenerator.h

Added:

New file for symmetry generator object.

Added

ovolumesequence.h

ovolumesequence.h

Added:

ID_VOLUMESEQUENCE_FIXEDCACHE = 6013

Added

thairsplinedynamics.h

thairsplinedynamics.h

Added:

HAIR_SDYNAMICS_PBD_FORCES_INEX_PYRO = 20036

Added

thairsplinedynamics.h

thairsplinedynamics.h

Added:

MDATA_CLOSEHOLE_POLYTYPE_PATCH = 4
MDATA_CLOSEHOLE_POLYTYPE_BASIC = 5
MDATA_CLOSEHOLE_ROTATION_OFFSET = 1111 //LONG
MDATA_CLOSEHOLE_WIDTH_OFFSET = 1112 // LONG
MDATA_CLOSEHOLE_BASIC_POLYTYPE = 1113 // LONG CYCLE
MDATA_CLOSEHOLE_CLOSEALLBTN = 1114 //BUTTON
MDATA_CLOSEHOLE_CLOSEALLHOLES = 1115 //BOOL

Added

toolflatten.h

toolflatten.h

Added:

MDATA_FLATTEN_USEAXISPOSITION = 1107

Added

tpbdconstraint.h

tpbdconstraint.h

Added:

PBD_CONSTRAINT_TAG_TEAR_MODE = 5017
PBD_CONSTRAINT_TAG_TEAR_MODE_RELATIVE = 0
PBD_CONSTRAINT_TAG_TEAR_MODE_ABSOLUTE = 1
PBD_CONSTRAINT_TAG_TEAR_ABSOLUTE_DISTANCE = 5018

Added

tpyro.h

tpyro.h

Added:

PYRO_TAG_SUBSTEPS = 1022
PYRO_TAG_SUBSTEP_MODE = 1023
PYRO_TAG_SUBSTEP_MODE_DISCRETE = 0
PYRO_TAG_SUBSTEP_MODE_CONTINUOUS = 1
PYRO_TAG_EMITTER_ENABLED = 1024
PYRO_TAG_SURFACE_WEIGHTS_DENSITY = 1025
PYRO_TAG_FUEL_TYPE = 1026
PYRO_TAG_FUEL_TYPE_ONESHOT = 0
PYRO_TAG_FUEL_TYPE_CONTINGENT = 1
PYRO_TAG_FUEL_TYPE_CONTINUOUS = 2
PYRO_TAG_FUEL_BURNING_RATE = 1027
PYRO_TAG_FUEL_TARGET_FRAME = 1028
PYRO_TAG_FUEL_INITIAL_CONTINGENT = 1029
PYRO_TAG_SURFACE_WEIGHTS_FUEL = 1030
PYRO_TAG_SURFACE_WEIGHTS_TEMPERATURE = 1031
PYRO_TAG_FUEL_GROUP = 1032
PYRO_TAG_TEMPERATURE_GROUP = 1033
PYRO_TAG_DENSITY_GROUP = 1034
PYRO_TAG_VELOCITY_GROUP = 1035
PYRO_TAG_DENSITY_MIN = 1036
PYRO_TAG_FUEL_MATCH_BURNING_RATE = 1037
PYRO_TAG_DENSITY_ENABLED = 1038
PYRO_TAG_FUEL_TARGET_FRAME_END = 1039
PYRO_TAG_FUEL_CONSTANT_PRESSURE = 1040

Added

trigidbody.h

trigidbody.h

Added:

New file

Added

xslavertexmap.h

xslavertexmap.h

Added:

SLA_DIRTY_VMAP_TAG_NAME = 1004

Added

BaseDocument

c4d_basedocument.h

Added:

const maxon::BaseArray<maxon::CString>& GetOcioColorSpaceNames();
const maxon::BaseArray<maxon::CString>& GetOcioRenderingColorSpaceNames();
const maxon::BaseArray<maxon::CString>& GetOcioViewTransformNames();
const maxon::BaseArray<maxon::CString>& GetOcioDisplayColorSpaceNames();
void UpdateOcioColorSpaces();

Added

c4d_baselist.h

c4d_baselist.h

Added:

#define MSG_DESCRIPTION_IMPEXPORT_VERIFY_FILENAME

Added

NodeMaterial

c4d_basematerial.h

Added:

maxon::Result<void> CreateDefaultGraph(const maxon::Id& spaceId)
maxon::Result<void> CreateEmptyGraph(const maxon::Id& spaceId)

Added

BaseObject

c4d_baseobject.h

Added:

void GetDimension(Vector& mp, Vector& rad)

Added

c4d_baseplugin.h

c4d_baseplugin.h

Added:

#define PLUGINFLAG_INTERNAL (1 << 20)

Added

BaseSelect

c4d_baseselect.h

Added:

Bool IsEqual(const BaseSelect &other) const

Added

c4d_basetag.h

c4d_basetag.h

Added:

#define TAG_VARIABLEFIELD (1 << 9)

Added

VariableTag

c4d_basetag.h

Added:

maxon::UniqueHash GetDataHash(void) const;

Added

NBIT

ge_prepass.h

Added:

FORBID_COLOR_CONVERSION = 97
TAG_ADDEDTOCACHE = 98

Added

ge_prepass.h

ge_prepass.h

Added:

#define Osymmetrygenerator 1060011
#define Opyro 1059580
#define Tgeneric 431000047
#define Tpyro 1059387
#define WPREF_MATMANAGER_DEFAULT_MATERIAL_AUTO 1059942

Added

VECTORGRIDTYPE

ge_prepass.h

Added:

New enumeration that describes vector volume types.

Updated

SceneColorConverter

lib_scene_color_converter.h

Old:

maxon::Result<void> Init(BaseDocument* doc, const maxon::CString& inputColorSpaceLowName, const maxon::CString& inputColorSpaceHighName, const maxon::CString& renderColorSpaceName);

New:

maxon::Result<void> Init(BaseDocument* doc, const maxon::CString& inputColorSpaceLowName, const maxon::CString& inputColorSpaceHighName, const maxon::CString& renderColorSpaceName, CONVERSION_FLAGS flags = CONVERSION_FLAGS::ADD_UNDO);

Updated

BaseSelect

c4d_baseselect.h

Old:

Bool CopyTo(BaseSelect* dest) const;

New:

Bool CopyTo(BaseSelect* dest, Bool alwaysDirty = true) const;

Updated

NBIT

ge_prepass.h

Old:

MAX = 97

New:

MAX = 98

Updated

operatingsystem.h

operatingsystem.h

Old:

#define API_VERSION 2023000

New:

#define API_VERSION 2023100

cinema_hybrid.framework

Added

maxon::CreateMaterialWithDataDelegate

createdefaultmaterialdelegate.h

Added:

using CreateMaterialWithDataDelegate = Delegate<::BaseMaterial*(::BaseDocument*, const Data& textureUrlOrColor)>;

Added

maxon::RendererDefaultMaterialInterface

createdefaultmaterialdelegate.h

Added:

class RendererDefaultMaterialInterface

core.framework

Added

maxon::CStringCompare

compare.h

Added:

static MAXON_ATTRIBUTE_FORCE_INLINE Bool LessThan(const Char* a, const Char* b)

Added

compilerdetection.h

compilerdetection.h

Added:

#define MAXON_OFFSETOF_NON_STANDARD_LAYOUT(T, M)

Added

maxon::FId

fid.h

Added:

static const DataType& GetType()

Added

maxon::details::DirectInstance

interfacebase.h

Added:

template <typename T, Bool HAS_ERROR> struct AddResultHelper
template <typename T> struct AddResultHelper<T, true>
template <typename T> struct AddResultHelper<ResultOk<T>, true>
template <typename T> struct AddResultHelper<Result<T>, true>
template <> struct AddResultHelper<ResultMemT<Bool>, true>
template <typename T> struct AddResultHelper<ResultMemT<T*>, true>
template <typename T> struct AddResultHelper<ResultRef<T>, true>
template <typename T, Bool HAS_ERROR> using AddResult = typename maxon::details::AddResultHelper<T, HAS_ERROR>::type;

Added

maxon::ParallelFor::DynamicContext

parallelfordynamic.h

Added:

Bool ReserveInitialChunk(const Int chunkSize, INDEXTYPE& i, INDEXTYPE& toChunk)

Updated

apibase.h

apibase.h

Old:

#define MAXON_CORE_FRAMEWORK_VERSION 2022901

New:

#define MAXON_CORE_FRAMEWORK_VERSION 2023100

Updated

arrayallocator.h

arrayallocator.h

Old:

blockarryallocator.h

New:

arrayallocator.h (The names of entities inside the file remained the same).

Updated

maxon::ParallelFor::DynamicContext

parallelfordynamic.h

Old:

template <typename LOOP> UInt LocalLoop(DynamicContext<USERCONTEXT, INDEXTYPE>& localContext, const Int chunkSize, const LOOP& obj)

New:

template <typename LOOP> UInt LocalLoop(DynamicContext<USERCONTEXT, INDEXTYPE>& localContext, Int chunkSize, INDEXTYPE i, INDEXTYPE toChunk, const LOOP& obj)

Updated

maxon::ThreadLocalPointer

threadlocalpointer.h

Old:

class ThreadLocalPointer

New:

template <typename P> class ThreadLocalPointer

Updated

maxon::ThreadLocalPointer

threadlocalpointer.h

Old:

class ThreadLocalDestructiblePointer

New:

template <typename P> class ThreadLocalDestructiblePointer

Updated

maxon::ThreadLocalPointer

threadlocalpointer.h

Old:

class ThreadLocalDestructiblePointer

New:

template <typename P> class ThreadLocalDestructiblePointer

Removed

interfacebase.h

interfacebase.h

Removed:

#define MAXON_REFERENCE_UNIQUE(FREEIMPL)
#define PRIVATE_MAXON_REFERENCE_UNIQUE_FLAGS
#define PRIVATE_MAXON_REFERENCE_UNIQUE_COPY(Name)

Removed

maxon::SqrMat3

matrix.h

Removed:

static MAXON_ATTRIBUTE_FORCE_INLINE constexpr const SqrMat3& NullValue()

Removed

maxon::Mat3

matrix.h

Removed:

static MAXON_ATTRIBUTE_FORCE_INLINE constexpr const Mat3& NullValue()

Removed

matrix.h

matrix.h

Removed:

template <typename T> struct IsZeroInitialized<SqrMat3<T>> : public IsZeroInitialized<T> { };
template <typename T> struct IsZeroInitialized<Mat3<T>> : public IsZeroInitialized<T> { };

Removed

maxon::SqrMat2

matrix2d.h

Removed:

static MAXON_ATTRIBUTE_FORCE_INLINE constexpr const SqrMat2& NullValue()

Removed

maxon::Mat2

matrix2d.h

Removed:

static MAXON_ATTRIBUTE_FORCE_INLINE constexpr const Mat2& NullValue()

Removed

matrix2d.h

matrix2d.h

Removed:

template <typename T> struct IsZeroInitialized<SqrMat2<T>> : public IsZeroInitialized<T> { };
template <typename T> struct IsZeroInitialized<Mat2<T>> : public IsZeroInitialized<T> { };

Removed

maxon::SqrMat4

matrix4d.h

Removed:

static MAXON_ATTRIBUTE_FORCE_INLINE constexpr const SqrMat4& NullValue()

Removed

matrix4d.h

matrix4d.h

Removed:

template <typename T> struct IsZeroInitialized<SqrMat4<T>> : public IsZeroInitialized<T> { };

corenodes.framework

Added

maxon::corenodes::CoreNodeErrorHelper

corenodes_errors.h

Added:

class CoreNodeErrorHelper

Added

maxon::corenodes::PortId

corenodes_helpers.h

Added:

MAXON_OPERATOR_EQUALITY(PortId, _indexDir, _name);

Removed

maxon::corenodes::FrameData

micronodes_runtime.h

Removed:

FrameData* GetParent()

exchange.framework

Added

maxon::MATERIAL::PORTBUNDLE::REDSHIFT

datadescription_material_redshift.h

Added:

This is the subsurface color.
   MAXON_ATTRIBUTE(Color, SUBSURFACE_COLOR, "subsurface_color");
This scales the overall subsurface effect (0.0 - 1.0).
   MAXON_ATTRIBUTE(Float, SUBSURFACE_WEIGHT, "subsurface_weight");
This can be used to control the average distance that light can travel below the surface before it is reduced by scattering such that it can no longer have a visible effect.
   MAXON_ATTRIBUTE(Color, SUBSURFACE_RADIUS, "subsurface_radius");
This value is multiplied by the RGB components of the radius to determine the distance the light can travel below the surface before it is fully scattered.
   MAXON_ATTRIBUTE(Float, SUBSURFACE_SCALE, "subsurface_scale");
This value can be used to influence the direction in which the light is scattered below the surface.
   MAXON_ATTRIBUTE(Float, SUBSURFACE_ANISOTROPY, "subsurface_anisotropy");
   MAXON_ATTRIBUTE(Group, SUBSURFACE, "subsurface");

image.framework

Added

maxon::ImageUrlCacheInterface

imageurlcache.h

Added:

MAXON_METHOD Result<Opt<ImageBaseRef>> GetImage(UpdateCacheDelegate&& updateDelegate, Bool async) const;

misc.framework

Added

maxon::FormulaParserInterface

formulaparser.h

Added:

MAXON_METHOD Result<void> AddDummyFloatVariable(const String& name, Bool caseSensitive);
MAXON_METHOD Result<void> AddDummyIntVariable(const String& name, Bool caseSensitive);
MAXON_METHOD Result<void> AddDummyStringVariable(const String& name, Bool caseSensitive);
MAXON_METHOD Result<void> AddDummyDataVariable(const String& name, Bool caseSensitive);
MAXON_METHOD Result<void> CalculateFloat(const FormulaParserCacheRef& cache, const VariableDictionary& varOverrides, Float32& result);
MAXON_METHOD Result<void> CalculateFloat(const FormulaParserCacheRef& cache, const VariableDictionary& varOverrides, Float64& result);
MAXON_METHOD Result<void> CalculateInt(const FormulaParserCacheRef& cache, const VariableDictionary& varOverrides, Int64& result);

Added

maxon::GmlWriterInterface

gmlwriter.h

Added:

MAXON_METHOD Result<void> Add2(const GmlNode& node, const Delegate<Tuple<Int32, String>(const GmlNode&)>& idDelegate);

Added

maxon::GetUrlFromIconProviders

iconprovider.h

Added:

inline Result<Url> GetUrlFromIconProviders(const CString& iconId)

Added

maxon::UnitTestErrorInterface

unittest.h

Added:

#define CheckUnitTestState(condition, ...)

neutron.framework

Added

maxon::NEUTRON::GEOMETRY::POINTS

nodes_modeling.h

Added:

namespace NEARESTNEIGHBOR
{
    MAXON_RESOURCE_DATABASE_SCOPE("net.maxon.neutron.geometry.points.nearestneighbor");
    MAXON_ATTRIBUTE(Array<Vector>, TARGETPOINTSIN, "targetpointsin");
    MAXON_ATTRIBUTE(IndexSelection, SELECTION, "selection");
    MAXON_ATTRIBUTE(String, SELECTIONSTRING, "selectionstring");
    MAXON_ATTRIBUTE(Vector, QUERYPOSITION, "queryposition");
    MAXON_ATTRIBUTE(Float, MAXDISTANCE, "maxdistance");
    MAXON_ATTRIBUTE(Int, MAXNEIGHBORCOUNT, "maxneighborcount");
    MAXON_ATTRIBUTE(Array<Int>, TARGETIDXNEAREST, "targetidxnearest");
}

Added

maxon::NEUTRON::MODELING::COMMAND::BASE

nodes_modeling.h

Added:

MAXON_ATTRIBUTE(void, GEOMETRYOUT, "geometryout");

Added

maxon::NEUTRON::MODELING::COMMAND::COMMANDMODE

nodes_modeling.h

Added:

MAXON_ATTRIBUTE(void, MODE_ENUM_POLYGONS, "polygons");

Updated

neutron_ids.h

neutron_ids.h

Old:

static constexpr Int32 MSG_GET_INSTRUMENTATION_MANAGER = 180420113;

New:

static constexpr Int32 MSG_GET_INSTRUMENTATION_HANDLER = 180420113;

Updated

neutron_ids.h

neutron_ids.h

Old:

static constexpr Int32 MSG_REGISTER_INSPECTOR = 180420205;

New:

static constexpr Int32 MSG_REGISTER_PORT_VALUE_LISTENER = 180420205;

nodes.framework

Added

maxon::PATTERN::NODE::CONVERSION::OCIO

nodes_color.h

Added:

MAXON_ATTRIBUTE(ColorA, COLOR, "color");
MAXON_ATTRIBUTE(CString, INPROFILE, "inprofile");
MAXON_ATTRIBUTE(CString, OUTPROFILE, "outprofile");
MAXON_ATTRIBUTE(ColorA, RESULT, "result");

Added

maxon::NODE::META::STATICASSERT

nodes_meta.h

Added:

MAXON_ATTRIBUTE(DataType, DATATYPEIN, "datatypein");
MAXON_ATTRIBUTE(void, VAR1IN, "var1in");
MAXON_ATTRIBUTE(String, CONDITIONIN, "conditionin");message
MAXON_ATTRIBUTE(String, MESSAGEFORMATIN, "messageformatin");
MAXON_ATTRIBUTE(Bool, RESULTOUT, "resultout");
MAXON_ATTRIBUTE(Bool, CONSTANTOUT, "constantout");
MAXON_ATTRIBUTE(String, ERRORMSGOUT, "errormsgout");

Added

nodes_script.h

nodes_script.h

Added:

New file containing the attributes for the formula node.

Added

maxon::NODE::CONTAINERITERATION

nodes_structure.h

Added:

MAXON_ATTRIBUTE(Int, COUNT, "count");
MAXON_ATTRIBUTE(Int, INDEX, "index");

Added

maxon::nodes::NodesLib

nodeslib.h

Added:

static MAXON_METHOD Result<Id> MakePortUuid(const Char* prefix);
static MAXON_METHOD Result<Id> MakePortUuid(PORT_DIR dir);

Added

maxon::nodes::TemplateArguments

nodetemplate.h

Added:

template <typename T> Result<void> SetNoKindArgument(const InternedId& id, T&& value)

python.framework

Added

maxon::py::CPythonLibraryInterface

cpython.h

Added:

MAXON_METHOD Int32* CPy_UTF8Mode();
MAXON_METHOD Int32* CPy_QuietFlag();
MAXON_METHOD Int32* CPy_UnbufferedStdioFlag();
MAXON_METHOD Int32* CPy_IsolatedFlag();

Added

maxon::py::PYTHONFLAG

cpython.h

Added:

UTF8MODE = 1 << 1,
QUIET = 1 << 4,
OPTIMIZE_LEVEL1 = 1 << 7,
OPTIMIZE_LEVEL2 = 1 << 8,
UNBUFFEREDSTDIO = 1 << 15,
HASHRANDOMSEED = 1 << 16, // Can't be used ATM since Cinema 4D only retrieve flags and not integer value
ISOLATED = 1 << 17,
LEGACYWINDOWSFSENCODING = 1 << 18,
LEGACYWINDOWSSTDIO = 1 << 19,

volume.framework

Added

maxon::VolumeInterface

volume.h

Added:

MAXON_METHOD Result<void> SetVecType(VECTORGRIDTYPE gridType);
MAXON_METHOD VECTORGRIDTYPE GetVecType() const;

Added

maxon::VolumeToolsInterface

volumetools.h

Added:

static MAXON_METHOD Result<Array<Vector>> ScatterPointsInFog(const Volume& volume, UInt64 pointCount, Float spread);