IDs and information for Omlight

Omlight

Attributes

• ENGLISH NAME : X-ParticlesLightModifier
• NAME : Omlight
• INCLUDE : Obase
• PATH : res/description/omlight.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMLIGHT

Elements

ID	UI Name	Type	Parameters	Cycle
XMLG_LIGHT_ENABLED	Enabled	BOOL
XMLG_LIGHT_MODE	Mode	LONG		LIGHT_MODE_INDEP Independent LIGHT_MODE_ACTION Action-Controlled
XMLG_LIGHT_MOD_MODE	SplineTiming	LONG		LIGHT_MOD_MODE_AGE ParticleAge LIGHT_MOD_MODE_STEPS StepCount
XMLG_LIGHT_MOD_STEPCOUNT	Steps	LONG	MIN 1 MINSLIDER 1 MAXSLIDER 300 CUSTOMGUI LONGSLIDER
XMLG_LIGHT_ILLUMBRIGHT_CHANGE	Change	BOOL
XMLG_LIGHT_ILLUMBRIGHT_SPLINE	Brightness	SPLINE	X_MIN 0.0 X_MAX 1.0 Y_MIN 0.0 Y_MAX 200.0 X_STEPS 1.0 Y_STEPS 1.0
XMLG_LIGHT_ILLUMBRIGHT_YMAX	SplineMax	REAL	MIN 0.0 STEP 0.01 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XMLG_LIGHT_VISBRIGHT_CHANGE	Change	BOOL
XMLG_LIGHT_VISBRIGHT_SPLINE	Brightness	SPLINE	X_MIN 0.0 X_MAX 1.0 Y_MIN 0.0 Y_MAX 200.0 X_STEPS 1.0 Y_STEPS 1.0
XMLG_LIGHT_VISBRIGHT_YMAX	SplineMax.	REAL	MIN 0.0 STEP 0.01 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XMLG_LIGHT_INDIST_CHANGE	Change	BOOL
XMLG_LIGHT_INDIST_SPLINE	InnerDistance	SPLINE	X_MIN 0.0 X_MAX 1.0 Y_MIN 0.0 Y_MAX 100.0 X_STEPS 1.0 Y_STEPS 1.0
XMLG_LIGHT_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.Omlight)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMLG_LIGHT_ENABLED] = True
    obj[c4d.XMLG_LIGHT_MODE] = c4d.LIGHT_MODE_INDEP
    obj[c4d.XMLG_LIGHT_MOD_MODE] = c4d.LIGHT_MOD_MODE_AGE
    obj[c4d.XMLG_LIGHT_MOD_STEPCOUNT] = 1
    obj[c4d.XMLG_LIGHT_ILLUMBRIGHT_CHANGE] = True
    obj[c4d.XMLG_LIGHT_ILLUMBRIGHT_YMAX] = 0.1
    obj[c4d.XMLG_LIGHT_VISBRIGHT_CHANGE] = True
    obj[c4d.XMLG_LIGHT_VISBRIGHT_YMAX] = 0.1
    obj[c4d.XMLG_LIGHT_INDIST_CHANGE] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMLG_LIGHT_ENABLED,True)
    bc.SetInt32(c4d.XMLG_LIGHT_MODE,c4d.LIGHT_MODE_INDEP)
    bc.SetInt32(c4d.XMLG_LIGHT_MOD_MODE,c4d.LIGHT_MOD_MODE_AGE)
    bc.SetInt32(c4d.XMLG_LIGHT_MOD_STEPCOUNT,1)
    bc.SetBool(c4d.XMLG_LIGHT_ILLUMBRIGHT_CHANGE,True)
    bc.SetFloat(c4d.XMLG_LIGHT_ILLUMBRIGHT_YMAX,0.1)
    bc.SetBool(c4d.XMLG_LIGHT_VISBRIGHT_CHANGE,True)
    bc.SetFloat(c4d.XMLG_LIGHT_VISBRIGHT_YMAX,0.1)
    bc.SetBool(c4d.XMLG_LIGHT_INDIST_CHANGE,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omlight.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omlight);
    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(XMLG_LIGHT_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_MODE),GeData(LIGHT_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_MOD_MODE),GeData(LIGHT_MOD_MODE_AGE),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_MOD_STEPCOUNT),GeData(1),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_ILLUMBRIGHT_CHANGE),GeData(true),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_ILLUMBRIGHT_YMAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_VISBRIGHT_CHANGE),GeData(true),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_VISBRIGHT_YMAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMLG_LIGHT_INDIST_CHANGE),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMLG_LIGHT_ENABLED,true);
    bc->SetInt32(XMLG_LIGHT_MODE,LIGHT_MODE_INDEP);
    bc->SetInt32(XMLG_LIGHT_MOD_MODE,LIGHT_MOD_MODE_AGE);
    bc->SetInt32(XMLG_LIGHT_MOD_STEPCOUNT,1);
    bc->SetBool(XMLG_LIGHT_ILLUMBRIGHT_CHANGE,true);
    bc->SetFloat(XMLG_LIGHT_ILLUMBRIGHT_YMAX,0.1);
    bc->SetBool(XMLG_LIGHT_VISBRIGHT_CHANGE,true);
    bc->SetFloat(XMLG_LIGHT_VISBRIGHT_YMAX,0.1);
    bc->SetBool(XMLG_LIGHT_INDIST_CHANGE,true);
    pObject->Message(MSG_UPDATE);                                                      
}