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 Oxpvolemit

Oxpvolemit

Attributes

  • ENGLISH NAME : X-ParticlesVolumeEmissionControl
  • NAME : Oxpvolemit
  • INCLUDE : Obase
  • PATH : res/description/oxpvolemit.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OXPVOLEMIT

Elements

ID UI Name Type Parameters Cycle
XMVE_VOLEMIT_ENABLED Enabled BOOL  
XMVE_VOLEMIT_EMITTER Emitter LINK  
XMVE_VOLEMIT_MODE TrackingMode LONG  
VOLEMIT_MODE_EMITTER Emitter
VOLEMIT_MODE_OBJECT Object
XMVE_VOLEMIT_EMOBJECT ObjecttoTrack LINK  
XMVE_VOLEMIT_OBJECTS VolumeObjects IN_EXCLUDE
NUM_FLAGS 3
INIT_STATE 7
SEND_SELCHNGMSG 1
SCALE_V
IMAGE_01_ON 1009316
IMAGE_01_OFF 1009320
IMAGE_02_ON 300000231
IMAGE_02_OFF 300000230
IMAGE_03_ON 1034540
IMAGE_03_OFF 1034541
XMVE_HELP_BUTTON BITMAPBUTTON  
XMVE_VIDMAN_BUTTON BITMAPBUTTON  
XMVE_BUTTON_RESET ResettoDefaults BUTTON  
XMVE_BUTTON_SAVE_PRESET SavePreset... BUTTON  
XMVE_BUTTON_LOAD_PRESET LoadPreset... BUTTON  

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.Oxpvolemit)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMVE_VOLEMIT_ENABLED] = True
    obj[c4d.XMVE_VOLEMIT_MODE] = c4d.VOLEMIT_MODE_EMITTER
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMVE_VOLEMIT_ENABLED,True)
    bc.SetInt32(c4d.XMVE_VOLEMIT_MODE,c4d.VOLEMIT_MODE_EMITTER)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/oxpvolemit.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Oxpvolemit);
    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(XMVE_VOLEMIT_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMVE_VOLEMIT_MODE),GeData(VOLEMIT_MODE_EMITTER),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMVE_VOLEMIT_ENABLED,true);
    bc->SetInt32(XMVE_VOLEMIT_MODE,VOLEMIT_MODE_EMITTER);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.XMVE_HELP_BUTTON)
c4d.CallButton(obj,c4d.XMVE_VIDMAN_BUTTON)
c4d.CallButton(obj,c4d.XMVE_BUTTON_RESET)
c4d.CallButton(obj,c4d.XMVE_BUTTON_SAVE_PRESET)
c4d.CallButton(obj,c4d.XMVE_BUTTON_LOAD_PRESET)

C++

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

DescriptionCommand dc; dc.id = DescID(XMVE_VIDMAN_BUTTON); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMVE_BUTTON_RESET); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMVE_BUTTON_SAVE_PRESET); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMVE_BUTTON_LOAD_PRESET); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);