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 Omtrails

Omtrails

Attributes

  • ENGLISH NAME : X-ParticlesTrailsModifier
  • NAME : Omtrails
  • INCLUDE : Obase
  • PATH : res/description/omtrails.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMTRAILS

Elements

ID UI Name Type Parameters Cycle
XMTRL_TRAILS_ENABLED Enabled BOOL  
XMTRL_TRAILS_MODE Mode LONG  
TRAILS_MODE_INDEP Independent
TRAILS_MODE_ACTION Action-Controlled
XMTRL_TRAILS_OPERATION Operation LONG  
TRAILS_OP_SHRINK Shrink
TRAILS_OP_EXPAND Expand
TRAILS_OP_BOTH Pulse
XMTRL_TRAILS_MINLENGTH MinimumLength LONG
MIN 0
CUSTOMGUI LONGSLIDER
XMTRL_TRAILS_SPEED RateofChange LONG
MIN 1
CUSTOMGUI LONGSLIDER
XMTRL_TRAILS_INTERVAL Interval BASETIME  
XMTRL_TRAILS_GROUP Groups IN_EXCLUDE
NUM_FLAGS 2
INIT_STATE 3
SEND_SELCHNGMSG 1
SCALE_V
IMAGE_01_ON 1009316
IMAGE_01_OFF 1009320
IMAGE_02_ON 300000231
IMAGE_02_OFF 300000230

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.Omtrails)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMTRL_TRAILS_ENABLED] = True
    obj[c4d.XMTRL_TRAILS_MODE] = c4d.TRAILS_MODE_INDEP
    obj[c4d.XMTRL_TRAILS_OPERATION] = c4d.TRAILS_OP_SHRINK
    obj[c4d.XMTRL_TRAILS_MINLENGTH] = 1
    obj[c4d.XMTRL_TRAILS_SPEED] = 1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMTRL_TRAILS_ENABLED,True)
    bc.SetInt32(c4d.XMTRL_TRAILS_MODE,c4d.TRAILS_MODE_INDEP)
    bc.SetInt32(c4d.XMTRL_TRAILS_OPERATION,c4d.TRAILS_OP_SHRINK)
    bc.SetInt32(c4d.XMTRL_TRAILS_MINLENGTH,1)
    bc.SetInt32(c4d.XMTRL_TRAILS_SPEED,1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omtrails.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omtrails);
    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(XMTRL_TRAILS_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMTRL_TRAILS_MODE),GeData(TRAILS_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMTRL_TRAILS_OPERATION),GeData(TRAILS_OP_SHRINK),flags);
    pObject->SetParameter(DescID(XMTRL_TRAILS_MINLENGTH),GeData(1),flags);
    pObject->SetParameter(DescID(XMTRL_TRAILS_SPEED),GeData(1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMTRL_TRAILS_ENABLED,true);
    bc->SetInt32(XMTRL_TRAILS_MODE,TRAILS_MODE_INDEP);
    bc->SetInt32(XMTRL_TRAILS_OPERATION,TRAILS_OP_SHRINK);
    bc->SetInt32(XMTRL_TRAILS_MINLENGTH,1);
    bc->SetInt32(XMTRL_TRAILS_SPEED,1);
    pObject->Message(MSG_UPDATE);                                                      
}