IDs and information for Omattract

Omattract

Attributes

• ENGLISH NAME : X-ParticlesAttractorModifier
• NAME : Omattract
• INCLUDE : Obase
• PATH : res/description/omattract.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMATTRACT

Elements

ID	UI Name	Type	Parameters	Cycle
XMAT_ENABLED	Enabled	BOOL
XMAT_ATTRACT_MODE	Mode	LONG		ATTRACT_MODE_INDEP Independent ATTRACT_MODE_ACTION Action-Controlled
XMAT_ATTRACT_FORCE	Force	REAL	UNIT REAL MINSLIDER -300.0 MAXSLIDER 300.0 CUSTOMGUI REALSLIDER
XMAT_ATTRACT_GRAVITY	Acceleration	REAL	UNIT METER MINSLIDER -3000.0 MAXSLIDER 3000.0 CUSTOMGUI REALSLIDER
XMAT_ATTRACT_SPEEDLIMIT	SpeedLimit	REAL	UNIT METER MIN 0.0 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XMAT_ATTRACT_ACTIONMODE	RangeMode	LONG		ATTRACT_ACTIONMODE_MORETHAN RangeMoreThan ATTRACT_ACTIONMODE_LESSTHAN RangeLessThan
XMAT_ATTRACT_ACTIONRANGE	Range	REAL	UNIT METER MIN 0.0 MIN 0.0 MINSLIDER 0.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
XMAT_ATTRACT_ACTIONLIST	Actions	IN_EXCLUDE	NUM_FLAGS
XMAT_ATTRACT_ADDACTION	AddAction	BUTTON
XMAT_ATTRACT_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.Omattract)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMAT_ENABLED] = True
    obj[c4d.XMAT_ATTRACT_MODE] = c4d.ATTRACT_MODE_INDEP
    obj[c4d.XMAT_ATTRACT_FORCE] = 0.1
    obj[c4d.XMAT_ATTRACT_GRAVITY] = 0.1
    obj[c4d.XMAT_ATTRACT_SPEEDLIMIT] = 0.1
    obj[c4d.XMAT_ATTRACT_ACTIONMODE] = c4d.ATTRACT_ACTIONMODE_MORETHAN
    obj[c4d.XMAT_ATTRACT_ACTIONRANGE] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMAT_ENABLED,True)
    bc.SetInt32(c4d.XMAT_ATTRACT_MODE,c4d.ATTRACT_MODE_INDEP)
    bc.SetFloat(c4d.XMAT_ATTRACT_FORCE,0.1)
    bc.SetFloat(c4d.XMAT_ATTRACT_GRAVITY,0.1)
    bc.SetFloat(c4d.XMAT_ATTRACT_SPEEDLIMIT,0.1)
    bc.SetInt32(c4d.XMAT_ATTRACT_ACTIONMODE,c4d.ATTRACT_ACTIONMODE_MORETHAN)
    bc.SetFloat(c4d.XMAT_ATTRACT_ACTIONRANGE,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omattract.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omattract);
    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(XMAT_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMAT_ATTRACT_MODE),GeData(ATTRACT_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMAT_ATTRACT_FORCE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMAT_ATTRACT_GRAVITY),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMAT_ATTRACT_SPEEDLIMIT),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMAT_ATTRACT_ACTIONMODE),GeData(ATTRACT_ACTIONMODE_MORETHAN),flags);
    pObject->SetParameter(DescID(XMAT_ATTRACT_ACTIONRANGE),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMAT_ENABLED,true);
    bc->SetInt32(XMAT_ATTRACT_MODE,ATTRACT_MODE_INDEP);
    bc->SetFloat(XMAT_ATTRACT_FORCE,0.1);
    bc->SetFloat(XMAT_ATTRACT_GRAVITY,0.1);
    bc->SetFloat(XMAT_ATTRACT_SPEEDLIMIT,0.1);
    bc->SetInt32(XMAT_ATTRACT_ACTIONMODE,ATTRACT_ACTIONMODE_MORETHAN);
    bc->SetFloat(XMAT_ATTRACT_ACTIONRANGE,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.XMAT_ATTRACT_ADDACTION)

C++

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