IDs and information for Omwind

Omwind

Attributes

• ENGLISH NAME : X-ParticlesWindModifier
• NAME : Omwind
• INCLUDE : Obase
• PATH : res/description/omwind.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMWIND

Elements

ID	UI Name	Type	Parameters	Cycle
XWIN_WIND_ENABLED	Enabled	BOOL
XWIN_WIND_MODE	Mode	LONG		WIND_MODE_INDEP Independent WIND_MODE_ACTION Action-Controlled
XWIN_WIND_DRAW	VisibleinEditor	BOOL
XWIN_WIND_VALUE	WindStrength	REAL	UNIT METER STEP 1.0 MINSLIDER -500.0 MAXSLIDER 500.0 CUSTOMGUI REALSLIDER
XWIN_WIND_TURBULENCE	Turbulence	REAL	UNIT PERCENT MIN 0.0 MAX 1000000.0 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XWIN_WIND_OCTAVES	Frequency	REAL	UNIT PERCENT MIN 0.0 MAX 1000000.0 STEP 1.0 MINSLIDER 0.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
XWIN_WIND_SCALE	Scale	REAL	UNIT PERCENT MIN 0.0 MAX 100000.0 STEP 1.0 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XWIN_WIND_SPLINE	StrengthMultiplier	SPLINE	Y_MIN -2.0 Y_MAX 2.0 X_MIN 0.0 X_MAX 1.0 X_STEPS 0.01 Y_STEPS 0.01
XWIN_WIND_YMAX	YLimit	REAL	MIN 0.0 STEP 0.01 MINSLIDER 0.0 MAXSLIDER 10.0 CUSTOMGUI REALSLIDER
XWIN_WIND_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.Omwind)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XWIN_WIND_ENABLED] = True
    obj[c4d.XWIN_WIND_MODE] = c4d.WIND_MODE_INDEP
    obj[c4d.XWIN_WIND_DRAW] = True
    obj[c4d.XWIN_WIND_VALUE] = 0.1
    obj[c4d.XWIN_WIND_TURBULENCE] = 0.1
    obj[c4d.XWIN_WIND_OCTAVES] = 0.1
    obj[c4d.XWIN_WIND_SCALE] = 0.1
    obj[c4d.XWIN_WIND_YMAX] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XWIN_WIND_ENABLED,True)
    bc.SetInt32(c4d.XWIN_WIND_MODE,c4d.WIND_MODE_INDEP)
    bc.SetBool(c4d.XWIN_WIND_DRAW,True)
    bc.SetFloat(c4d.XWIN_WIND_VALUE,0.1)
    bc.SetFloat(c4d.XWIN_WIND_TURBULENCE,0.1)
    bc.SetFloat(c4d.XWIN_WIND_OCTAVES,0.1)
    bc.SetFloat(c4d.XWIN_WIND_SCALE,0.1)
    bc.SetFloat(c4d.XWIN_WIND_YMAX,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omwind.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omwind);
    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(XWIN_WIND_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XWIN_WIND_MODE),GeData(WIND_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XWIN_WIND_DRAW),GeData(true),flags);
    pObject->SetParameter(DescID(XWIN_WIND_VALUE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XWIN_WIND_TURBULENCE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XWIN_WIND_OCTAVES),GeData(0.1),flags);
    pObject->SetParameter(DescID(XWIN_WIND_SCALE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XWIN_WIND_YMAX),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XWIN_WIND_ENABLED,true);
    bc->SetInt32(XWIN_WIND_MODE,WIND_MODE_INDEP);
    bc->SetBool(XWIN_WIND_DRAW,true);
    bc->SetFloat(XWIN_WIND_VALUE,0.1);
    bc->SetFloat(XWIN_WIND_TURBULENCE,0.1);
    bc->SetFloat(XWIN_WIND_OCTAVES,0.1);
    bc->SetFloat(XWIN_WIND_SCALE,0.1);
    bc->SetFloat(XWIN_WIND_YMAX,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}