IDs and information for Ompath

Ompath

Attributes

• ENGLISH NAME : X-ParticlesFollowPathModifier
• NAME : Ompath
• INCLUDE : Obase
• PATH : res/description/ompath.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMPATH

Elements

ID	UI Name	Type	Parameters	Cycle
XMPATH_ENABLED	Enabled	BOOL
XMPATH_MODE	Mode	LONG		PATH_MODE_INDEP Independent PATH_MODE_ACTION Action-Controlled
XMPATH_OBJECTS	PathObjects	IN_EXCLUDE	NUM_FLAGS
XMPATH_STRENGTH_MODE	GetAOTFrom	LONG		STRENGTH_MODE_MOD Modifier STRENGTH_MODE_TAG Tag
XMPATH_STRENGTH	AcutenessofTurn	REAL	UNIT PERCENT MIN 0.0 MAX 10000.0 MINSLIDER 0.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
XMPATH_MAX_RETRIES	Max.Retries	LONG	MIN 1 MAX 1000 MINSLIDER 1 MAXSLIDER 100 CUSTOMGUI LONGSLIDER
XMPATH_CULL_STRAYS	CullStrayParticles	BOOL
XMPATH_SPEED_MODE	SpeedMode	LONG		PATH_SPEED_MODE_INITIAL NoChange PATH_SPEED_MODE_SET SetSpeed PATH_SPEED_MODE_TAG_SET GetSpeedfromTag PATH_SPEED_MODE_TAG_INCR IncrementSpeedfromTag
XMPATH_SPEED_SPEED	Speed	REAL	UNIT METER MIN 0.0 MINSLIDER 0.0 MAXSLIDER 500.0 CUSTOMGUI REALSLIDER SCALE_H
XMPATH_SPEED_VAR	Variation	REAL	UNIT METER MIN 0.0 MINSLIDER 0.0 MAXSLIDER 500.0 CUSTOMGUI REALSLIDER SCALE_H
XMPATH_SPEED_ADJUST	AdjustSpeedbyDistance	BOOL
XMPATH_LOOP	LoopatEndofPath	BOOL
XMPATH_ACTIONLIST	ActionsonEndofPath	IN_EXCLUDE	NUM_FLAGS
XMPATH_ADDACTION	AddAction	BUTTON
XMPATH_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.Ompath)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMPATH_ENABLED] = True
    obj[c4d.XMPATH_MODE] = c4d.PATH_MODE_INDEP
    obj[c4d.XMPATH_STRENGTH_MODE] = c4d.STRENGTH_MODE_MOD
    obj[c4d.XMPATH_STRENGTH] = 0.1
    obj[c4d.XMPATH_MAX_RETRIES] = 1
    obj[c4d.XMPATH_CULL_STRAYS] = True
    obj[c4d.XMPATH_SPEED_MODE] = c4d.PATH_SPEED_MODE_INITIAL
    obj[c4d.XMPATH_SPEED_SPEED] = 0.1
    obj[c4d.XMPATH_SPEED_VAR] = 0.1
    obj[c4d.XMPATH_SPEED_ADJUST] = True
    obj[c4d.XMPATH_LOOP] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMPATH_ENABLED,True)
    bc.SetInt32(c4d.XMPATH_MODE,c4d.PATH_MODE_INDEP)
    bc.SetInt32(c4d.XMPATH_STRENGTH_MODE,c4d.STRENGTH_MODE_MOD)
    bc.SetFloat(c4d.XMPATH_STRENGTH,0.1)
    bc.SetInt32(c4d.XMPATH_MAX_RETRIES,1)
    bc.SetBool(c4d.XMPATH_CULL_STRAYS,True)
    bc.SetInt32(c4d.XMPATH_SPEED_MODE,c4d.PATH_SPEED_MODE_INITIAL)
    bc.SetFloat(c4d.XMPATH_SPEED_SPEED,0.1)
    bc.SetFloat(c4d.XMPATH_SPEED_VAR,0.1)
    bc.SetBool(c4d.XMPATH_SPEED_ADJUST,True)
    bc.SetBool(c4d.XMPATH_LOOP,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/ompath.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ompath);
    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(XMPATH_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMPATH_MODE),GeData(PATH_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMPATH_STRENGTH_MODE),GeData(STRENGTH_MODE_MOD),flags);
    pObject->SetParameter(DescID(XMPATH_STRENGTH),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMPATH_MAX_RETRIES),GeData(1),flags);
    pObject->SetParameter(DescID(XMPATH_CULL_STRAYS),GeData(true),flags);
    pObject->SetParameter(DescID(XMPATH_SPEED_MODE),GeData(PATH_SPEED_MODE_INITIAL),flags);
    pObject->SetParameter(DescID(XMPATH_SPEED_SPEED),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMPATH_SPEED_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMPATH_SPEED_ADJUST),GeData(true),flags);
    pObject->SetParameter(DescID(XMPATH_LOOP),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMPATH_ENABLED,true);
    bc->SetInt32(XMPATH_MODE,PATH_MODE_INDEP);
    bc->SetInt32(XMPATH_STRENGTH_MODE,STRENGTH_MODE_MOD);
    bc->SetFloat(XMPATH_STRENGTH,0.1);
    bc->SetInt32(XMPATH_MAX_RETRIES,1);
    bc->SetBool(XMPATH_CULL_STRAYS,true);
    bc->SetInt32(XMPATH_SPEED_MODE,PATH_SPEED_MODE_INITIAL);
    bc->SetFloat(XMPATH_SPEED_SPEED,0.1);
    bc->SetFloat(XMPATH_SPEED_VAR,0.1);
    bc->SetBool(XMPATH_SPEED_ADJUST,true);
    bc->SetBool(XMPATH_LOOP,true);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.XMPATH_ADDACTION)

C++

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