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 Ovolumebuilder

Ovolumebuilder

Attributes

  • ENGLISH NAME : VolumeBuilder
  • NAME : Ovolumebuilder
  • INCLUDE : Obase
  • PATH : volumes/description/ovolumebuilder.res
  • PLUGIN : volumes
  • MAXON online help (may not exist): OVOLUMEBUILDER

Elements

ID UI Name Type Parameters Cycle
ID_VOLUMEBUILDER_VOLUMETYPE VolumeType LONG  
ID_VOLUMEBUILDER_SDF SignedDistanceField
ID_VOLUMEBUILDER_FOG Fog
ID_VOLUMEBUILDER_VECTOR Vector
ID_VOLUMEBUILDER_GRID_SIZE VoxelSize REAL
MIN 0.001
STEP 0.1
UNIT METER
PARENTCOLLAPSE
ID_VOLUMEBUILDER_HALF_BAND_MESH_INTERIOR InteriorVoxelRange LONG
PARENTCOLLAPSE ID_VOLUMEBUILDER_GRID_SIZE
MIN 1
STEP 1
ID_VOLUMEBUILDER_HALF_BAND_MESH_EXTERIOR ExteriorVoxelRange LONG
PARENTCOLLAPSE ID_VOLUMEBUILDER_GRID_SIZE
MIN 1
STEP 1
ID_VOLUMEBUILDER_HALF_BAND_SPLINE SplineVoxelRange LONG
PARENTCOLLAPSE ID_VOLUMEBUILDER_GRID_SIZE
MIN 1
STEP 1
ID_VOLUMEBUILDER_HALF_BAND_PARTICLE ParticleVoxelRange LONG
PARENTCOLLAPSE ID_VOLUMEBUILDER_GRID_SIZE
MIN 1
STEP 1
ID_VOLUMEBUILDER_OBJECT_LIST Objects ITEMTREE
ANIM ON
NEWLINE
HEADERS
MULTIPLE
COLUMNS 6
CHECKBOX
FOLDERS
DRAGDROP
ICON
NO_MENU
ID_VOLUMEBUILDER_ADDMISCBUTTON LONG ANIM
ID_VOLUMEBUILDER_FILTER_UI_LINK LINK CUSTOMGUI
ID_VOLUMEBUILDER_GRID_MATRIX_OVERRIDE OverrideGridMatrix LINK  
ID_VOLUMEBUILDER_MATCH_GRID_BUTTON MatchVoxelSize BUTTON NAME
ID_VOLUMEBUILDER_AUTOUPDATE AutoUpdateSettings BOOL NAME
ID_VOLUMEBUILDER_UPDATEBUTTON Update BUTTON NAME

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.Ovolumebuilder)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.ID_VOLUMEBUILDER_VOLUMETYPE] = c4d.ID_VOLUMEBUILDER_SDF
    obj[c4d.ID_VOLUMEBUILDER_GRID_SIZE] = 0.1
    obj[c4d.ID_VOLUMEBUILDER_HALF_BAND_MESH_INTERIOR] = 1
    obj[c4d.ID_VOLUMEBUILDER_HALF_BAND_MESH_EXTERIOR] = 1
    obj[c4d.ID_VOLUMEBUILDER_HALF_BAND_SPLINE] = 1
    obj[c4d.ID_VOLUMEBUILDER_HALF_BAND_PARTICLE] = 1
    obj[c4d.ID_VOLUMEBUILDER_ADDMISCBUTTON] = 1
    obj[c4d.ID_VOLUMEBUILDER_AUTOUPDATE] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetInt32(c4d.ID_VOLUMEBUILDER_VOLUMETYPE,c4d.ID_VOLUMEBUILDER_SDF)
    bc.SetFloat(c4d.ID_VOLUMEBUILDER_GRID_SIZE,0.1)
    bc.SetInt32(c4d.ID_VOLUMEBUILDER_HALF_BAND_MESH_INTERIOR,1)
    bc.SetInt32(c4d.ID_VOLUMEBUILDER_HALF_BAND_MESH_EXTERIOR,1)
    bc.SetInt32(c4d.ID_VOLUMEBUILDER_HALF_BAND_SPLINE,1)
    bc.SetInt32(c4d.ID_VOLUMEBUILDER_HALF_BAND_PARTICLE,1)
    bc.SetInt32(c4d.ID_VOLUMEBUILDER_ADDMISCBUTTON,1)
    bc.SetBool(c4d.ID_VOLUMEBUILDER_AUTOUPDATE,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../volumes/description/ovolumebuilder.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ovolumebuilder);
    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_VOLUMEBUILDER_VOLUMETYPE),GeData(ID_VOLUMEBUILDER_SDF),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_GRID_SIZE),GeData(0.1),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_HALF_BAND_MESH_INTERIOR),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_HALF_BAND_MESH_EXTERIOR),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_HALF_BAND_SPLINE),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_HALF_BAND_PARTICLE),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_ADDMISCBUTTON),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMEBUILDER_AUTOUPDATE),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetInt32(ID_VOLUMEBUILDER_VOLUMETYPE,ID_VOLUMEBUILDER_SDF);
    bc->SetFloat(ID_VOLUMEBUILDER_GRID_SIZE,0.1);
    bc->SetInt32(ID_VOLUMEBUILDER_HALF_BAND_MESH_INTERIOR,1);
    bc->SetInt32(ID_VOLUMEBUILDER_HALF_BAND_MESH_EXTERIOR,1);
    bc->SetInt32(ID_VOLUMEBUILDER_HALF_BAND_SPLINE,1);
    bc->SetInt32(ID_VOLUMEBUILDER_HALF_BAND_PARTICLE,1);
    bc->SetInt32(ID_VOLUMEBUILDER_ADDMISCBUTTON,1);
    bc->SetBool(ID_VOLUMEBUILDER_AUTOUPDATE,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_VOLUMEBUILDER_MATCH_GRID_BUTTON)
c4d.CallButton(obj,c4d.ID_VOLUMEBUILDER_UPDATEBUTTON)

C++

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

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