IDs and information for Ovolumeset

Ovolumeset

Attributes

• ENGLISH NAME : VolumeSet
• NAME : Ovolumeset
• INCLUDE : Obase
• PATH : volumes/description/ovolumeset.res
• PLUGIN : volumes
• MAXON online help (may not exist): OVOLUMESET

Elements

ID	UI Name	Type	Parameters	Cycle
ID_VOLUMESET_PATH	Filepath	FILENAME
ID_VOLUMESET_SAVE	Save	BUTTON	NAME
ID_VOLUMESET_RELOAD	Reload	BUTTON	NAME
ID_VOLUMESET_VOLUMESLIST	VolumeGrids	ITEMTREE	NEWLINE SCALE_H LIST MULTIPLE COLUMNS 2 CHECKBOX ICON DRAGDROP NO_MENU
ID_VOLUMESET_DETACH	Detach	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.Ovolumeset)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.ID_VOLUMESET_PATH] = "c:\\SomeFile.txt"
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetFileName(c4d.ID_VOLUMESET_PATH,"c:\\SomeFile.txt")

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../volumes/description/ovolumeset.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ovolumeset);
    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_VOLUMESET_PATH),GeData(Filename("c:\\SomeFile.txt"),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetFileName(ID_VOLUMESET_PATH,"c:\\SomeFile.txt");
    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_VOLUMESET_SAVE)
c4d.CallButton(obj,c4d.ID_VOLUMESET_RELOAD)
c4d.CallButton(obj,c4d.ID_VOLUMESET_DETACH)

C++

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


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


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