Here you will find documentation on all the descriptions that Cinema 4D currently has. You can list them Alphabetically, by Type or Plugin . The sample Python and C++ code is automatically generated and in some cases may not be 100% correct. If something doesn't work then please refer to the official Cinema 4D SDK documentation for more information.

IDs and information for Oxgennull

Oxgennull

Attributes

  • ENGLISH NAME : X-ParticlesGeneratorsFolder
  • NAME : Oxgennull
  • INCLUDE : Obase
  • PATH : res/description/oxgennull.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OXGENNULL

Elements

ID UI Name Type Parameters Cycle
XGENNULL_MAKEFOLDER CreateSub-Folder BUTTON  
XGENNULL_NAME FolderName STRING  
XGENNULL_OBJECTS Generators LONG
ANIM OFF
CUSTOMGUI CYCLE
XGENNULL_CHOOSE ChooseGenerator
1029575
XGENNULL_BRANCHMESH SplineMesher
1032145
XGENNULL_ELEKTRIX Elektrix
1032188
XGENNULL_FRAGMENTER Fragmenter
1031138
XGENNULL_GENERATOR Generator
1027654
XGENNULL_SKINNER Skinner
1029227
XGENNULL_SPRITES Sprites
1027664
XGENNULL_TRAILS Trails
1027501
XGENNULL_HELP_BUTTON BITMAPBUTTON  

Example Code

The following code does not use the correct values when setting the data. You should check directly in C4D for the correct values that you should use in place of the ones that are shown. This code is just to show you how to access the values for getting and setting the parameters.

Python

import c4d
from c4d import gui
def main():
    obj = c4d.BaseObject(c4d.Oxgennull)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XGENNULL_NAME] = "Hello World"
    obj[c4d.XGENNULL_OBJECTS] = c4d.XGENNULL_CHOOSE
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetString(c4d.XGENNULL_NAME,"Hello World")
    bc.SetInt32(c4d.XGENNULL_OBJECTS,c4d.XGENNULL_CHOOSE)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/oxgennull.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Oxgennull);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDO_NEW,pObject);
    pDoc->EndUndo();
    EventAdd(EVENT_FORCEREDRAW);
    
    //You can set parameters two different ways. 

    //First way              
    //Some objects do not store all their data in the container. You need to use GetParameter()/SetParameter() instead. 

    DESCFLAGS_SET flags = DESCFLAGS_SET_PARAM_SET;
    pObject->SetParameter(DescID(XGENNULL_NAME),GeData("Hello World"),flags);
    pObject->SetParameter(DescID(XGENNULL_OBJECTS),GeData(XGENNULL_CHOOSE),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetString(XGENNULL_NAME,"Hello World");
    bc->SetInt32(XGENNULL_OBJECTS,XGENNULL_CHOOSE);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

This node has buttons. Buttons can manually be executed by calling the following code

Python

c4d.CallButton(obj,c4d.XGENNULL_MAKEFOLDER)
c4d.CallButton(obj,c4d.XGENNULL_HELP_BUTTON)

C++

DescriptionCommand dc;
dc.id = DescID(XGENNULL_MAKEFOLDER);             
pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);

DescriptionCommand dc; dc.id = DescID(XGENNULL_HELP_BUTTON); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);