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 PyroCluster

PyroCluster

Attributes

  • ENGLISH NAME : PyroCluster-VolumeTracer
  • NAME : PSIMF_NAME
  • INCLUDE : Mpreview
  • INCLUDE : Mbase
  • PATH : advanced_render/description/pyrocluster.res
  • PLUGIN : advanced_render
  • MAXON online help (may not exist): PYROCLUSTER

Elements

ID UI Name Type Parameters Cycle
MATERIAL_PAGE_PROPERTIES BOOL
HIDDEN
PAGE
PARENTMSG PSIMF_GLOBALS_GROUP
PSIMF_RENDOBJ RenderObjects BOOL  
PSIMF_RENDHOBJ RenderHiddenObjects BOOL  
PSIMF_RENDMODE RenderMode LONG  
REND_MODE_HIGH Crispy
REND_MODE_MEDIUM Crispy-Gas
REND_MODE_LOW Hazy
REND_MODE_USER User
PSIMF_STEP WorldStepSize REAL
MIN 0.01
STEP 0.01
PSIMF_LIMIT RayTrans.Limit REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
STEP 0.1
PSIMF_MAPSTEP ShadowMapStepSize REAL
MIN 0.01
STEP 0.01
PSIMF_MAPLIMIT ShadowMapTrans.Limit REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
STEP 0.1
PSIMF_SHADSTEP RaytracedStepSize REAL
MIN 0.01
STEP 0.01
PSIMF_SHADLIMIT RaytracedTrans.Limit REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
STEP 0.1
PSIMF_RTCORRECT RayTrans.Correction REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
STEP 0.1
PSIMF_VOLFILTER VolumeLight BOOL  

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():
    material = c4d.BaseMaterial(c4d.PyroCluster)
    
    #You can set parameters two different ways. 
    #First way              
    material[c4d.MATERIAL_PAGE_PROPERTIES] = True
    material[c4d.PSIMF_RENDOBJ] = True
    material[c4d.PSIMF_RENDHOBJ] = True
    material[c4d.PSIMF_RENDMODE] = c4d.REND_MODE_HIGH
    material[c4d.PSIMF_STEP] = 0.1
    material[c4d.PSIMF_LIMIT] = 0.1
    material[c4d.PSIMF_MAPSTEP] = 0.1
    material[c4d.PSIMF_MAPLIMIT] = 0.1
    material[c4d.PSIMF_SHADSTEP] = 0.1
    material[c4d.PSIMF_SHADLIMIT] = 0.1
    material[c4d.PSIMF_RTCORRECT] = 0.1
    material[c4d.PSIMF_VOLFILTER] = True
    
    #Second way, using the base container.
    bc = material.GetDataInstance()
    bc.SetBool(c4d.MATERIAL_PAGE_PROPERTIES,True)
    bc.SetBool(c4d.PSIMF_RENDOBJ,True)
    bc.SetBool(c4d.PSIMF_RENDHOBJ,True)
    bc.SetInt32(c4d.PSIMF_RENDMODE,c4d.REND_MODE_HIGH)
    bc.SetFloat(c4d.PSIMF_STEP,0.1)
    bc.SetFloat(c4d.PSIMF_LIMIT,0.1)
    bc.SetFloat(c4d.PSIMF_MAPSTEP,0.1)
    bc.SetFloat(c4d.PSIMF_MAPLIMIT,0.1)
    bc.SetFloat(c4d.PSIMF_SHADSTEP,0.1)
    bc.SetFloat(c4d.PSIMF_SHADLIMIT,0.1)
    bc.SetFloat(c4d.PSIMF_RTCORRECT,0.1)
    bc.SetBool(c4d.PSIMF_VOLFILTER,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../advanced_render/description/pyrocluster.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseMaterial *pMaterial = BaseMaterial::Alloc(PyroCluster);  
    
    //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;
    pMaterial->SetParameter(DescID(MATERIAL_PAGE_PROPERTIES),GeData(true),flags);
    pMaterial->SetParameter(DescID(PSIMF_RENDOBJ),GeData(true),flags);
    pMaterial->SetParameter(DescID(PSIMF_RENDHOBJ),GeData(true),flags);
    pMaterial->SetParameter(DescID(PSIMF_RENDMODE),GeData(REND_MODE_HIGH),flags);
    pMaterial->SetParameter(DescID(PSIMF_STEP),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_LIMIT),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_MAPSTEP),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_MAPLIMIT),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_SHADSTEP),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_SHADLIMIT),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_RTCORRECT),GeData(0.1),flags);
    pMaterial->SetParameter(DescID(PSIMF_VOLFILTER),GeData(true),flags);
    pMaterial->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pMaterial->GetDataInstance();
    bc->SetBool(MATERIAL_PAGE_PROPERTIES,true);
    bc->SetBool(PSIMF_RENDOBJ,true);
    bc->SetBool(PSIMF_RENDHOBJ,true);
    bc->SetInt32(PSIMF_RENDMODE,REND_MODE_HIGH);
    bc->SetFloat(PSIMF_STEP,0.1);
    bc->SetFloat(PSIMF_LIMIT,0.1);
    bc->SetFloat(PSIMF_MAPSTEP,0.1);
    bc->SetFloat(PSIMF_MAPLIMIT,0.1);
    bc->SetFloat(PSIMF_SHADSTEP,0.1);
    bc->SetFloat(PSIMF_SHADLIMIT,0.1);
    bc->SetFloat(PSIMF_RTCORRECT,0.1);
    bc->SetBool(PSIMF_VOLFILTER,true);
    pMaterial->Message(MSG_UPDATE);                                                      
}