IDs and information for XSLARipple

XSLARipple

Attributes

• ENGLISH NAME : RippleShader
• NAME : XSLARipple
• INCLUDE : Mpreview
• INCLUDE : Xbase
• PATH : sla/description/xslaripple.res
• PLUGIN : sla
• MAXON online help (may not exist): XSLARIPPLE

Elements

ID	UI Name	Type	Parameters	Cycle
SLA_WAVE_PARAMS_LENGTH	Wavelength	REAL	UNIT METER MIN 0.00001
SLA_WAVE_PARAMS_SPEED	Speed	REAL	MIN
SLA_WAVE_AMPLITUDE	Amplitude	REAL	UNIT PERCENT MIN 0
SLA_WAVE_FALLOFF	Falloff	REAL	UNIT PERCENT MIN 0 MINSLIDER 0 MAXSLIDER 100 CUSTOMGUI REALSLIDER
SLA_WAVE_PARAMS_MIN_STRENGTH	MinimalStrength	REAL	UNIT PERCENT MIN 0 MAX 1000 MINSLIDER 0 MAXSLIDER 100 CUSTOMGUI REALSLIDER
SLA_WAVE_PERIODS	Periods	LONG	MIN
SLA_WAVE_PARAMS_SPEED_PARTICLE_DEPENDENT	ParticleDependent	BOOL
SLA_WAVE_PARAMS_OBJECT	Object	LINK
SLA_WAVE_PARTICLE	Particles	LINK

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.Xripple)
    
    #You can set parameters two different ways. 
    #First way              
    shader[c4d.SLA_WAVE_PARAMS_LENGTH] = 0.1
    shader[c4d.SLA_WAVE_PARAMS_SPEED] = 0.1
    shader[c4d.SLA_WAVE_AMPLITUDE] = 0.1
    shader[c4d.SLA_WAVE_FALLOFF] = 0.1
    shader[c4d.SLA_WAVE_PARAMS_MIN_STRENGTH] = 0.1
    shader[c4d.SLA_WAVE_PERIODS] = 1
    shader[c4d.SLA_WAVE_PARAMS_SPEED_PARTICLE_DEPENDENT] = True
    
    #Second way, using the base container.
    bc = shader.GetDataInstance()
    bc.SetFloat(c4d.SLA_WAVE_PARAMS_LENGTH,0.1)
    bc.SetFloat(c4d.SLA_WAVE_PARAMS_SPEED,0.1)
    bc.SetFloat(c4d.SLA_WAVE_AMPLITUDE,0.1)
    bc.SetFloat(c4d.SLA_WAVE_FALLOFF,0.1)
    bc.SetFloat(c4d.SLA_WAVE_PARAMS_MIN_STRENGTH,0.1)
    bc.SetInt32(c4d.SLA_WAVE_PERIODS,1)
    bc.SetBool(c4d.SLA_WAVE_PARAMS_SPEED_PARTICLE_DEPENDENT,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../sla/description/xslaripple.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseShader *pShader = BaseShader::Alloc(Xripple);  
    
    //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_WAVE_PARAMS_LENGTH),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_WAVE_PARAMS_SPEED),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_WAVE_AMPLITUDE),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_WAVE_FALLOFF),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_WAVE_PARAMS_MIN_STRENGTH),GeData(0.1),flags);
    pShader->SetParameter(DescID(SLA_WAVE_PERIODS),GeData(1),flags);
    pShader->SetParameter(DescID(SLA_WAVE_PARAMS_SPEED_PARTICLE_DEPENDENT),GeData(true),flags);
    pShader->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pShader->GetDataInstance();
    bc->SetFloat(SLA_WAVE_PARAMS_LENGTH,0.1);
    bc->SetFloat(SLA_WAVE_PARAMS_SPEED,0.1);
    bc->SetFloat(SLA_WAVE_AMPLITUDE,0.1);
    bc->SetFloat(SLA_WAVE_FALLOFF,0.1);
    bc->SetFloat(SLA_WAVE_PARAMS_MIN_STRENGTH,0.1);
    bc->SetInt32(SLA_WAVE_PERIODS,1);
    bc->SetBool(SLA_WAVE_PARAMS_SPEED_PARTICLE_DEPENDENT,true);
    pShader->Message(MSG_UPDATE);                                                      
}