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 Fpython

Fpython

Attributes

  • ENGLISH NAME : PythonField
  • NAME : Fpython
  • INCLUDE : Ofield
  • PATH : python/description/fpython.res
  • PLUGIN : python
  • MAXON online help (may not exist): FPYTHON

Elements

ID UI Name Type Parameters Cycle
PYTHON_RESETFRAME0 ResetonFrame0 BOOL  
PYTHON_FRAME BOOL HIDDEN
PYTHON_CODE Code STRING
CUSTOMGUI MULTISTRING
PYTHON
SCALE_V
PYTHON_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.Fpython)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.PYTHON_RESETFRAME0] = True
    obj[c4d.PYTHON_FRAME] = True
    obj[c4d.PYTHON_CODE] = "Hello World"
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.PYTHON_RESETFRAME0,True)
    bc.SetBool(c4d.PYTHON_FRAME,True)
    bc.SetString(c4d.PYTHON_CODE,"Hello World")

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../python/description/fpython.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Fpython);
    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(PYTHON_RESETFRAME0),GeData(true),flags);
    pObject->SetParameter(DescID(PYTHON_FRAME),GeData(true),flags);
    pObject->SetParameter(DescID(PYTHON_CODE),GeData("Hello World"),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(PYTHON_RESETFRAME0,true);
    bc->SetBool(PYTHON_FRAME,true);
    bc->SetString(PYTHON_CODE,"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.PYTHON_OPENEDITOR)

C++

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