IDs and information for Ompy

Ompy

Attributes

• ENGLISH NAME : X-ParticlesPythonModifier
• NAME : Ompy
• INCLUDE : Obase
• PATH : res/description/ompy.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMPY

Elements

ID	UI Name	Type	Parameters	Cycle
XMPY_ENABLED	Enabled	BOOL
XMPY_MODE	Mode	LONG		XMPY_MODE_INDEP Independent XMPY_MODE_ACTION Action-Controlled
XMPY_DRAW	VisibleinEditor	BOOL
XMPY_SCRIPT	Script	STRING	CUSTOMGUI MULTISTRING ANIM OFF PYTHON SCALE_V
XMPY_OPENEDITOR	OpenEditor...	BUTTON
XMPY_SCRIPT_BUTTON_1	Output	BUTTON	HIDDEN
XMPY_SCRIPT_OUT	Output	STRING	HIDDEN
XMPY_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.Ompy)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMPY_ENABLED] = True
    obj[c4d.XMPY_MODE] = c4d.XMPY_MODE_INDEP
    obj[c4d.XMPY_DRAW] = True
    obj[c4d.XMPY_SCRIPT] = "Hello World"
    obj[c4d.XMPY_SCRIPT_OUT] = "Hello World"
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMPY_ENABLED,True)
    bc.SetInt32(c4d.XMPY_MODE,c4d.XMPY_MODE_INDEP)
    bc.SetBool(c4d.XMPY_DRAW,True)
    bc.SetString(c4d.XMPY_SCRIPT,"Hello World")
    bc.SetString(c4d.XMPY_SCRIPT_OUT,"Hello World")

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/ompy.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ompy);
    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(XMPY_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMPY_MODE),GeData(XMPY_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMPY_DRAW),GeData(true),flags);
    pObject->SetParameter(DescID(XMPY_SCRIPT),GeData("Hello World"),flags);
    pObject->SetParameter(DescID(XMPY_SCRIPT_OUT),GeData("Hello World"),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMPY_ENABLED,true);
    bc->SetInt32(XMPY_MODE,XMPY_MODE_INDEP);
    bc->SetBool(XMPY_DRAW,true);
    bc->SetString(XMPY_SCRIPT,"Hello World");
    bc->SetString(XMPY_SCRIPT_OUT,"Hello World");
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.XMPY_OPENEDITOR)
c4d.CallButton(obj,c4d.XMPY_SCRIPT_BUTTON_1)

C++

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


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