MAXON API Frameworks

About

A framework includes the public declarations of MAXON API ALIASES interfaces and other usable classes, structures and functions.

Note
The frameworks delivered with the SDK do not contain any project files. Projects files must be created using the Project Tool.

Frameworks

cinema.framework

Contains the classic API. It defines components like BaseDocument, BaseObject, BaseMaterial etc.

Warning
This framework will be progressively reduced in future versions of Cinema 4D and, at the end, completely dismissed. See Plugin Migration.

cinema_hybrid.framework

Contains API elements that are tied both to the classic and maxon API.

Warning
This framework will be progressively reduced in future versions of Cinema 4D and, at the end, completely dismissed. See Plugin Migration.

core.framework

Contains the basic building blocks of the MAXON API ALIASES:

animation.framework

Defines the maxon::AutoWeightInterface for custom weight algorithms. It further provides the IDs of the build-in algorithms that can be used with the Weight Manager. See CAWeightMgr Manual.

asset.framework

Provides interfaces for accessing and storing content as assets in asset databases.

command.framework

Defines the interface for generic commands. See Commands Manual.

corenodes.framework

Provides interfaces to create custom core nodes used with Cinema 4D's node system.

crypt.framework

Provides additional interfaces for data encryption based on stream conversions.

exchange.framework

Provides interfaces to define custom behaviors for import and export operations on node materials.

This is not limited to file operations (e.g. *.fbx), as a NodeSystem with a valid StandardSurface definition will use that definition in the viewport.

geom.framework

Provides interfaces for common geometry operations.

graph.framework

Provides a unified model for arbitrary graph-like structures.

image.framework

Provides classes and structures to handle image and media data:

math.framework

Provides interfaces for commonly required mathematical concepts.

mesh_misc.framework

Provides the base interfaces for mesh attributes:

misc.framework

Provides auxiliary interfaces that can be used in conjunction with other frameworks.

network.framework

Provides interfaces to handle network communication:

neutron.framework

Provides MAXON_ATTRIBUTE constants for scene nodes.

nodes.framework

Provides interfaces to handle and modify node systems.

The Nodes API implements the Model-View-Controller pattern. The interfaces in this framework provide means to modify the model, the data, of a node system and generate views, forms in which this data is presented to a user, on them. The framework is independent from the core nodes framework.

Interfaces that can be implemented are:

nodespace.framework

Defines a container for a node system for a specific purpose.

A custom node space is implemented with:

python.framework

Provides interfaces to execute Python code. See Python.

render_filter.framework

Provides interfaces to use and implement render filters like the denoiser filter.

See Render Filter and Render Filter Implementation.

system.framework

Provides internal system functions. Third party developers must not use this.

volume.framework

Provides interfaces to handle volume data.

Further Reading