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 Oinstance

Oinstance

Attributes

  • ENGLISH NAME : InstanceObject
  • NAME : Oinstance
  • INCLUDE : Obase
  • PATH : objects/description/oinstance.res
  • PLUGIN : objects
  • MAXON online help (may not exist): OINSTANCE

Elements

ID UI Name Type Parameters Cycle
INSTANCEOBJECT_LINK ReferenceObject LINK  
INSTANCEOBJECT_RENDERINSTANCE_MODE InstanceMode LONG  
INSTANCEOBJECT_RENDERINSTANCE_MODE_NONE Instance
INSTANCEOBJECT_RENDERINSTANCE_MODE_SINGLEINSTANCE RenderInstance
INSTANCEOBJECT_RENDERINSTANCE_MODE_MULTIINSTANCE Multi-Instance
INSTANCEOBJECT_MULTIPOSITIONINPUT PositionsSource LINK  
INSTANCEOBJECT_DRAW_MODE ViewportMode LONG ANIM
INSTANCEOBJECT_DRAW_MODE_NONE Off
INSTANCEOBJECT_DRAW_MODE_POINTS Points
INSTANCEOBJECT_DRAW_MODE_CUBE Matrix
INSTANCEOBJECT_DRAW_MODE_BBOX BoundingBox
INSTANCEOBJECT_DRAW_MODE_FULL Object
INSTANCEOBJECT_SWAP SwapwithReference 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.Oinstance)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.INSTANCEOBJECT_RENDERINSTANCE_MODE] = c4d.INSTANCEOBJECT_RENDERINSTANCE_MODE_NONE
    obj[c4d.INSTANCEOBJECT_DRAW_MODE] = c4d.INSTANCEOBJECT_DRAW_MODE_NONE
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetInt32(c4d.INSTANCEOBJECT_RENDERINSTANCE_MODE,c4d.INSTANCEOBJECT_RENDERINSTANCE_MODE_NONE)
    bc.SetInt32(c4d.INSTANCEOBJECT_DRAW_MODE,c4d.INSTANCEOBJECT_DRAW_MODE_NONE)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../objects/description/oinstance.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Oinstance);
    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(INSTANCEOBJECT_RENDERINSTANCE_MODE),GeData(INSTANCEOBJECT_RENDERINSTANCE_MODE_NONE),flags);
    pObject->SetParameter(DescID(INSTANCEOBJECT_DRAW_MODE),GeData(INSTANCEOBJECT_DRAW_MODE_NONE),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetInt32(INSTANCEOBJECT_RENDERINSTANCE_MODE,INSTANCEOBJECT_RENDERINSTANCE_MODE_NONE);
    bc->SetInt32(INSTANCEOBJECT_DRAW_MODE,INSTANCEOBJECT_DRAW_MODE_NONE);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.INSTANCEOBJECT_SWAP)

C++

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