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 Xstar

Xstar

Attributes

  • ENGLISH NAME : StarShader
  • NAME : Xstar
  • INCLUDE : Mpreview
  • INCLUDE : Xbase
  • PATH : shader/description/xstar.res
  • PLUGIN : shader
  • MAXON online help (may not exist): XSTAR

Elements

ID UI Name Type Parameters Cycle
STARSHADER_COLOR1 Color1 COLOR  
STARSHADER_COLOR2 Color2 COLOR  
STARSHADER_STREAKS Streaks LONG
MIN 4
MAX 12
STARSHADER_INNERRADIUS InnerRadius REAL
UNIT PERCENT
MIN 0.0
MAX 1000.0
STARSHADER_OUTERRADIUS OuterRadius REAL
UNIT PERCENT
MIN 0.0
MAX 1000.0
STARSHADER_DENSITY Density REAL
MIN 1.0
MAX 100.0
STEP 0.1

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.Xstar)
    
    #You can set parameters two different ways. 
    #First way              
    shader[c4d.STARSHADER_STREAKS] = 1
    shader[c4d.STARSHADER_INNERRADIUS] = 0.1
    shader[c4d.STARSHADER_OUTERRADIUS] = 0.1
    shader[c4d.STARSHADER_DENSITY] = 0.1
    
    #Second way, using the base container.
    bc = shader.GetDataInstance()
    bc.SetInt32(c4d.STARSHADER_STREAKS,1)
    bc.SetFloat(c4d.STARSHADER_INNERRADIUS,0.1)
    bc.SetFloat(c4d.STARSHADER_OUTERRADIUS,0.1)
    bc.SetFloat(c4d.STARSHADER_DENSITY,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../shader/description/xstar.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseShader *pShader = BaseShader::Alloc(Xstar);  
    
    //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(STARSHADER_STREAKS),GeData(1),flags);
    pShader->SetParameter(DescID(STARSHADER_INNERRADIUS),GeData(0.1),flags);
    pShader->SetParameter(DescID(STARSHADER_OUTERRADIUS),GeData(0.1),flags);
    pShader->SetParameter(DescID(STARSHADER_DENSITY),GeData(0.1),flags);
    pShader->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pShader->GetDataInstance();
    bc->SetInt32(STARSHADER_STREAKS,1);
    bc->SetFloat(STARSHADER_INNERRADIUS,0.1);
    bc->SetFloat(STARSHADER_OUTERRADIUS,0.1);
    bc->SetFloat(STARSHADER_DENSITY,0.1);
    pShader->Message(MSG_UPDATE);                                                      
}