IDs and information for Xsunburst

Xsunburst

Attributes

• ENGLISH NAME : SunburstShader
• NAME : Xsunburst
• INCLUDE : Mpreview
• INCLUDE : Xbase
• PATH : shader/description/xsunburst.res
• PLUGIN : shader
• MAXON online help (may not exist): XSUNBURST

Elements

ID	UI Name	Type	Parameters	Cycle
SUNBURSTSHADER_COLOR	Color	GRADIENT	ICC_BASEDOCUMENT
SUNBURSTSHADER_SCALE_R	RFrequency	REAL	MIN 0.0 STEP 0.01
SUNBURSTSHADER_SCALE_A	AFrequency	REAL	MIN 0.0 STEP 0.01
SUNBURSTSHADER_FREQUENCY	TFrequency	REAL	MIN 0.0 STEP 0.01
SUNBURSTSHADER_TURBULENCE	Turbulence	REAL	MIN 0.0 STEP 0.01
SUNBURSTSHADER_RADIUS	Radius	REAL	UNIT PERCENT MIN 0.0 MAX 100.0
SUNBURSTSHADER_HEIGHT	Height	REAL	UNIT PERCENT MIN 0.0 MAX 100.0

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.Xsunburst)
    
    #You can set parameters two different ways. 
    #First way              
    shader[c4d.SUNBURSTSHADER_SCALE_R] = 0.1
    shader[c4d.SUNBURSTSHADER_SCALE_A] = 0.1
    shader[c4d.SUNBURSTSHADER_FREQUENCY] = 0.1
    shader[c4d.SUNBURSTSHADER_TURBULENCE] = 0.1
    shader[c4d.SUNBURSTSHADER_RADIUS] = 0.1
    shader[c4d.SUNBURSTSHADER_HEIGHT] = 0.1
    
    #Second way, using the base container.
    bc = shader.GetDataInstance()
    bc.SetFloat(c4d.SUNBURSTSHADER_SCALE_R,0.1)
    bc.SetFloat(c4d.SUNBURSTSHADER_SCALE_A,0.1)
    bc.SetFloat(c4d.SUNBURSTSHADER_FREQUENCY,0.1)
    bc.SetFloat(c4d.SUNBURSTSHADER_TURBULENCE,0.1)
    bc.SetFloat(c4d.SUNBURSTSHADER_RADIUS,0.1)
    bc.SetFloat(c4d.SUNBURSTSHADER_HEIGHT,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../shader/description/xsunburst.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseShader *pShader = BaseShader::Alloc(Xsunburst);  
    
    //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(SUNBURSTSHADER_SCALE_R),GeData(0.1),flags);
    pShader->SetParameter(DescID(SUNBURSTSHADER_SCALE_A),GeData(0.1),flags);
    pShader->SetParameter(DescID(SUNBURSTSHADER_FREQUENCY),GeData(0.1),flags);
    pShader->SetParameter(DescID(SUNBURSTSHADER_TURBULENCE),GeData(0.1),flags);
    pShader->SetParameter(DescID(SUNBURSTSHADER_RADIUS),GeData(0.1),flags);
    pShader->SetParameter(DescID(SUNBURSTSHADER_HEIGHT),GeData(0.1),flags);
    pShader->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pShader->GetDataInstance();
    bc->SetFloat(SUNBURSTSHADER_SCALE_R,0.1);
    bc->SetFloat(SUNBURSTSHADER_SCALE_A,0.1);
    bc->SetFloat(SUNBURSTSHADER_FREQUENCY,0.1);
    bc->SetFloat(SUNBURSTSHADER_TURBULENCE,0.1);
    bc->SetFloat(SUNBURSTSHADER_RADIUS,0.1);
    bc->SetFloat(SUNBURSTSHADER_HEIGHT,0.1);
    pShader->Message(MSG_UPDATE);                                                      
}
             

Gradients

This node has gradients. Gradients can manually be edited by calling the following code

Python

C++

           
#include "customgui_gradient.h"
SUNBURSTSHADER_COLOR
                                
GeData data;
pShader->GetParameter(DescID(SUNBURSTSHADER_COLOR),data,DESCFLAGS_GET_PARAM_GET));
Gradient *pGradient = (Gradient*)data.GetCustomDataType(CUSTOMDATATYPE_GRADIENT);
if(pGradient)
{    
    //must be set before any knot is set
    pGradient->SetData(GRADIENT_MODE, GeData(GRADIENTMODE_ALPHA));
    GradientKnot k1, k2;
    k1.col = Vector(0.0, 0.0, 1.0);
    k1.pos = 0.0;
    k2.col = 1.0;
    k2.pos = 1.0;
    pGradient->InsertKnot(k1);
    pGradient->InsertKnot(k2);
}
pShader->SetParameter(DescID(SUNBURSTSHADER_COLOR),data,DESCFLAGS_SET_PARAM_SET));