IDs and information for Omvorticity

Omvorticity

Attributes

• ENGLISH NAME : X-ParticlesVorticityModifier
• NAME : Omvorticity
• INCLUDE : Obase
• PATH : res/description/omvorticity.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMVORTICITY

Elements

ID	UI Name	Type	Parameters	Cycle
XMVT_VORTICITY_ENABLED	Enabled	BOOL
XMVT_VORTICITY_MODE	Mode	LONG		XMVT_VORTICITY_MODE_INDEP Independent XMVT_VORTICITY_MODE_ACTION Action-Controlled
XMVT_VORTICITY_DRAW	VisibleinEditor	BOOL
XMVT_VORTICITY_STRENGTH	Strength	REAL	UNIT PERCENT MIN 0.0
XMVT_VORTICITY_TYPE	Type	LONG		XMVT_VORTICITY_TYPE_GRID_UNLIMITED UnlimitedGrid XMVT_VORTICITY_TYPE_GRID_LIMITED LimitedGrid
XMVT_VORTICITY_SIZE	Size	VECTOR	UNIT
XMVT_VORTICITY_VOXEL	Voxel	REAL	UNIT METER MIN 0.0
XMVT_VORTICITY_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.Omvorticity)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMVT_VORTICITY_ENABLED] = True
    obj[c4d.XMVT_VORTICITY_MODE] = c4d.XMVT_VORTICITY_MODE_INDEP
    obj[c4d.XMVT_VORTICITY_DRAW] = True
    obj[c4d.XMVT_VORTICITY_STRENGTH] = 0.1
    obj[c4d.XMVT_VORTICITY_TYPE] = c4d.XMVT_VORTICITY_TYPE_GRID_UNLIMITED
    obj[c4d.XMVT_VORTICITY_SIZE] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMVT_VORTICITY_VOXEL] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMVT_VORTICITY_ENABLED,True)
    bc.SetInt32(c4d.XMVT_VORTICITY_MODE,c4d.XMVT_VORTICITY_MODE_INDEP)
    bc.SetBool(c4d.XMVT_VORTICITY_DRAW,True)
    bc.SetFloat(c4d.XMVT_VORTICITY_STRENGTH,0.1)
    bc.SetInt32(c4d.XMVT_VORTICITY_TYPE,c4d.XMVT_VORTICITY_TYPE_GRID_UNLIMITED)
    bc.SetVector(c4d.XMVT_VORTICITY_SIZE, c4d.Vector(1.0,1.0,1.0)
    bc.SetFloat(c4d.XMVT_VORTICITY_VOXEL,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omvorticity.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omvorticity);
    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(XMVT_VORTICITY_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMVT_VORTICITY_MODE),GeData(XMVT_VORTICITY_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMVT_VORTICITY_DRAW),GeData(true),flags);
    pObject->SetParameter(DescID(XMVT_VORTICITY_STRENGTH),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMVT_VORTICITY_TYPE),GeData(XMVT_VORTICITY_TYPE_GRID_UNLIMITED),flags);
    pObject->SetParameter(DescID(XMVT_VORTICITY_SIZE),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMVT_VORTICITY_VOXEL),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMVT_VORTICITY_ENABLED,true);
    bc->SetInt32(XMVT_VORTICITY_MODE,XMVT_VORTICITY_MODE_INDEP);
    bc->SetBool(XMVT_VORTICITY_DRAW,true);
    bc->SetFloat(XMVT_VORTICITY_STRENGTH,0.1);
    bc->SetInt32(XMVT_VORTICITY_TYPE,XMVT_VORTICITY_TYPE_GRID_UNLIMITED);
    bc->SetVector(XMVT_VORTICITY_SIZE, c4d.Vector(1.0,1.0,1.0);
    bc->SetFloat(XMVT_VORTICITY_VOXEL,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}