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.

Description Ombuoyancy

IDs and information for Ombuoyancy

Ombuoyancy

Attributes

  • ENGLISH NAME : X-ParticlesGaseousModifier
  • NAME : Ombuoyancy
  • INCLUDE : Obase
  • PATH : res/description/ombuoyancy.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMBUOYANCY

Elements

ID UI Name Type Parameters Cycle
XMBY_BUOYANCY_ENABLED Enabled BOOL  
XMBY_BUOYANCY_MODE Mode LONG  
XMBY_BUOYANCY_MODE_INDEP Independent
XMBY_BUOYANCY_MODE_ACTION Action-Controlled
XMBY_BUOYANCY_DRAW VisibleinEditor BOOL  
XMBY_BUOYANCY_AMBIENT AmbientTemperature REAL  
XMBY_BUOYANCY_COOLING Cooling REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_COOLING_VAR Variation REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_RISE Rise REAL
UNIT METER
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_RISE_VAR Variation REAL
UNIT METER
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FALL Fall REAL
UNIT METER
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FALL_VAR Variation REAL
UNIT METER
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FACEOBJECT EffectTowards LINK  
XMBY_BUOYANCY_SMOKEDISSIPATION Dissipation REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_SMOKEDISSIPATION_VAR Variation REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_IGNITION IgnitionTemp REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_IGNITION_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_FUEL_BURN FuelRate REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_BURN_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_TEMP FuelEmitTemp REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_TEMP_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_SMOKE FuelEmitSmoke REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_SMOKE_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_EXPANSION FuelPressure REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_FUEL_EXPANSION_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
XMBY_BUOYANCY_BURN_TYPE Mode LONG  
XMBY_BUOYANCY_BURN_TYPE_LINEAR Linear
XMBY_BUOYANCY_BURN_TYPE_EXP Exponential
XMBY_BUOYANCY_BURN BurnRate REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_PERCENT BurnRate% REAL
UNIT PERCENT
STEP 1.0
MINSLIDER 0.0
MAX 100.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_PERCENT_VAR Variation REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_TEMP FireEmitTemp REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_TEMP_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_SMOKE_BELOW SmokeBelow REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_SMOKE_BELOW_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_SMOKE FireEmitSmoke REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_SMOKE_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_EXPANSION FirePressure REAL
STEP 1.0
MINSLIDER 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_BURN_EXPANSION_VAR Variation REAL
MIN 0.0
MAX 1000.0
STEP 1.0
CUSTOMGUI REALSLIDER
SCALE_H
XMBY_BUOYANCY_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.Ombuoyancy)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMBY_BUOYANCY_ENABLED] = True
    obj[c4d.XMBY_BUOYANCY_MODE] = c4d.XMBY_BUOYANCY_MODE_INDEP
    obj[c4d.XMBY_BUOYANCY_DRAW] = True
    obj[c4d.XMBY_BUOYANCY_AMBIENT] = 0.1
    obj[c4d.XMBY_BUOYANCY_COOLING] = 0.1
    obj[c4d.XMBY_BUOYANCY_COOLING_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_RISE] = 0.1
    obj[c4d.XMBY_BUOYANCY_RISE_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_FALL] = 0.1
    obj[c4d.XMBY_BUOYANCY_FALL_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_SMOKEDISSIPATION] = 0.1
    obj[c4d.XMBY_BUOYANCY_SMOKEDISSIPATION_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_IGNITION] = 0.1
    obj[c4d.XMBY_BUOYANCY_IGNITION_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_BURN] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_BURN_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_TEMP] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_TEMP_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_SMOKE] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_SMOKE_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_EXPANSION] = 0.1
    obj[c4d.XMBY_BUOYANCY_FUEL_EXPANSION_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_TYPE] = c4d.XMBY_BUOYANCY_BURN_TYPE_LINEAR
    obj[c4d.XMBY_BUOYANCY_BURN] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_PERCENT] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_PERCENT_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_TEMP] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_TEMP_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_SMOKE_BELOW] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_SMOKE_BELOW_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_SMOKE] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_SMOKE_VAR] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_EXPANSION] = 0.1
    obj[c4d.XMBY_BUOYANCY_BURN_EXPANSION_VAR] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMBY_BUOYANCY_ENABLED,True)
    bc.SetInt32(c4d.XMBY_BUOYANCY_MODE,c4d.XMBY_BUOYANCY_MODE_INDEP)
    bc.SetBool(c4d.XMBY_BUOYANCY_DRAW,True)
    bc.SetFloat(c4d.XMBY_BUOYANCY_AMBIENT,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_COOLING,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_COOLING_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_RISE,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_RISE_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FALL,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FALL_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_SMOKEDISSIPATION,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_SMOKEDISSIPATION_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_IGNITION,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_IGNITION_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_BURN,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_BURN_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_TEMP,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_TEMP_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_SMOKE,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_SMOKE_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_EXPANSION,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_FUEL_EXPANSION_VAR,0.1)
    bc.SetInt32(c4d.XMBY_BUOYANCY_BURN_TYPE,c4d.XMBY_BUOYANCY_BURN_TYPE_LINEAR)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_PERCENT,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_PERCENT_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_TEMP,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_TEMP_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_SMOKE_BELOW,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_SMOKE_BELOW_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_SMOKE,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_SMOKE_VAR,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_EXPANSION,0.1)
    bc.SetFloat(c4d.XMBY_BUOYANCY_BURN_EXPANSION_VAR,0.1)

