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 XSLADirt

IDs and information for XSLADirt

XSLADirt

Attributes

  • ENGLISH NAME : DirtShader
  • NAME : XSLADirt
  • INCLUDE : Mpreview
  • INCLUDE : Xbase
  • PATH : sla/description/xsladirt.res
  • PLUGIN : sla
  • MAXON online help (may not exist): XSLADIRT

Elements

ID UI Name Type Parameters Cycle
SLA_DIRTY_RAY_BIAS RayBias REAL MIN
SLA_DIRTY_MAX_DISTANCE MaximumDistance REAL MIN
SLA_DIRTY_NUM_RAYS NumberofRays LONG MIN
SLA_DIRTY_SPREAD Spread REAL
UNIT PERCENT
MIN 0
MAX 100
SLA_DIRTY_CONTRAST Contrast REAL
UNIT PERCENT
MIN 0
MAX 100

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():
    shader = c4d.BaseShader(c4d.Xdirt)
    
    #You can set parameters two different ways. 
    #First way              
    shader[c4d.SLA_DIRTY_RAY_BIAS] = 0.1
    shader[c4d.SLA_DIRTY_MAX_DISTANCE] = 0.1
    shader[c4d.SLA_DIRTY_NUM_RAYS] = 1
    shader[c4d.SLA_DIRTY_SPREAD] = 0.1
    shader[c4d.SLA_DIRTY_CONTRAST] = 0.1
    
    #Second way, using the base container.
    bc = shader.GetDataInstance()
    bc.SetFloat(c4d.SLA_DIRTY_RAY_BIAS,0.1)
    bc.SetFloat(c4d.SLA_DIRTY_MAX_DISTANCE,0.1)
    bc.SetInt32(c4d.SLA_DIRTY_NUM_RAYS,1)
    bc.SetFloat(c4d.SLA_DIRTY_SPREAD,0.1)
    bc.SetFloat(c4d.SLA_DIRTY_CONTRAST,0.1)

if __name__=='__main__':
    main()

C++

#include "c4d.h"
#include "../sla/description/xsladirt.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseShader *pShader = BaseShader::Alloc(Xdirt);  
    
    //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;
    pShader->SetParameter(DescID(SLA_DIRTY_RAY_BIAS),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_DIRTY_MAX_DISTANCE),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_DIRTY_NUM_RAYS),GeData(1),flags);
    pShader->SetParameter(DescID(SLA_DIRTY_SPREAD),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_DIRTY_CONTRAST),GeData(0.1),flags);
    pShader->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pShader->GetDataInstance();
    bc->SetFloat(SLA_DIRTY_RAY_BIAS,0.1);
    bc->SetFloat(SLA_DIRTY_MAX_DISTANCE,0.1);
    bc->SetInt32(SLA_DIRTY_NUM_RAYS,1);
    bc->SetFloat(SLA_DIRTY_SPREAD,0.1);
    bc->SetFloat(SLA_DIRTY_CONTRAST,0.1);
    pShader->Message(MSG_UPDATE);                                                      
}