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 Omdirection

Omdirection

Attributes

  • ENGLISH NAME : X-ParticlesDirectionModifier
  • NAME : Omdirection
  • INCLUDE : Obase
  • PATH : res/description/omdirection.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMDIRECTION

Elements

ID UI Name Type Parameters Cycle
XMDI_DIRECT_ENABLED Enabled BOOL  
XMDI_DIRECT_MODE Mode LONG  
DIRECT_MODE_INDEP Independent
DIRECT_MODE_ACTION Action-Controlled
XMDI_DIRECT_DRAW VisibleinEditor BOOL  
XMDI_DIRECT_OPERATION Operation LONG  
DIRECT_OPERATION_ABSOLUTE Absolute
DIRECT_OPERATION_SPRAY Spray
DIRECT_OPERATION_CONSTANT Circular
DIRECT_OPERATION_JITTER Jitter
DIRECT_OPERATION_DISC Ring
DIRECT_OPERATION_USEMOD UseModifierRotation
XMDI_DIRECT_RANSEED RandomSeed LONG
MIN 0
MINSLIDER 0
MAXSLIDER 10000
CUSTOMGUI LONGSLIDER
XMDI_DIRECT_X Heading REAL
UNIT DEGREE
STEP 1.0
MINSLIDER -360.0
MAXSLIDER 360.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_XVAR Variation+/- REAL
UNIT DEGREE
MIN 0.0
MAX 360.0
MINSLIDER 0.0
MAXSLIDER 360.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_Y Pitch REAL
UNIT DEGREE
STEP 1.0
MINSLIDER -360.0
MAXSLIDER 360.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_YVAR Variation+/- REAL
UNIT DEGREE
MIN 0.0
MAX 360.0
MINSLIDER 0.0
MAXSLIDER 360.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_USEAOT UseAcutenessofTurn BOOL  
XMDI_DIRECT_STRENGTH AcutenessofTurn REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_YKICK Y-AxisKick REAL
UNIT METER
MINSLIDER -100.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_YKICK_VAR Variation+/- REAL
UNIT METER
MINSLIDER -100.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_SPRAY_MAX SprayStrength REAL
UNIT PERCENT
STEP 1.0
MIN 0.0
MAX 100.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_DISCANGLE StepPerFrame REAL
UNIT DEGREE
STEP 1.0
MIN 0.0
MAX 36000.0
MINSLIDER 0.0
MAXSLIDER 360.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_DISCLIMIT AngleLimit REAL
UNIT DEGREE
STEP 1.0
MIN 0.0
MAX 90.0
MINSLIDER 0.0
MAXSLIDER 90.0
CUSTOMGUI REALSLIDER
XMDI_DIRECT_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.Omdirection)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMDI_DIRECT_ENABLED] = True
    obj[c4d.XMDI_DIRECT_MODE] = c4d.DIRECT_MODE_INDEP
    obj[c4d.XMDI_DIRECT_DRAW] = True
    obj[c4d.XMDI_DIRECT_OPERATION] = c4d.DIRECT_OPERATION_ABSOLUTE
    obj[c4d.XMDI_DIRECT_RANSEED] = 1
    obj[c4d.XMDI_DIRECT_X] = 0.1
    obj[c4d.XMDI_DIRECT_XVAR] = 0.1
    obj[c4d.XMDI_DIRECT_Y] = 0.1
    obj[c4d.XMDI_DIRECT_YVAR] = 0.1
    obj[c4d.XMDI_DIRECT_USEAOT] = True
    obj[c4d.XMDI_DIRECT_STRENGTH] = 0.1
    obj[c4d.XMDI_DIRECT_YKICK] = 0.1
    obj[c4d.XMDI_DIRECT_YKICK_VAR] = 0.1
    obj[c4d.XMDI_DIRECT_SPRAY_MAX] = 0.1
    obj[c4d.XMDI_DIRECT_DISCANGLE] = 0.1
    obj[c4d.XMDI_DIRECT_DISCLIMIT] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMDI_DIRECT_ENABLED,True)
    bc.SetInt32(c4d.XMDI_DIRECT_MODE,c4d.DIRECT_MODE_INDEP)
    bc.SetBool(c4d.XMDI_DIRECT_DRAW,True)
    bc.SetInt32(c4d.XMDI_DIRECT_OPERATION,c4d.DIRECT_OPERATION_ABSOLUTE)
    bc.SetInt32(c4d.XMDI_DIRECT_RANSEED,1)
    bc.SetFloat(c4d.XMDI_DIRECT_X,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_XVAR,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_Y,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_YVAR,0.1)
    bc.SetBool(c4d.XMDI_DIRECT_USEAOT,True)
    bc.SetFloat(c4d.XMDI_DIRECT_STRENGTH,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_YKICK,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_YKICK_VAR,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_SPRAY_MAX,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_DISCANGLE,0.1)
    bc.SetFloat(c4d.XMDI_DIRECT_DISCLIMIT,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omdirection.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omdirection);
    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(XMDI_DIRECT_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_MODE),GeData(DIRECT_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_DRAW),GeData(true),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_OPERATION),GeData(DIRECT_OPERATION_ABSOLUTE),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_RANSEED),GeData(1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_X),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_XVAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_Y),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_YVAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_USEAOT),GeData(true),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_STRENGTH),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_YKICK),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_YKICK_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_SPRAY_MAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_DISCANGLE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMDI_DIRECT_DISCLIMIT),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMDI_DIRECT_ENABLED,true);
    bc->SetInt32(XMDI_DIRECT_MODE,DIRECT_MODE_INDEP);
    bc->SetBool(XMDI_DIRECT_DRAW,true);
    bc->SetInt32(XMDI_DIRECT_OPERATION,DIRECT_OPERATION_ABSOLUTE);
    bc->SetInt32(XMDI_DIRECT_RANSEED,1);
    bc->SetFloat(XMDI_DIRECT_X,0.1);
    bc->SetFloat(XMDI_DIRECT_XVAR,0.1);
    bc->SetFloat(XMDI_DIRECT_Y,0.1);
    bc->SetFloat(XMDI_DIRECT_YVAR,0.1);
    bc->SetBool(XMDI_DIRECT_USEAOT,true);
    bc->SetFloat(XMDI_DIRECT_STRENGTH,0.1);
    bc->SetFloat(XMDI_DIRECT_YKICK,0.1);
    bc->SetFloat(XMDI_DIRECT_YKICK_VAR,0.1);
    bc->SetFloat(XMDI_DIRECT_SPRAY_MAX,0.1);
    bc->SetFloat(XMDI_DIRECT_DISCANGLE,0.1);
    bc->SetFloat(XMDI_DIRECT_DISCLIMIT,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}