if __name__=='__main__':
    main()

C++

#include "c4d.h"
#include "../res/description/ombuoyancy.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Ombuoyancy);
    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(XMBY_BUOYANCY_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_MODE),GeData(XMBY_BUOYANCY_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_DRAW),GeData(true),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_AMBIENT),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_COOLING),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_COOLING_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_RISE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_RISE_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FALL),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FALL_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_SMOKEDISSIPATION),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_SMOKEDISSIPATION_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_IGNITION),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_IGNITION_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_BURN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_BURN_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_TEMP),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_TEMP_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_SMOKE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_SMOKE_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_EXPANSION),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_FUEL_EXPANSION_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_TYPE),GeData(XMBY_BUOYANCY_BURN_TYPE_LINEAR),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_PERCENT),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_PERCENT_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_TEMP),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_TEMP_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_SMOKE_BELOW),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_SMOKE_BELOW_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_SMOKE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_SMOKE_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_EXPANSION),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMBY_BUOYANCY_BURN_EXPANSION_VAR),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMBY_BUOYANCY_ENABLED,true);
    bc->SetInt32(XMBY_BUOYANCY_MODE,XMBY_BUOYANCY_MODE_INDEP);
    bc->SetBool(XMBY_BUOYANCY_DRAW,true);
    bc->SetFloat(XMBY_BUOYANCY_AMBIENT,0.1);
    bc->SetFloat(XMBY_BUOYANCY_COOLING,0.1);
    bc->SetFloat(XMBY_BUOYANCY_COOLING_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_RISE,0.1);
    bc->SetFloat(XMBY_BUOYANCY_RISE_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FALL,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FALL_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_SMOKEDISSIPATION,0.1);
    bc->SetFloat(XMBY_BUOYANCY_SMOKEDISSIPATION_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_IGNITION,0.1);
    bc->SetFloat(XMBY_BUOYANCY_IGNITION_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_BURN,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_BURN_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_TEMP,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_TEMP_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_SMOKE,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_SMOKE_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_EXPANSION,0.1);
    bc->SetFloat(XMBY_BUOYANCY_FUEL_EXPANSION_VAR,0.1);
    bc->SetInt32(XMBY_BUOYANCY_BURN_TYPE,XMBY_BUOYANCY_BURN_TYPE_LINEAR);
    bc->SetFloat(XMBY_BUOYANCY_BURN,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_PERCENT,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_PERCENT_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_TEMP,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_TEMP_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_SMOKE_BELOW,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_SMOKE_BELOW_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_SMOKE,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_SMOKE_VAR,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_EXPANSION,0.1);
    bc->SetFloat(XMBY_BUOYANCY_BURN_EXPANSION_VAR,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}