RetrievePrivateData Struct Reference

#include <c4d_baselist.h>

Detailed Description

Message struct for the MSG_RETRIEVEPRIVATEDATA message.
For example, this message can be used to get/set exporters/importers settings:

BaseList2D* exporter;
// Find Alembic scene saver (exporter) plugin with its ID 1028082
// If found, send MSG_RETRIEVEPRIVATEDATA to get the Alembic exporter private data
if (abc && abc->Message(MSG_RETRIEVEPRIVATEDATA, &exporter))
{
if (!exporter)
return false;
// Get the container data instance
if (!data)
return false;
// Set Alembic export settings
data->SetBool(ABCEXPORT_HAIR, true);
data->SetBool(ABCEXPORT_XREFS, true);
SaveDocument(doc, "dir/to/save/to/filename.abc", SAVEDOCUMENTFLAGS::DONTADDTORECENTLIST, 1028082);
}

Public Member Functions

 RetrievePrivateData ()
 

Public Attributes

Int32 flags
 
void * data
 

Constructor & Destructor Documentation

◆ RetrievePrivateData()

Default constructor.

Member Data Documentation

◆ flags

Int32 flags

The flags for the retrieval.

◆ data

void* data

The address returned.

BaseList2D
Definition: c4d_baselist.h:2138
FindPlugin
BasePlugin * FindPlugin(Int32 id, PLUGINTYPE type)
BaseList2D::GetDataInstance
const BaseContainer * GetDataInstance() const
Definition: c4d_baselist.h:2277
PLUGINTYPE::SCENESAVER
@ SCENESAVER
Scene saver. (SceneSaverData)
ABCEXPORT_PARTICLE_GEOMETRY
@ ABCEXPORT_PARTICLE_GEOMETRY
Definition: falembicexport.h:31
SaveDocument
Bool SaveDocument(BaseDocument *doc, const Filename &name, SAVEDOCUMENTFLAGS saveflags, Int32 format)
MSG_RETRIEVEPRIVATEDATA
#define MSG_RETRIEVEPRIVATEDATA
A generic private message to retrieve data from an object. Specific for every type of object so no pu...
Definition: c4d_baselist.h:380
ABCEXPORT_XREFS
@ ABCEXPORT_XREFS
Definition: falembicexport.h:30
ABCEXPORT_HAIR
@ ABCEXPORT_HAIR
Definition: falembicexport.h:26
C4DAtom::Message
Bool Message(Int32 type, void *data=nullptr)
Definition: c4d_baselist.h:1388
SAVEDOCUMENTFLAGS::DONTADDTORECENTLIST
@ DONTADDTORECENTLIST
Do not add the saved document to the recent file list.
BasePlugin
The base class for Cinema&#160;4D plugins.
Definition: c4d_baseplugin.h:59
RetrievePrivateData::data
void * data
The address returned.
Definition: c4d_baselist.h:824
BaseContainer
Definition: c4d_basecontainer.h:42