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 Txflip

IDs and information for Txflip

Txflip

Attributes

  • ENGLISH NAME : X-ParticlesDomainTag
  • NAME : Txflip
  • INCLUDE : Tbase
  • PATH : res/description/txflip.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): TXFLIP

Elements

ID UI Name Type Parameters Cycle
TFLIP_ENABLED UseasSource BOOL  
TFLIP_SHAPE Shape LONG  
TFLIP_SHAPE_SURFACE Surface
TFLIP_SHAPE_SURFACE_NORMALS Surface(Outwards)
TFLIP_SHAPE_VOLUME Volume
TFLIP_RADIUS Radius REAL
UNIT METER
MIN 0.0
TFLIP_TEMPERATURE Temperature REAL
MIN 0.0
MAXSLIDER 10000.0
CUSTOMGUI REALSLIDER
TFLIP_SMOKE Smoke REAL
MIN 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
TFLIP_BURN Fire REAL
MIN 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
TFLIP_FUEL Fuel REAL
MIN 0.0
MAXSLIDER 1000.0
CUSTOMGUI REALSLIDER
TFLIP_PRESSURE Pressure REAL
MIN 0.0
MAXSLIDER 10000.0
CUSTOMGUI REALSLIDER
TFLIP_TEXTURE Texture SHADERLINK  
TFLIP_UVTAG UVW LINK  
TFLIP_RESTRICT Restriction LINK  
TFLIP_IN_WEIGHT_V DomainVelocity REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
TFLIP_OUT_WEIGHT_V AdvectionVelocity REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
TFLIP_IN_WEIGHT_P DomainProperties REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
TFLIP_OUT_WEIGHT_P AdvectionProperties REAL
UNIT PERCENT
MIN 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
TFLIP_HELP_BUTTON BITMAPBUTTON  
TFLIP_VIDMAN_BUTTON BITMAPBUTTON  
TFLIP_RESET ResettoDefaults BUTTON  
TFLIP_SAVE_PRESET SavePreset... BUTTON  
TFLIP_LOAD_PRESET LoadPreset... BUTTON  

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.Osphere)
    tag = obj.MakeTag(c4d.Txflip)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    tag[c4d.TFLIP_ENABLED] = True
    tag[c4d.TFLIP_SHAPE] = c4d.TFLIP_SHAPE_SURFACE
    tag[c4d.TFLIP_RADIUS] = 0.1
    tag[c4d.TFLIP_TEMPERATURE] = 0.1
    tag[c4d.TFLIP_SMOKE] = 0.1
    tag[c4d.TFLIP_BURN] = 0.1
    tag[c4d.TFLIP_FUEL] = 0.1
    tag[c4d.TFLIP_PRESSURE] = 0.1
    tag[c4d.TFLIP_IN_WEIGHT_V] = 0.1
    tag[c4d.TFLIP_OUT_WEIGHT_V] = 0.1
    tag[c4d.TFLIP_IN_WEIGHT_P] = 0.1
    tag[c4d.TFLIP_OUT_WEIGHT_P] = 0.1
    
    #Second way, using the base container.
    bc = tag.GetDataInstance()
    bc.SetBool(c4d.TFLIP_ENABLED,True)
    bc.SetInt32(c4d.TFLIP_SHAPE,c4d.TFLIP_SHAPE_SURFACE)
    bc.SetFloat(c4d.TFLIP_RADIUS,0.1)
    bc.SetFloat(c4d.TFLIP_TEMPERATURE,0.1)
    bc.SetFloat(c4d.TFLIP_SMOKE,0.1)
    bc.SetFloat(c4d.TFLIP_BURN,0.1)
    bc.SetFloat(c4d.TFLIP_FUEL,0.1)
    bc.SetFloat(c4d.TFLIP_PRESSURE,0.1)
    bc.SetFloat(c4d.TFLIP_IN_WEIGHT_V,0.1)
    bc.SetFloat(c4d.TFLIP_OUT_WEIGHT_V,0.1)
    bc.SetFloat(c4d.TFLIP_IN_WEIGHT_P,0.1)
    bc.SetFloat(c4d.TFLIP_OUT_WEIGHT_P,0.1)

if __name__=='__main__':
    main()

C++

#include "c4d.h"
#include "../res/description/txflip.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osphere);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDOTYPE_NEW,pObject);
    pDoc->EndUndo();
    pDoc->StartUndo();
    BaseTag *pTag = pObject->MakeTag(Txflip);
    pDoc->AddUndo(UNDOTYPE_NEW,pTag);
    pDoc->EndUndo();
    pObject->Message(MSG_UPDATE);
    
    //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;
    pTag->SetParameter(DescID(TFLIP_ENABLED),GeData(true),flags);
    pTag->SetParameter(DescID(TFLIP_SHAPE),GeData(TFLIP_SHAPE_SURFACE),flags);
    pTag->SetParameter(DescID(TFLIP_RADIUS),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_TEMPERATURE),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_SMOKE),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_BURN),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_FUEL),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_PRESSURE),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_IN_WEIGHT_V),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_OUT_WEIGHT_V),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_IN_WEIGHT_P),GeData(0.1),flags);
    pTag->SetParameter(DescID(TFLIP_OUT_WEIGHT_P),GeData(0.1),flags);
    pTag->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pTag->GetDataInstance();
    bc->SetBool(TFLIP_ENABLED,true);
    bc->SetInt32(TFLIP_SHAPE,TFLIP_SHAPE_SURFACE);
    bc->SetFloat(TFLIP_RADIUS,0.1);
    bc->SetFloat(TFLIP_TEMPERATURE,0.1);
    bc->SetFloat(TFLIP_SMOKE,0.1);
    bc->SetFloat(TFLIP_BURN,0.1);
    bc->SetFloat(TFLIP_FUEL,0.1);
    bc->SetFloat(TFLIP_PRESSURE,0.1);
    bc->SetFloat(TFLIP_IN_WEIGHT_V,0.1);
    bc->SetFloat(TFLIP_OUT_WEIGHT_V,0.1);
    bc->SetFloat(TFLIP_IN_WEIGHT_P,0.1);
    bc->SetFloat(TFLIP_OUT_WEIGHT_P,0.1);
    pTag->Message(MSG_UPDATE);                                                      
}

Buttons

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

Python

c4d.CallButton(tag,c4d.TFLIP_HELP_BUTTON)
c4d.CallButton(tag,c4d.TFLIP_VIDMAN_BUTTON)
c4d.CallButton(tag,c4d.TFLIP_RESET)
c4d.CallButton(tag,c4d.TFLIP_SAVE_PRESET)
c4d.CallButton(tag,c4d.TFLIP_LOAD_PRESET)

C++

DescriptionCommand dc;
dc.id = DescID(TFLIP_HELP_BUTTON);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TFLIP_VIDMAN_BUTTON);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TFLIP_RESET);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TFLIP_SAVE_PRESET);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TFLIP_LOAD_PRESET);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);