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 Ovolumesequence

Ovolumesequence

Attributes

  • ENGLISH NAME : VolumeLoader
  • NAME : Ovolumesequence
  • INCLUDE : Obase
  • PATH : volumes/description/ovolumesequence.res
  • PLUGIN : volumes
  • MAXON online help (may not exist): OVOLUMESEQUENCE

Elements

ID UI Name Type Parameters Cycle
ID_VOLUMESEQUENCE_PATH Filename FILENAME  
ID_VOLUMESEQUENCE_RELOAD Reload BUTTON NAME
ID_VOLUMESEQUENCE_GRID_LIST VolumeGrids LISTVIEW
NEWLINE
CHECKBOX
ID_VOLUMESEQUENCE_UNIT_SCALE Scale UNITSCALE ANIM
ID_VOLUMESEQUENCE_ANIMATION_ACTIVE UseAnimation BOOL NAME
ID_VOLUMESEQUENCE_FRAME Frame LONG MIN
ID_VOLUMESEQUENCE_FROM From LONG MIN
ID_VOLUMESEQUENCE_TO To LONG MIN
ID_VOLUMESEQUENCE_OFFSET Offset LONG  
ID_VOLUMESEQUENCE_LOOP Loop BOOL NAME
ID_VOLUMESEQUENCE_SCALE Speed REAL
UNIT PERCENT
MIN 0.1

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.Ovolumesequence)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.ID_VOLUMESEQUENCE_PATH] = "c:\\SomeFile.txt"
    obj[c4d.ID_VOLUMESEQUENCE_ANIMATION_ACTIVE] = True
    obj[c4d.ID_VOLUMESEQUENCE_FRAME] = 1
    obj[c4d.ID_VOLUMESEQUENCE_FROM] = 1
    obj[c4d.ID_VOLUMESEQUENCE_TO] = 1
    obj[c4d.ID_VOLUMESEQUENCE_OFFSET] = 1
    obj[c4d.ID_VOLUMESEQUENCE_LOOP] = True
    obj[c4d.ID_VOLUMESEQUENCE_SCALE] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetFileName(c4d.ID_VOLUMESEQUENCE_PATH,"c:\\SomeFile.txt")
    bc.SetBool(c4d.ID_VOLUMESEQUENCE_ANIMATION_ACTIVE,True)
    bc.SetInt32(c4d.ID_VOLUMESEQUENCE_FRAME,1)
    bc.SetInt32(c4d.ID_VOLUMESEQUENCE_FROM,1)
    bc.SetInt32(c4d.ID_VOLUMESEQUENCE_TO,1)
    bc.SetInt32(c4d.ID_VOLUMESEQUENCE_OFFSET,1)
    bc.SetBool(c4d.ID_VOLUMESEQUENCE_LOOP,True)
    bc.SetFloat(c4d.ID_VOLUMESEQUENCE_SCALE,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../volumes/description/ovolumesequence.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ovolumesequence);
    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_VOLUMESEQUENCE_PATH),GeData(Filename("c:\\SomeFile.txt"),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_ANIMATION_ACTIVE),GeData(true),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_FRAME),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_FROM),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_TO),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_OFFSET),GeData(1),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_LOOP),GeData(true),flags);
    pObject->SetParameter(DescID(ID_VOLUMESEQUENCE_SCALE),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetFileName(ID_VOLUMESEQUENCE_PATH,"c:\\SomeFile.txt");
    bc->SetBool(ID_VOLUMESEQUENCE_ANIMATION_ACTIVE,true);
    bc->SetInt32(ID_VOLUMESEQUENCE_FRAME,1);
    bc->SetInt32(ID_VOLUMESEQUENCE_FROM,1);
    bc->SetInt32(ID_VOLUMESEQUENCE_TO,1);
    bc->SetInt32(ID_VOLUMESEQUENCE_OFFSET,1);
    bc->SetBool(ID_VOLUMESEQUENCE_LOOP,true);
    bc->SetFloat(ID_VOLUMESEQUENCE_SCALE,0.1);
    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_VOLUMESEQUENCE_RELOAD)

C++

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