IDs and information for Oepython

Oepython

Attributes

• ENGLISH NAME : PythonEffector
• NAME : Oepython
• INCLUDE : Obaseeffector
• PATH : python/description/oepython.res
• PLUGIN : python
• MAXON online help (may not exist): OEPYTHON

Elements

ID	UI Name	Type	Parameters	Cycle
OEPYTHON_FRAME	FrameDependent	BOOL
OEPYTHON_RESET	ResetonFrame0	BOOL
OEPYTHON_MODE	Mode	LONG	FIT_H	OEPYTHON_MODE_PARAMETERS ParameterControl OEPYTHON_MODE_FULLCONTROL FullControl
OEPYTHON_STRING	Code	STRING	CUSTOMGUI MULTISTRING PYTHON
OEPYTHON_OPENEDITOR	OpenPythonEditor	BUTTON

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.Oepython)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.OEPYTHON_FRAME] = True
    obj[c4d.OEPYTHON_RESET] = True
    obj[c4d.OEPYTHON_MODE] = c4d.OEPYTHON_MODE_PARAMETERS
    obj[c4d.OEPYTHON_STRING] = "Hello World"
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.OEPYTHON_FRAME,True)
    bc.SetBool(c4d.OEPYTHON_RESET,True)
    bc.SetInt32(c4d.OEPYTHON_MODE,c4d.OEPYTHON_MODE_PARAMETERS)
    bc.SetString(c4d.OEPYTHON_STRING,"Hello World")

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../python/description/oepython.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Oepython);
    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(OEPYTHON_FRAME),GeData(true),flags);
    pObject->SetParameter(DescID(OEPYTHON_RESET),GeData(true),flags);
    pObject->SetParameter(DescID(OEPYTHON_MODE),GeData(OEPYTHON_MODE_PARAMETERS),flags);
    pObject->SetParameter(DescID(OEPYTHON_STRING),GeData("Hello World"),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(OEPYTHON_FRAME,true);
    bc->SetBool(OEPYTHON_RESET,true);
    bc->SetInt32(OEPYTHON_MODE,OEPYTHON_MODE_PARAMETERS);
    bc->SetString(OEPYTHON_STRING,"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.OEPYTHON_OPENEDITOR)

C++

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