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 Omweight

Omweight

Attributes

  • ENGLISH NAME : X-ParticlesWeightModifier
  • NAME : Omweight
  • INCLUDE : Obase
  • PATH : res/description/omweight.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMWEIGHT

Elements

ID UI Name Type Parameters Cycle
XMWG_WEIGHT_ENABLED Enabled BOOL  
XMWG_WEIGHT_MODE Mode LONG  
WEIGHT_MODE_INDEP Independent
WEIGHT_MODE_ACTION Action-Controlled
XMWG_WEIGHT_NUMMODS LONG
MIN 0
HIDDEN
XMWG_MODLINK_ADD Add BUTTON SCALE_H
XMWG_MODLINK_REMOVE Remove BUTTON SCALE_H
XMWG_WEIGHT_PARAM WeightParameter LONG  
WEIGHT_PARAM_NONE None
WEIGHT_PARAM_LIFE Lifespan
WEIGHT_PARAM_AGE Age
WEIGHT_PARAM_COLOUR Color
WEIGHT_PARAM_SPEED Speed
WEIGHT_PARAM_RADIUS Radius
WEIGHT_PARAM_MASS Mass
WEIGHT_PARAM_DIST DistanceTravelled
XMWG_WEIGHT_PARAM_COLOUR ColorComponent LONG  
WPARAM_COLOUR_RED Red
WPARAM_COLOUR_GREEN Green
WPARAM_COLOUR_BLUE Blue
WPARAM_COLOUR_BRIGHT Brightness
XMWG_WEIGHT_PARAM_RMIN Minimum REAL
UNIT REAL
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 300.0
CUSTOMGUI REALSLIDER
XMWG_WEIGHT_PARAM_RMAX Maximum REAL
UNIT REAL
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 300.0
CUSTOMGUI REALSLIDER
XMWG_WEIGHT_TMIN MinimumAge BASETIME  
XMWG_WEIGHT_TMAX MaximumAge BASETIME  
XMWG_WEIGHT_SPLINE Weighting SPLINE
Y_MIN 0.0
Y_MAX 1.0
X_MIN 0.0
X_MAX 1.0
X_STEPS 0.01
Y_STEPS 0.01
XMWG_WEIGHT_SHADER Shader SHADERLINK  
XMWG_WEIGHT_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.Omweight)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMWG_WEIGHT_ENABLED] = True
    obj[c4d.XMWG_WEIGHT_MODE] = c4d.WEIGHT_MODE_INDEP
    obj[c4d.XMWG_WEIGHT_NUMMODS] = 1
    obj[c4d.XMWG_WEIGHT_PARAM] = c4d.WEIGHT_PARAM_NONE
    obj[c4d.XMWG_WEIGHT_PARAM_COLOUR] = c4d.WPARAM_COLOUR_RED
    obj[c4d.XMWG_WEIGHT_PARAM_RMIN] = 0.1
    obj[c4d.XMWG_WEIGHT_PARAM_RMAX] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMWG_WEIGHT_ENABLED,True)
    bc.SetInt32(c4d.XMWG_WEIGHT_MODE,c4d.WEIGHT_MODE_INDEP)
    bc.SetInt32(c4d.XMWG_WEIGHT_NUMMODS,1)
    bc.SetInt32(c4d.XMWG_WEIGHT_PARAM,c4d.WEIGHT_PARAM_NONE)
    bc.SetInt32(c4d.XMWG_WEIGHT_PARAM_COLOUR,c4d.WPARAM_COLOUR_RED)
    bc.SetFloat(c4d.XMWG_WEIGHT_PARAM_RMIN,0.1)
    bc.SetFloat(c4d.XMWG_WEIGHT_PARAM_RMAX,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omweight.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omweight);
    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(XMWG_WEIGHT_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMWG_WEIGHT_MODE),GeData(WEIGHT_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMWG_WEIGHT_NUMMODS),GeData(1),flags);
    pObject->SetParameter(DescID(XMWG_WEIGHT_PARAM),GeData(WEIGHT_PARAM_NONE),flags);
    pObject->SetParameter(DescID(XMWG_WEIGHT_PARAM_COLOUR),GeData(WPARAM_COLOUR_RED),flags);
    pObject->SetParameter(DescID(XMWG_WEIGHT_PARAM_RMIN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMWG_WEIGHT_PARAM_RMAX),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMWG_WEIGHT_ENABLED,true);
    bc->SetInt32(XMWG_WEIGHT_MODE,WEIGHT_MODE_INDEP);
    bc->SetInt32(XMWG_WEIGHT_NUMMODS,1);
    bc->SetInt32(XMWG_WEIGHT_PARAM,WEIGHT_PARAM_NONE);
    bc->SetInt32(XMWG_WEIGHT_PARAM_COLOUR,WPARAM_COLOUR_RED);
    bc->SetFloat(XMWG_WEIGHT_PARAM_RMIN,0.1);
    bc->SetFloat(XMWG_WEIGHT_PARAM_RMAX,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.XMWG_MODLINK_ADD)
c4d.CallButton(obj,c4d.XMWG_MODLINK_REMOVE)

C++

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

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