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 Oxpflockhelp

Oxpflockhelp

Attributes

  • ENGLISH NAME : X-ParticlesFlockHelper
  • NAME : Oxpflockhelp
  • INCLUDE : Obase
  • PATH : res/description/oxpflockhelp.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OXPFLOCKHELP

Elements

ID UI Name Type Parameters Cycle
XMFH_HELPER_ENABLED Enabled BOOL  
XMFH_HELPER_MODE Mode LONG  
HELPER_MODE_ATTRACT Attract
HELPER_MODE_REPEL Repel
HELPER_MODE_CHASE Chase
XMFH_HELPER_TYPE Type LONG  
HELPER_TYPE_LIMITED Limited
HELPER_TYPE_INFINITE Infinite
XMFH_HELPER_COLOR Color COLOR OPEN
XMFH_HELPER_RADIUS Radius REAL
UNIT METER
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMFH_HELPER_STRENGTH Strength REAL
UNIT PERCENT
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 500.0
CUSTOMGUI REALSLIDER
XMFH_HELPER_CHASE_EMITTER Emitter LINK  
XMFH_HELPER_CHASE_SPEED ChaseSpeed REAL
UNIT METER
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMFH_HELPER_CHASE_STRENGTH AcutenessofTurn REAL
UNIT PERCENT
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMFH_HELPER_CHASE_ACTION_RADIUS ActionRadius REAL
UNIT METER
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 500.0
CUSTOMGUI REALSLIDER
XMFH_HELPER_CHASE_REPEL ChaserAlsoRepels BOOL  
XMFH_HELPER_CHASE_SETUP SetInitialPosition BUTTON  
XMFH_HELPER_CHASE_STARTPOS StartPosition VECTOR HIDDEN
XMFH_HELPER_CHASE_ACTIONLIST Actions IN_EXCLUDE NUM_FLAGS
XMFH_HELPER_CHASE_ADDACTION AddAction BUTTON  
XMFH_HELPER_FALLOFF Falloff LONG  
XMFH_HELP_BUTTON BITMAPBUTTON  
XMFH_VIDMAN_BUTTON BITMAPBUTTON  
XMFH_BUTTON_RESET ResettoDefaults BUTTON  
XMFH_BUTTON_SAVE_PRESET SavePreset... BUTTON  
XMFH_BUTTON_LOAD_PRESET LoadPreset... BUTTON  
XMFH_HELPER_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.Oxpflockhelp)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMFH_HELPER_ENABLED] = True
    obj[c4d.XMFH_HELPER_MODE] = c4d.HELPER_MODE_ATTRACT
    obj[c4d.XMFH_HELPER_TYPE] = c4d.HELPER_TYPE_LIMITED
    obj[c4d.XMFH_HELPER_RADIUS] = 0.1
    obj[c4d.XMFH_HELPER_STRENGTH] = 0.1
    obj[c4d.XMFH_HELPER_CHASE_SPEED] = 0.1
    obj[c4d.XMFH_HELPER_CHASE_STRENGTH] = 0.1
    obj[c4d.XMFH_HELPER_CHASE_ACTION_RADIUS] = 0.1
    obj[c4d.XMFH_HELPER_CHASE_REPEL] = True
    obj[c4d.XMFH_HELPER_CHASE_STARTPOS] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMFH_HELPER_FALLOFF] = 1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMFH_HELPER_ENABLED,True)
    bc.SetInt32(c4d.XMFH_HELPER_MODE,c4d.HELPER_MODE_ATTRACT)
    bc.SetInt32(c4d.XMFH_HELPER_TYPE,c4d.HELPER_TYPE_LIMITED)
    bc.SetFloat(c4d.XMFH_HELPER_RADIUS,0.1)
    bc.SetFloat(c4d.XMFH_HELPER_STRENGTH,0.1)
    bc.SetFloat(c4d.XMFH_HELPER_CHASE_SPEED,0.1)
    bc.SetFloat(c4d.XMFH_HELPER_CHASE_STRENGTH,0.1)
    bc.SetFloat(c4d.XMFH_HELPER_CHASE_ACTION_RADIUS,0.1)
    bc.SetBool(c4d.XMFH_HELPER_CHASE_REPEL,True)
    bc.SetVector(c4d.XMFH_HELPER_CHASE_STARTPOS, c4d.Vector(1.0,1.0,1.0)
    bc.SetInt32(c4d.XMFH_HELPER_FALLOFF,1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/oxpflockhelp.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Oxpflockhelp);
    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(XMFH_HELPER_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_MODE),GeData(HELPER_MODE_ATTRACT),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_TYPE),GeData(HELPER_TYPE_LIMITED),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_RADIUS),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_STRENGTH),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_CHASE_SPEED),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_CHASE_STRENGTH),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_CHASE_ACTION_RADIUS),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_CHASE_REPEL),GeData(true),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_CHASE_STARTPOS),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMFH_HELPER_FALLOFF),GeData(1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMFH_HELPER_ENABLED,true);
    bc->SetInt32(XMFH_HELPER_MODE,HELPER_MODE_ATTRACT);
    bc->SetInt32(XMFH_HELPER_TYPE,HELPER_TYPE_LIMITED);
    bc->SetFloat(XMFH_HELPER_RADIUS,0.1);
    bc->SetFloat(XMFH_HELPER_STRENGTH,0.1);
    bc->SetFloat(XMFH_HELPER_CHASE_SPEED,0.1);
    bc->SetFloat(XMFH_HELPER_CHASE_STRENGTH,0.1);
    bc->SetFloat(XMFH_HELPER_CHASE_ACTION_RADIUS,0.1);
    bc->SetBool(XMFH_HELPER_CHASE_REPEL,true);
    bc->SetVector(XMFH_HELPER_CHASE_STARTPOS, c4d.Vector(1.0,1.0,1.0);
    bc->SetInt32(XMFH_HELPER_FALLOFF,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.XMFH_HELPER_CHASE_SETUP)
c4d.CallButton(obj,c4d.XMFH_HELPER_CHASE_ADDACTION)
c4d.CallButton(obj,c4d.XMFH_HELP_BUTTON)
c4d.CallButton(obj,c4d.XMFH_VIDMAN_BUTTON)
c4d.CallButton(obj,c4d.XMFH_BUTTON_RESET)
c4d.CallButton(obj,c4d.XMFH_BUTTON_SAVE_PRESET)
c4d.CallButton(obj,c4d.XMFH_BUTTON_LOAD_PRESET)

C++

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

DescriptionCommand dc; dc.id = DescID(XMFH_HELPER_CHASE_ADDACTION); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMFH_HELP_BUTTON); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMFH_VIDMAN_BUTTON); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMFH_BUTTON_RESET); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMFH_BUTTON_SAVE_PRESET); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(XMFH_BUTTON_LOAD_PRESET); pObject->Message(MSG_DESCRIPTION_COMMAND, &dc);