MSG_MULTI

Detailed Description

Classes

struct  ModifyFilenameDataStruct
 

Macros

#define MSG_MULTI_RENDERNOTIFICATION
 
#define MSG_MULTI_MARKMATERIALS
 
#define MSG_MULTI_DOCUMENTCLONED
 
#define MSG_MULTI_DOCUMENTIMPORTED
 
#define MSG_MULTI_SETNEWMARKERS
 
#define MSG_MULTI_CLEARSUGGESTEDFOLDER
 
#define MSG_MULTI_SCRIPTINFO
 

Functions

maxon::Result< FilenameHandleModifyFilenameMessage (Int32 msgType, const void *msgData, const Filename &filename, BaseList2D *undoBl, const ModifyFilenameDelegate &modifyFilenameDelegate={})
 

Macro Definition Documentation

◆ MSG_MULTI_RENDERNOTIFICATION

#define MSG_MULTI_RENDERNOTIFICATION

A document and all of its elements receive this message before a render starts. The corresponding data is RenderNotificationData.

◆ MSG_MULTI_MARKMATERIALS

#define MSG_MULTI_MARKMATERIALS

When data is nullptr this is sent to atoms to let them mark the materials they use.
Otherwise the message is sent to let translate material links, for example when a material is replaced, and then the corresponding data is MarkMaterials.

Note
An example for both cases is included on the MarkMaterials page.

◆ MSG_MULTI_DOCUMENTCLONED

#define MSG_MULTI_DOCUMENTCLONED

The document has been cloned.

◆ MSG_MULTI_DOCUMENTIMPORTED

#define MSG_MULTI_DOCUMENTIMPORTED

After a Cinema 4D document has been loaded this message is sent to the document (and all children structures). The corresponding data is DocumentImported.

◆ MSG_MULTI_SETNEWMARKERS

#define MSG_MULTI_SETNEWMARKERS

Private.

◆ MSG_MULTI_CLEARSUGGESTEDFOLDER

#define MSG_MULTI_CLEARSUGGESTEDFOLDER

Objects have to remove absolute paths (only if they support MSG_GETALLASSETS).
Both MSG_GETALLASSETS and MSG_MULTI_CLEARSUGGESTEDFOLDER are important for "Save Project" to work and to collect all items.

Note
When "Save Project with Assets" is invoked, everything is moved to the new target directory.
In this case all absolute paths must be converted to just filenames because the files are next to the document and the absolute paths are not needed anymore.
See also
MSG_GETALLASSETS MSG_RENAMETEXTURES. Struct ModifyFilenameDataStruct will be sent with the message. Call HandleModifyFilenameMessage() to process the data correctly by the c4d api

◆ MSG_MULTI_SCRIPTINFO

#define MSG_MULTI_SCRIPTINFO

Sent to nodes to gather information about the scripting content they host in their parameters. See the correspoding message data ScriptInfoData for more information on how to handle this message.

Function Documentation

◆ HandleModifyFilenameMessage()

maxon::Result<Filename> HandleModifyFilenameMessage ( Int32  msgType,
const void *  msgData,
const Filename filename,
BaseList2D undoBl,
const ModifyFilenameDelegate modifyFilenameDelegate = {} 
)