c4d.BaseMaterial ¶

Definition ¶

class c4d. BaseMaterial ¶

• BaseMaterial.__init__()

• BaseMaterial.Compare()
• BaseMaterial.GetPreview()
• BaseMaterial.GetAverageColor()
• BaseMaterial.Update()
• BaseMaterial.GetRenderInfo()

Inheritance ¶

• c4d.BaseList2D

  • c4d.BaseMaterial

    • c4d.Material

Members ¶

BaseMaterial. __init__ ( type ) ¶

Initialize a new BaseMaterial in memory.

Parameters:	type ( int ) – The material type : Material Types .
Return type:	c4d.BaseMaterial
Returns:	The new material.

BaseMaterial. Compare ( snd ) ¶

Check if the materials are identical.

Note

Only the name of the compared materials can be different.

Parameters:	snd ( c4d.BaseMaterial ) – The material to compare with.
Return type:	bool
Returns:	True if the materials contents are the same, otherwise False .

BaseMaterial. GetPreview ( [ flags=0 ] ) ¶

Retrieves the preview picture of the material.

Parameters:	flags ( int ) – Currently not used.
Return type:	c4d.bitmaps.BaseBitmap
Returns:	The preview picture or None if it has not been calculated.

BaseMaterial. GetAverageColor ( [ channel=NOTOK ] ) ¶

Returns an average color for the material, based on the material preview.

Parameters:	channel ( int ) – An optional specific channel to get the average for. CHANNEL_COLOR The color channel of the material. CHANNEL_LUMINANCE The luminance channel of the material. CHANNEL_TRANSPARENCY The transparency channel of the material. CHANNEL_REFLECTION The reflection channel of the material. CHANNEL_ENVIRONMENT The environment channel of the material. CHANNEL_FOG The fog channel of the material. CHANNEL_BUMP The bump channel of the material. CHANNEL_ALPHA The alpha channel of the material. CHANNEL_SPECULAR The specular channel of the material. CHANNEL_SPECULARCOLOR The specular color channel of the material. CHANNEL_GLOW The glow channel of the material. CHANNEL_DISPLACEMENT The displacement channel of the material. CHANNEL_DIFFUSION The diffusion channel of the material. CHANNEL_NORMAL The normal channel of the material. CHANNEL_ANY This specifies an unlabeled plugin channel.
Return type:	c4d.Vector
Returns:	Average color.

BaseMaterial. Update ( preview , rttm ) ¶

Recalculates the material’s thumbnail and updates internal values.

Note

Recalculating the thumbnail/RTTM image is time intensive. It only needs to be done if you want to let the user view the change. The calculations are done asynchronously.

Parameters:	preview ( bool ) – If this value is True then the preview thumbnail is updated. rttm ( bool ) – If this value is True then the real time texture map of the material will be recalculated.

BaseMaterial. GetRenderInfo ( ) ¶

Retrieves information about what the material requires from the raytracer and what it will return.

Return type:

int

Returns:

The return values are: VOLUMEINFO_0 None. VOLUMEINFO_REFLECTION Shader calculates reflections. VOLUMEINFO_TRANSPARENCY Shader calculates transparency. VOLUMEINFO_ALPHA Shader calculates alpha. VOLUMEINFO_CHANGENORMAL Shader calculates bump mapping. VOLUMEINFO_DISPLACEMENT Shader calculates displacement mapping. VOLUMEINFO_ENVREQUIRED Shader needs environment reflection data. VOLUMEINFO_DUDVREQUIRED Shader needs du/dv bump mapping data. VOLUMEINFO_MIPSAT Shader requires MIP/SAT data. VOLUMEINFO_VOLUMETRIC Shader is a volumetric shader. VOLUMEINFO_TRANSFORM Shader needs back-transformed data. VOLUMEINFO_EVALUATEPROJECTION Shader requires texture tag projections. VOLUMEINFO_PRIVATE_GLOW Private. VOLUMEINFO_INITCALCULATION Shader needs initcalculation call.

Table Of Contents

• c4d.BaseMaterial
  • Definition
  • Inheritance
  • Members