Here you will find documentation on all the descriptions that Cinema 4D currently has. You can list them Alphabetically, by Type or Plugin . The sample Python and C++ code is automatically generated and in some cases may not be 100% correct. If something doesn't work then please refer to the official Cinema 4D SDK documentation for more information.

IDs and information for Omvortex

Omvortex

Attributes

  • ENGLISH NAME : X-ParticlesVortexModifier
  • NAME : Omvortex
  • INCLUDE : Obase
  • PATH : res/description/omvortex.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMVORTEX

Elements

ID UI Name Type Parameters Cycle
XMVO_VORTEX_ENABLED Enabled BOOL  
XMVO_VORTEX_MODE Mode LONG  
VORTEX_MODE_INDEP Independent
VORTEX_MODE_ACTION Action-Controlled
XMVO_VORTEX_OBJECT Object LINK  
XMVO_VORTEX_MOVEWITH MovewithObject BOOL  
XMVO_VORTEX_CCLOCK InvertRotation BOOL  
XMVO_VORTEX_TIME SplineDuration BASETIME  
XMVO_VORTEX_RAD_SPLINE RadiusChange SPLINE
Y_MIN -5.0
Y_MAX 5.0
X_MIN 0.0
X_MAX 1.0
X_STEPS 0.01
Y_STEPS 0.1
XMVO_VORTEX_RAD_VAR RadiusVariation REAL
UNIT METER
MINSLIDER -20.0
MAXSLIDER 20.0
CUSTOMGUI REALSLIDER
XMVO_VORTEX_RAD_MIN MinimumRadius REAL
UNIT METER
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMVO_VORTEX_RAD_KILL KillatMin.Radius BOOL  
XMVO_VORTEX_RAD_SPLINEMAX SplineMaximum REAL
UNIT REAL
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMVO_VORTEX_PITCH_SPLINE Pitch SPLINE
Y_MIN 0.0
Y_MAX 10.0
X_MIN 0.0
X_MAX 1.0
X_STEPS 0.01
Y_STEPS 0.1
XMVO_VORTEX_PITCH_VAR PitchVariation REAL
UNIT METER
MINSLIDER -100.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMVO_VORTEX_PITCH_SPLINEMAX SplineMaximum REAL
UNIT REAL
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMVO_VORTEX_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.Omvortex)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMVO_VORTEX_ENABLED] = True
    obj[c4d.XMVO_VORTEX_MODE] = c4d.VORTEX_MODE_INDEP
    obj[c4d.XMVO_VORTEX_MOVEWITH] = True
    obj[c4d.XMVO_VORTEX_CCLOCK] = True
    obj[c4d.XMVO_VORTEX_RAD_VAR] = 0.1
    obj[c4d.XMVO_VORTEX_RAD_MIN] = 0.1
    obj[c4d.XMVO_VORTEX_RAD_KILL] = True
    obj[c4d.XMVO_VORTEX_RAD_SPLINEMAX] = 0.1
    obj[c4d.XMVO_VORTEX_PITCH_VAR] = 0.1
    obj[c4d.XMVO_VORTEX_PITCH_SPLINEMAX] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMVO_VORTEX_ENABLED,True)
    bc.SetInt32(c4d.XMVO_VORTEX_MODE,c4d.VORTEX_MODE_INDEP)
    bc.SetBool(c4d.XMVO_VORTEX_MOVEWITH,True)
    bc.SetBool(c4d.XMVO_VORTEX_CCLOCK,True)
    bc.SetFloat(c4d.XMVO_VORTEX_RAD_VAR,0.1)
    bc.SetFloat(c4d.XMVO_VORTEX_RAD_MIN,0.1)
    bc.SetBool(c4d.XMVO_VORTEX_RAD_KILL,True)
    bc.SetFloat(c4d.XMVO_VORTEX_RAD_SPLINEMAX,0.1)
    bc.SetFloat(c4d.XMVO_VORTEX_PITCH_VAR,0.1)
    bc.SetFloat(c4d.XMVO_VORTEX_PITCH_SPLINEMAX,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omvortex.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omvortex);
    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(XMVO_VORTEX_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_MODE),GeData(VORTEX_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_MOVEWITH),GeData(true),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_CCLOCK),GeData(true),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_RAD_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_RAD_MIN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_RAD_KILL),GeData(true),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_RAD_SPLINEMAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_PITCH_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMVO_VORTEX_PITCH_SPLINEMAX),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMVO_VORTEX_ENABLED,true);
    bc->SetInt32(XMVO_VORTEX_MODE,VORTEX_MODE_INDEP);
    bc->SetBool(XMVO_VORTEX_MOVEWITH,true);
    bc->SetBool(XMVO_VORTEX_CCLOCK,true);
    bc->SetFloat(XMVO_VORTEX_RAD_VAR,0.1);
    bc->SetFloat(XMVO_VORTEX_RAD_MIN,0.1);
    bc->SetBool(XMVO_VORTEX_RAD_KILL,true);
    bc->SetFloat(XMVO_VORTEX_RAD_SPLINEMAX,0.1);
    bc->SetFloat(XMVO_VORTEX_PITCH_VAR,0.1);
    bc->SetFloat(XMVO_VORTEX_PITCH_SPLINEMAX,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}