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 Omgravity

Omgravity

Attributes

  • ENGLISH NAME : X-ParticlesGravityModifier
  • NAME : Omgravity
  • INCLUDE : Obase
  • PATH : res/description/omgravity.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMGRAVITY

Elements

ID UI Name Type Parameters Cycle
XMGR_GRAVITY_ENABLED Enabled BOOL  
XMGR_GRAVITY_MODE Mode LONG  
GRAVITY_MODE_INDEP Independent
GRAVITY_MODE_ACTION Action-Controlled
XMGR_GRAVITY_DRAW VisibleinEditor BOOL  
XMGR_GRAVITY_VALUE GravityStrength REAL
UNIT METER
STEP 1.0
MINSLIDER -1000.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMGR_GRAVITY_VAR Variation REAL
UNIT METER
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMGR_GRAVITY_VAR_MODE VariationMode LONG  
GRAVITY_VAR_MODE_FRAME VariationPer-Frame
GRAVITY_VAR_MODE_PARTICLE FixedPer-Particle
XMGR_GRAVITY_FACEOBJECT EffectTowards LINK  
XMGR_GRAVITY_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.Omgravity)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMGR_GRAVITY_ENABLED] = True
    obj[c4d.XMGR_GRAVITY_MODE] = c4d.GRAVITY_MODE_INDEP
    obj[c4d.XMGR_GRAVITY_DRAW] = True
    obj[c4d.XMGR_GRAVITY_VALUE] = 0.1
    obj[c4d.XMGR_GRAVITY_VAR] = 0.1
    obj[c4d.XMGR_GRAVITY_VAR_MODE] = c4d.GRAVITY_VAR_MODE_FRAME
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMGR_GRAVITY_ENABLED,True)
    bc.SetInt32(c4d.XMGR_GRAVITY_MODE,c4d.GRAVITY_MODE_INDEP)
    bc.SetBool(c4d.XMGR_GRAVITY_DRAW,True)
    bc.SetFloat(c4d.XMGR_GRAVITY_VALUE,0.1)
    bc.SetFloat(c4d.XMGR_GRAVITY_VAR,0.1)
    bc.SetInt32(c4d.XMGR_GRAVITY_VAR_MODE,c4d.GRAVITY_VAR_MODE_FRAME)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omgravity.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omgravity);
    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(XMGR_GRAVITY_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMGR_GRAVITY_MODE),GeData(GRAVITY_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMGR_GRAVITY_DRAW),GeData(true),flags);
    pObject->SetParameter(DescID(XMGR_GRAVITY_VALUE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMGR_GRAVITY_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMGR_GRAVITY_VAR_MODE),GeData(GRAVITY_VAR_MODE_FRAME),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMGR_GRAVITY_ENABLED,true);
    bc->SetInt32(XMGR_GRAVITY_MODE,GRAVITY_MODE_INDEP);
    bc->SetBool(XMGR_GRAVITY_DRAW,true);
    bc->SetFloat(XMGR_GRAVITY_VALUE,0.1);
    bc->SetFloat(XMGR_GRAVITY_VAR,0.1);
    bc->SetInt32(XMGR_GRAVITY_VAR_MODE,GRAVITY_VAR_MODE_FRAME);
    pObject->Message(MSG_UPDATE);                                                      
}