IDs and information for Omsurface

Omsurface

Attributes

• ENGLISH NAME : X-ParticlesFollowSurfaceModifier
• NAME : Omsurface
• INCLUDE : Obase
• PATH : res/description/omsurface.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMSURFACE

Elements

ID	UI Name	Type	Parameters	Cycle
XMMOS_ENABLED	Enabled	BOOL	SCALE_H
XMMOS_MODE	Mode	LONG	SCALE_H	MMOS_MODE_INDEP Independent MMOS_MODE_ACTION Action-Controlled
XMMOS_OBJECTS	Objects	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
XMMOS_PULL	Pull	REAL	UNIT PERCENT MIN 0.0 MAX 100.0 CUSTOMGUI REALSLIDER
XMMOS_PULL_VAR	Variation	REAL	UNIT PERCENT MIN 0.0 MAX 100.0 CUSTOMGUI REALSLIDER
XMMOS_OFFSET	Offset	REAL	UNIT METER MINSLIDER -100.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
XMMOS_OFFSET_VAR	Variation	REAL	UNIT METER MINSLIDER -100.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
XMMOS_DISTANCE	Distance	REAL	UNIT METER MIN 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XMMOS_FRICTION	Friction	REAL	UNIT PERCENT MIN 0.0 MAX 100.0 CUSTOMGUI REALSLIDER
XMMOS_SUBSTEP	Accurate	BOOL
XMMOS_ACTIONLIST	ActionsonCapture	IN_EXCLUDE	NUM_FLAGS
XMMOS_ADDACTION	AddAction	BUTTON
XMMOS_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.Omsurface)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMMOS_ENABLED] = True
    obj[c4d.XMMOS_MODE] = c4d.MMOS_MODE_INDEP
    obj[c4d.XMMOS_PULL] = 0.1
    obj[c4d.XMMOS_PULL_VAR] = 0.1
    obj[c4d.XMMOS_OFFSET] = 0.1
    obj[c4d.XMMOS_OFFSET_VAR] = 0.1
    obj[c4d.XMMOS_DISTANCE] = 0.1
    obj[c4d.XMMOS_FRICTION] = 0.1
    obj[c4d.XMMOS_SUBSTEP] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMMOS_ENABLED,True)
    bc.SetInt32(c4d.XMMOS_MODE,c4d.MMOS_MODE_INDEP)
    bc.SetFloat(c4d.XMMOS_PULL,0.1)
    bc.SetFloat(c4d.XMMOS_PULL_VAR,0.1)
    bc.SetFloat(c4d.XMMOS_OFFSET,0.1)
    bc.SetFloat(c4d.XMMOS_OFFSET_VAR,0.1)
    bc.SetFloat(c4d.XMMOS_DISTANCE,0.1)
    bc.SetFloat(c4d.XMMOS_FRICTION,0.1)
    bc.SetBool(c4d.XMMOS_SUBSTEP,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omsurface.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omsurface);
    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(XMMOS_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMMOS_MODE),GeData(MMOS_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMMOS_PULL),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMMOS_PULL_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMMOS_OFFSET),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMMOS_OFFSET_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMMOS_DISTANCE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMMOS_FRICTION),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMMOS_SUBSTEP),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMMOS_ENABLED,true);
    bc->SetInt32(XMMOS_MODE,MMOS_MODE_INDEP);
    bc->SetFloat(XMMOS_PULL,0.1);
    bc->SetFloat(XMMOS_PULL_VAR,0.1);
    bc->SetFloat(XMMOS_OFFSET,0.1);
    bc->SetFloat(XMMOS_OFFSET_VAR,0.1);
    bc->SetFloat(XMMOS_DISTANCE,0.1);
    bc->SetFloat(XMMOS_FRICTION,0.1);
    bc->SetBool(XMMOS_SUBSTEP,true);
    pObject->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(obj,c4d.XMMOS_ADDACTION)

C++

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