IDs and information for Omkill

Omkill

Attributes

• ENGLISH NAME : X-ParticlesKillModifier
• NAME : Omkill
• INCLUDE : Obase
• PATH : res/description/omkill.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMKILL

Elements

ID	UI Name	Type	Parameters	Cycle
XMKI_KILL_ENABLED	Enabled	BOOL
XMKI_KILL_MODE	Mode	LONG		KILL_MODE_INDEP Independent KILL_MODE_ACTION Action-Controlled
XMKI_KILL_TYPE	Volume	LONG		XMKI_KILL_TYPE_BOX_IN InsideBounds XMKI_KILL_TYPE_BOX_OUT OutsideBounds XMKI_KILL_TYPE_OBJECTS Objects XMKI_KILL_TYPE_FOV OutsideCameraFOV
XMKI_KILL_SHAPE	Shape	LONG		XMKI_KILL_SHAPE_BOX Box XMKI_KILL_SHAPE_SPHERE Sphere
XMKI_KILL_SIZE	Size	VECTOR	UNIT
XMKI_KILL_RADIUS	Radius	REAL	UNIT METER MIN 0.0 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XMKI_KILL_OBJECTS	Objects	IN_EXCLUDE	NUM_FLAGS 3 INIT_STATE 7 SEND_SELCHNGMSG 1 SCALE_V IMAGE_01_ON 1009316 IMAGE_01_OFF 1009320 IMAGE_02_ON 300000231 IMAGE_02_OFF 300000230 IMAGE_03_ON 1034541 IMAGE_03_OFF 1034540
XMKI_KILL_GROUP	Groups	IN_EXCLUDE	NUM_FLAGS 2 INIT_STATE 3 SEND_SELCHNGMSG 1 SCALE_V IMAGE_01_ON 1009316 IMAGE_01_OFF 1009320 IMAGE_02_ON 300000231 IMAGE_02_OFF 300000230

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.Omkill)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMKI_KILL_ENABLED] = True
    obj[c4d.XMKI_KILL_MODE] = c4d.KILL_MODE_INDEP
    obj[c4d.XMKI_KILL_TYPE] = c4d.XMKI_KILL_TYPE_BOX_IN
    obj[c4d.XMKI_KILL_SHAPE] = c4d.XMKI_KILL_SHAPE_BOX
    obj[c4d.XMKI_KILL_SIZE] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMKI_KILL_RADIUS] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMKI_KILL_ENABLED,True)
    bc.SetInt32(c4d.XMKI_KILL_MODE,c4d.KILL_MODE_INDEP)
    bc.SetInt32(c4d.XMKI_KILL_TYPE,c4d.XMKI_KILL_TYPE_BOX_IN)
    bc.SetInt32(c4d.XMKI_KILL_SHAPE,c4d.XMKI_KILL_SHAPE_BOX)
    bc.SetVector(c4d.XMKI_KILL_SIZE, c4d.Vector(1.0,1.0,1.0)
    bc.SetFloat(c4d.XMKI_KILL_RADIUS,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omkill.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omkill);
    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(XMKI_KILL_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMKI_KILL_MODE),GeData(KILL_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMKI_KILL_TYPE),GeData(XMKI_KILL_TYPE_BOX_IN),flags);
    pObject->SetParameter(DescID(XMKI_KILL_SHAPE),GeData(XMKI_KILL_SHAPE_BOX),flags);
    pObject->SetParameter(DescID(XMKI_KILL_SIZE),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMKI_KILL_RADIUS),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMKI_KILL_ENABLED,true);
    bc->SetInt32(XMKI_KILL_MODE,KILL_MODE_INDEP);
    bc->SetInt32(XMKI_KILL_TYPE,XMKI_KILL_TYPE_BOX_IN);
    bc->SetInt32(XMKI_KILL_SHAPE,XMKI_KILL_SHAPE_BOX);
    bc->SetVector(XMKI_KILL_SIZE, c4d.Vector(1.0,1.0,1.0);
    bc->SetFloat(XMKI_KILL_RADIUS,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}