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 Omfreeze

Omfreeze

Attributes

  • ENGLISH NAME : X-ParticlesFreezeModifier
  • NAME : Omfreeze
  • INCLUDE : Obase
  • PATH : res/description/omfreeze.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMFREEZE

Elements

ID UI Name Type Parameters Cycle
XMFR_FREEZE_ENABLED Enabled BOOL  
XMFR_FREEZE_MODE Mode LONG  
FREEZE_MODE_INDEP Independent
FREEZE_MODE_ACTION Action-Controlled
XMFR_FREEZE_OPERATION Operation LONG  
FREEZE_MODE_SWITCH FreezeinFalloffRedZoneOnly
FREEZE_MODE_FALLOFF FreezeDependsonFalloff
XMFR_FREEZE_ACTION ActiononParticles LONG  
FREEZE_ACTION_FREEZE Freeze
FREEZE_ACTION_UNFREEZE Unfreeze
XMFR_FREEZE_MOVE Movement BOOL  
XMFR_FREEZE_SPIN Spin BOOL  
XMFR_FREEZE_SCALE Scale BOOL  
XMFR_FREEZE_SPEEDZERO SetSpeedtoZero BOOL  
XMFR_FREEZE_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.Omfreeze)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMFR_FREEZE_ENABLED] = True
    obj[c4d.XMFR_FREEZE_MODE] = c4d.FREEZE_MODE_INDEP
    obj[c4d.XMFR_FREEZE_OPERATION] = c4d.FREEZE_MODE_SWITCH
    obj[c4d.XMFR_FREEZE_ACTION] = c4d.FREEZE_ACTION_FREEZE
    obj[c4d.XMFR_FREEZE_MOVE] = True
    obj[c4d.XMFR_FREEZE_SPIN] = True
    obj[c4d.XMFR_FREEZE_SCALE] = True
    obj[c4d.XMFR_FREEZE_SPEEDZERO] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMFR_FREEZE_ENABLED,True)
    bc.SetInt32(c4d.XMFR_FREEZE_MODE,c4d.FREEZE_MODE_INDEP)
    bc.SetInt32(c4d.XMFR_FREEZE_OPERATION,c4d.FREEZE_MODE_SWITCH)
    bc.SetInt32(c4d.XMFR_FREEZE_ACTION,c4d.FREEZE_ACTION_FREEZE)
    bc.SetBool(c4d.XMFR_FREEZE_MOVE,True)
    bc.SetBool(c4d.XMFR_FREEZE_SPIN,True)
    bc.SetBool(c4d.XMFR_FREEZE_SCALE,True)
    bc.SetBool(c4d.XMFR_FREEZE_SPEEDZERO,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omfreeze.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omfreeze);
    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(XMFR_FREEZE_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_MODE),GeData(FREEZE_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_OPERATION),GeData(FREEZE_MODE_SWITCH),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_ACTION),GeData(FREEZE_ACTION_FREEZE),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_MOVE),GeData(true),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_SPIN),GeData(true),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_SCALE),GeData(true),flags);
    pObject->SetParameter(DescID(XMFR_FREEZE_SPEEDZERO),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMFR_FREEZE_ENABLED,true);
    bc->SetInt32(XMFR_FREEZE_MODE,FREEZE_MODE_INDEP);
    bc->SetInt32(XMFR_FREEZE_OPERATION,FREEZE_MODE_SWITCH);
    bc->SetInt32(XMFR_FREEZE_ACTION,FREEZE_ACTION_FREEZE);
    bc->SetBool(XMFR_FREEZE_MOVE,true);
    bc->SetBool(XMFR_FREEZE_SPIN,true);
    bc->SetBool(XMFR_FREEZE_SCALE,true);
    bc->SetBool(XMFR_FREEZE_SPEEDZERO,true);
    pObject->Message(MSG_UPDATE);                                                      
}