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 Omspeed

Omspeed

Attributes

  • ENGLISH NAME : X-ParticlesSpeedModifier
  • NAME : Omspeed
  • INCLUDE : Obase
  • PATH : res/description/omspeed.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMSPEED

Elements

ID UI Name Type Parameters Cycle
XMSP_SPEED_ENABLED Enabled BOOL  
XMSP_SPEED_MODE Mode LONG  
SPEED_MODE_INDEP Independent
SPEED_MODE_ACTION Action-Controlled
XMSP_SPEED_OPERATION Operation LONG  
SPEED_OP_INCR Incremental
SPEED_OP_SPLINE UseSpline
SPEED_OP_ABSOLUTE Absolute
SPEED_OP_ACCEL Acceleration
XMSP_SPEED_ACCEL Exponential REAL
UNIT REAL
STEP 0.1
MINSLIDER -100.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMSP_SPEED_DELTA ParticleSpeedChange REAL
UNIT METER
STEP 1.0
MINSLIDER -1000.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMSP_SPEED_DELTA_VAR Variation REAL
UNIT METER
MIN 0.0
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMSP_SPEED_CLAMP_MIN ClampMinimumSpeed BOOL  
XMSP_SPEED_MIN ParticleSpeedMinimum REAL
UNIT METER
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMSP_SPEED_CLAMP_MAX ClampMaximumSpeed BOOL  
XMSP_SPEED_MAX ParticleSpeedMaximum REAL
UNIT METER
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMSP_SPEED_SPLINE SpeedSpline SPLINE
Y_MIN 0.0
Y_MAX 300.0
X_MIN 0.0
X_MAX 1.0
X_STEPS 0.01
Y_STEPS 1.0
XMSP_SPEED_YMAX SpeedMaximum REAL
MIN 0.0
STEP 0.01
MINSLIDER 0.0
MAXSLIDER 600.0
CUSTOMGUI REALSLIDER
XMSP_SPEED_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.Omspeed)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMSP_SPEED_ENABLED] = True
    obj[c4d.XMSP_SPEED_MODE] = c4d.SPEED_MODE_INDEP
    obj[c4d.XMSP_SPEED_OPERATION] = c4d.SPEED_OP_INCR
    obj[c4d.XMSP_SPEED_ACCEL] = 0.1
    obj[c4d.XMSP_SPEED_DELTA] = 0.1
    obj[c4d.XMSP_SPEED_DELTA_VAR] = 0.1
    obj[c4d.XMSP_SPEED_CLAMP_MIN] = True
    obj[c4d.XMSP_SPEED_MIN] = 0.1
    obj[c4d.XMSP_SPEED_CLAMP_MAX] = True
    obj[c4d.XMSP_SPEED_MAX] = 0.1
    obj[c4d.XMSP_SPEED_YMAX] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMSP_SPEED_ENABLED,True)
    bc.SetInt32(c4d.XMSP_SPEED_MODE,c4d.SPEED_MODE_INDEP)
    bc.SetInt32(c4d.XMSP_SPEED_OPERATION,c4d.SPEED_OP_INCR)
    bc.SetFloat(c4d.XMSP_SPEED_ACCEL,0.1)
    bc.SetFloat(c4d.XMSP_SPEED_DELTA,0.1)
    bc.SetFloat(c4d.XMSP_SPEED_DELTA_VAR,0.1)
    bc.SetBool(c4d.XMSP_SPEED_CLAMP_MIN,True)
    bc.SetFloat(c4d.XMSP_SPEED_MIN,0.1)
    bc.SetBool(c4d.XMSP_SPEED_CLAMP_MAX,True)
    bc.SetFloat(c4d.XMSP_SPEED_MAX,0.1)
    bc.SetFloat(c4d.XMSP_SPEED_YMAX,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omspeed.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omspeed);
    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(XMSP_SPEED_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_MODE),GeData(SPEED_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_OPERATION),GeData(SPEED_OP_INCR),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_ACCEL),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_DELTA),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_DELTA_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_CLAMP_MIN),GeData(true),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_MIN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_CLAMP_MAX),GeData(true),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_MAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSP_SPEED_YMAX),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMSP_SPEED_ENABLED,true);
    bc->SetInt32(XMSP_SPEED_MODE,SPEED_MODE_INDEP);
    bc->SetInt32(XMSP_SPEED_OPERATION,SPEED_OP_INCR);
    bc->SetFloat(XMSP_SPEED_ACCEL,0.1);
    bc->SetFloat(XMSP_SPEED_DELTA,0.1);
    bc->SetFloat(XMSP_SPEED_DELTA_VAR,0.1);
    bc->SetBool(XMSP_SPEED_CLAMP_MIN,true);
    bc->SetFloat(XMSP_SPEED_MIN,0.1);
    bc->SetBool(XMSP_SPEED_CLAMP_MAX,true);
    bc->SetFloat(XMSP_SPEED_MAX,0.1);
    bc->SetFloat(XMSP_SPEED_YMAX,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}