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 Onull

Onull

Attributes

  • ENGLISH NAME : Null
  • NAME : Onull
  • INCLUDE : Obase
  • PATH : c4dplugin/description/onull.res
  • PLUGIN : c4dplugin
  • MAXON online help (may not exist): ONULL

Elements

ID UI Name Type Parameters Cycle
NULLOBJECT_DISPLAY Shape LONG  
NULLOBJECT_DISPLAY_NONE None
NULLOBJECT_DISPLAY_DOT Dot
NULLOBJECT_DISPLAY_POINT Locator
NULLOBJECT_DISPLAY_CIRCLE Circle
NULLOBJECT_DISPLAY_RECTANGLE Rectangle
NULLOBJECT_DISPLAY_DIAMOND Diamond
NULLOBJECT_DISPLAY_TRIANGLE Triangle
NULLOBJECT_DISPLAY_PENTAGON Pentagon
NULLOBJECT_DISPLAY_HEXAGON Hexagon
NULLOBJECT_DISPLAY_OCTAGON Octagon
NULLOBJECT_DISPLAY_STAR Star
NULLOBJECT_DISPLAY_AXIS Axis
NULLOBJECT_DISPLAY_CUBE Cube
NULLOBJECT_DISPLAY_PYRAMID Pyramid
NULLOBJECT_DISPLAY_SPHERE Sphere
NULLOBJECT_RADIUS Radius REAL
UNIT METER
MIN 0.0
NULLOBJECT_ASPECTRATIO AspectRatio REAL
MIN 0.0
STEP 0.01
NULLOBJECT_ORIENTATION Orientation LONG  
NULLOBJECT_ORIENTATION_SCREEN Camera
NULLOBJECT_ORIENTATION_ZY X
NULLOBJECT_ORIENTATION_XZ Y
NULLOBJECT_ORIENTATION_XY Z

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.Onull)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.NULLOBJECT_DISPLAY] = c4d.NULLOBJECT_DISPLAY_NONE
    obj[c4d.NULLOBJECT_RADIUS] = 0.1
    obj[c4d.NULLOBJECT_ASPECTRATIO] = 0.1
    obj[c4d.NULLOBJECT_ORIENTATION] = c4d.NULLOBJECT_ORIENTATION_SCREEN
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetInt32(c4d.NULLOBJECT_DISPLAY,c4d.NULLOBJECT_DISPLAY_NONE)
    bc.SetFloat(c4d.NULLOBJECT_RADIUS,0.1)
    bc.SetFloat(c4d.NULLOBJECT_ASPECTRATIO,0.1)
    bc.SetInt32(c4d.NULLOBJECT_ORIENTATION,c4d.NULLOBJECT_ORIENTATION_SCREEN)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../c4dplugin/description/onull.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Onull);
    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(NULLOBJECT_DISPLAY),GeData(NULLOBJECT_DISPLAY_NONE),flags);
    pObject->SetParameter(DescID(NULLOBJECT_RADIUS),GeData(0.1),flags);
    pObject->SetParameter(DescID(NULLOBJECT_ASPECTRATIO),GeData(0.1),flags);
    pObject->SetParameter(DescID(NULLOBJECT_ORIENTATION),GeData(NULLOBJECT_ORIENTATION_SCREEN),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetInt32(NULLOBJECT_DISPLAY,NULLOBJECT_DISPLAY_NONE);
    bc->SetFloat(NULLOBJECT_RADIUS,0.1);
    bc->SetFloat(NULLOBJECT_ASPECTRATIO,0.1);
    bc->SetInt32(NULLOBJECT_ORIENTATION,NULLOBJECT_ORIENTATION_SCREEN);
    pObject->Message(MSG_UPDATE);                                                      
}