IDs and information for Omshader

Omshader

Attributes

• ENGLISH NAME : X-ParticlesSpriteShaderModifier
• NAME : Omshader
• INCLUDE : Obase
• PATH : res/description/omshader.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMSHADER

Elements

ID	UI Name	Type	Parameters	Cycle
XMSH_SHADER_ENABLED	Enabled	BOOL
XMSH_SHADER_MODE	Mode	LONG		SHADER_MODE_INDEP Independent SHADER_MODE_ACTION Action-Controlled
XMSH_SHADER_COLORMODE	ColorMode	LONG		COLOR_MODE_GREYSCALE Greyscale COLOR_MODE_COLOR RGB
XMSH_SHADER_GREYSCALE_DELTA	GreyscaleRateofChange	REAL	UNIT PERCENT STEP 0.1 MIN -100.0 MAX 100.0 MINSLIDER -10.0 MAXSLIDER 10.0 CUSTOMGUI REALSLIDER
XMSH_SHADER_COLOR_REDDELTA	RedRateofChange	REAL	UNIT PERCENT STEP 0.1 MIN -100.0 MAX 100.0 MINSLIDER -10.0 MAXSLIDER 10.0 CUSTOMGUI REALSLIDER
XMSH_SHADER_COLOR_GREENDELTA	GreenRateofChange	REAL	UNIT PERCENT STEP 0.1 MIN -100.0 MAX 100.0 MINSLIDER -10.0 MAXSLIDER 10.0 CUSTOMGUI REALSLIDER
XMSH_SHADER_COLOR_BLUEDELTA	BlueRateofChange	REAL	UNIT PERCENT STEP 0.1 MIN -100.0 MAX 100.0 MINSLIDER -10.0 MAXSLIDER 10.0 CUSTOMGUI REALSLIDER
XMSH_SHADER_CLAMP	ClampTo	COLOR
XMSH_SHADER_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.Omshader)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMSH_SHADER_ENABLED] = True
    obj[c4d.XMSH_SHADER_MODE] = c4d.SHADER_MODE_INDEP
    obj[c4d.XMSH_SHADER_COLORMODE] = c4d.COLOR_MODE_GREYSCALE
    obj[c4d.XMSH_SHADER_GREYSCALE_DELTA] = 0.1
    obj[c4d.XMSH_SHADER_COLOR_REDDELTA] = 0.1
    obj[c4d.XMSH_SHADER_COLOR_GREENDELTA] = 0.1
    obj[c4d.XMSH_SHADER_COLOR_BLUEDELTA] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMSH_SHADER_ENABLED,True)
    bc.SetInt32(c4d.XMSH_SHADER_MODE,c4d.SHADER_MODE_INDEP)
    bc.SetInt32(c4d.XMSH_SHADER_COLORMODE,c4d.COLOR_MODE_GREYSCALE)
    bc.SetFloat(c4d.XMSH_SHADER_GREYSCALE_DELTA,0.1)
    bc.SetFloat(c4d.XMSH_SHADER_COLOR_REDDELTA,0.1)
    bc.SetFloat(c4d.XMSH_SHADER_COLOR_GREENDELTA,0.1)
    bc.SetFloat(c4d.XMSH_SHADER_COLOR_BLUEDELTA,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omshader.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omshader);
    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(XMSH_SHADER_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMSH_SHADER_MODE),GeData(SHADER_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMSH_SHADER_COLORMODE),GeData(COLOR_MODE_GREYSCALE),flags);
    pObject->SetParameter(DescID(XMSH_SHADER_GREYSCALE_DELTA),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSH_SHADER_COLOR_REDDELTA),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSH_SHADER_COLOR_GREENDELTA),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSH_SHADER_COLOR_BLUEDELTA),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMSH_SHADER_ENABLED,true);
    bc->SetInt32(XMSH_SHADER_MODE,SHADER_MODE_INDEP);
    bc->SetInt32(XMSH_SHADER_COLORMODE,COLOR_MODE_GREYSCALE);
    bc->SetFloat(XMSH_SHADER_GREYSCALE_DELTA,0.1);
    bc->SetFloat(XMSH_SHADER_COLOR_REDDELTA,0.1);
    bc->SetFloat(XMSH_SHADER_COLOR_GREENDELTA,0.1);
    bc->SetFloat(XMSH_SHADER_COLOR_BLUEDELTA,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}