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 Ocasurfacedeformer

Ocasurfacedeformer

Attributes

  • ENGLISH NAME : SurfaceDeformer
  • NAME : Ocasurfacedeformer
  • INCLUDE : Obase
  • PATH : ca/description/ocasurfacedeformer.res
  • PLUGIN : ca
  • MAXON online help (may not exist): OCASURFACEDEFORMER

Elements

ID UI Name Type Parameters Cycle
ID_CA_SURFACE_DEFORMER_OBJECT_TYPE Type LONG  
ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_PROJECTION Projection
ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_MAPPING_UV Mapping(U,V)
ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_MAPPING_VU Mapping(V,U)
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE Plane LONG  
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_XY XY
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_YZ YZ
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_XZ XZ
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_U U REAL
UNIT PERCENT
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_V V REAL
UNIT PERCENT
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
ID_CA_SURFACE_DEFORMER_OBJECT_MAP_SCALE Scale VECTOR STEP
ID_CA_SURFACE_DEFORMER_OBJECT_INITIAL Initialize BUTTON  
ID_CA_SURFACE_DEFORMER_OBJECT_RESTORE Restore BUTTON  
ID_CA_SURFACE_DEFORMER_OBJECT_STRENGTH Strength REAL
UNIT PERCENT
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
ID_CA_SURFACE_DEFORMER_OBJECT_OFFSET Offset REAL
UNIT METER
MINSLIDER 0.0
MAXSLIDER 500.0
CUSTOMGUI REALSLIDER
ID_CA_SURFACE_DEFORMER_OBJECT_AREA Proportional BOOL  
ID_CA_SURFACE_DEFORMER_OBJECT_CAGE Surface LINK  

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.Ocasurfacedeformer)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_TYPE] = c4d.ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_PROJECTION
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE] = c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_XY
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_U] = 0.1
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_V] = 0.1
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_SCALE] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_STRENGTH] = 0.1
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_OFFSET] = 0.1
    obj[c4d.ID_CA_SURFACE_DEFORMER_OBJECT_AREA] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetInt32(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_TYPE,c4d.ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_PROJECTION)
    bc.SetInt32(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE,c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_XY)
    bc.SetFloat(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_U,0.1)
    bc.SetFloat(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_V,0.1)
    bc.SetVector(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_MAP_SCALE, c4d.Vector(1.0,1.0,1.0)
    bc.SetFloat(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_STRENGTH,0.1)
    bc.SetFloat(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_OFFSET,0.1)
    bc.SetBool(c4d.ID_CA_SURFACE_DEFORMER_OBJECT_AREA,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../ca/description/ocasurfacedeformer.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ocasurfacedeformer);
    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(ID_CA_SURFACE_DEFORMER_OBJECT_TYPE),GeData(ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_PROJECTION),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE),GeData(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_XY),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_U),GeData(0.1),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_V),GeData(0.1),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_SCALE),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_STRENGTH),GeData(0.1),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_OFFSET),GeData(0.1),flags);
    pObject->SetParameter(DescID(ID_CA_SURFACE_DEFORMER_OBJECT_AREA),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetInt32(ID_CA_SURFACE_DEFORMER_OBJECT_TYPE,ID_CA_SURFACE_DEFORMER_OBJECT_TYPE_PROJECTION);
    bc->SetInt32(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE,ID_CA_SURFACE_DEFORMER_OBJECT_MAP_PLANE_XY);
    bc->SetFloat(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_U,0.1);
    bc->SetFloat(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_V,0.1);
    bc->SetVector(ID_CA_SURFACE_DEFORMER_OBJECT_MAP_SCALE, c4d.Vector(1.0,1.0,1.0);
    bc->SetFloat(ID_CA_SURFACE_DEFORMER_OBJECT_STRENGTH,0.1);
    bc->SetFloat(ID_CA_SURFACE_DEFORMER_OBJECT_OFFSET,0.1);
    bc->SetBool(ID_CA_SURFACE_DEFORMER_OBJECT_AREA,true);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.ID_CA_SURFACE_DEFORMER_OBJECT_INITIAL)
c4d.CallButton(obj,c4d.ID_CA_SURFACE_DEFORMER_OBJECT_RESTORE)

C++

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

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