IDs and information for Oformula

Oformula

Attributes

• ENGLISH NAME : FormulaObject
• NAME : Oformula
• INCLUDE : Obase
• PATH : objects/description/oformula.res
• PLUGIN : objects
• MAXON online help (may not exist): OFORMULA

Elements

ID	UI Name	Type	Parameters	Cycle
FORMULAOBJECT_SIZE	Size	VECTOR	UNIT METER MIN 0.0
FORMULAOBJECT_EFFECT	Effect	LONG		FOEFFECT_MANUAL Manual FOEFFECT_SPHERICAL Spherical FOEFFECT_CYLINDRICAL Cylindrical FOEFFECT_XRADIAL XRadial FOEFFECT_YRADIAL YRadial FOEFFECT_ZRADIAL ZRadial
FORMULAOBJECT_DLT	d(u,v,x,y,z,t)	STRING
FORMULAOBJECT_FX	X(x,y,z,t)	STRING
FORMULAOBJECT_FY	Y(x,y,z,t)	STRING
FORMULAOBJECT_FZ	Z(x,y,z,t)	STRING
FORMULAOBJECT_FITTOPARENT	FittoParent	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.Oformula)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.FORMULAOBJECT_SIZE] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.FORMULAOBJECT_EFFECT] = c4d.FOEFFECT_MANUAL
    obj[c4d.FORMULAOBJECT_DLT] = "Hello World"
    obj[c4d.FORMULAOBJECT_FX] = "Hello World"
    obj[c4d.FORMULAOBJECT_FY] = "Hello World"
    obj[c4d.FORMULAOBJECT_FZ] = "Hello World"
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetVector(c4d.FORMULAOBJECT_SIZE, c4d.Vector(1.0,1.0,1.0)
    bc.SetInt32(c4d.FORMULAOBJECT_EFFECT,c4d.FOEFFECT_MANUAL)
    bc.SetString(c4d.FORMULAOBJECT_DLT,"Hello World")
    bc.SetString(c4d.FORMULAOBJECT_FX,"Hello World")
    bc.SetString(c4d.FORMULAOBJECT_FY,"Hello World")
    bc.SetString(c4d.FORMULAOBJECT_FZ,"Hello World")

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../objects/description/oformula.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Oformula);
    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(FORMULAOBJECT_SIZE),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(FORMULAOBJECT_EFFECT),GeData(FOEFFECT_MANUAL),flags);
    pObject->SetParameter(DescID(FORMULAOBJECT_DLT),GeData("Hello World"),flags);
    pObject->SetParameter(DescID(FORMULAOBJECT_FX),GeData("Hello World"),flags);
    pObject->SetParameter(DescID(FORMULAOBJECT_FY),GeData("Hello World"),flags);
    pObject->SetParameter(DescID(FORMULAOBJECT_FZ),GeData("Hello World"),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetVector(FORMULAOBJECT_SIZE, c4d.Vector(1.0,1.0,1.0);
    bc->SetInt32(FORMULAOBJECT_EFFECT,FOEFFECT_MANUAL);
    bc->SetString(FORMULAOBJECT_DLT,"Hello World");
    bc->SetString(FORMULAOBJECT_FX,"Hello World");
    bc->SetString(FORMULAOBJECT_FY,"Hello World");
    bc->SetString(FORMULAOBJECT_FZ,"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.FORMULAOBJECT_FITTOPARENT)

C++

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