Home       Trees       Index       Help   

Blender

Module Material :: Class Material
[frames | no frames]

Class Material

The Material object

This object gives access to Materials in Blender.

Warning: Most member variables assume values in some [Min, Max] interval. When trying to set them, the given parameter will be clamped to lie in that range: if val < Min, then val = Min, if val > Max, then val = Max.

Method Summary
Material __copy__()
Make a copy of this material
  addScriptLink(text, event)
Add a new script link to this Material.
  clearIpo()
Unlink the ipo from this material.
  clearScriptLinks(links)
Delete script links from this Material.
  clearTexture(index)
Clear the ith (given by 'index') texture channel of this material.
float getAdd()
Get the glow factor.
float getAlpha()
Get the alpha (transparency) value.
float getAmb()
Get the ambient color blend factor.
float getDiffuseDarkness()
Get the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only)
int getDiffuseShader()
Get the material's diffuse shader from one of the shaders in Material.Shaders dict.
float getDiffuseSmooth()
Get the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only)
float getEmit()
Get the emitting light intensity.
float getFilter()
Get the material's amount of filtering when transparent raytrace is enabled
float getFlareBoost()
Get the flare's extra strength.
int getFlareSeed()
Get flare's offset in the seed table.
float getFlareSize()
Get the ratio: flareSize / haloSize.
float getFresnelMirr()
Get power of Fresnel for mirror reflection.
float getFresnelMirrFac()
Get the number of Ray Mirror.
float getFresnelTrans()
Get power of Fresnel for transparency.
float getFresnelTransFac()
Get blending factor for Fresnel.
int getHaloSeed()
Get the seed for random ring dimension and line location in halos.
float getHaloSize()
Get the halo size.
int getHardness()
Get the hardness of the specularity.
float getIOR()
Get the angular index of refraction for raytrace.
Ipo getIpo()
Get the Ipo associated with this material, if any.
list of 3 floats getMirCol()
Get the mirror color triplet sequence.
int getMode()
Get this Material's mode flags.
string getName()
Get the name of this Material object.
int getNFlares()
Get the number of halo subflares.
int getNLines()
Get the number of star shaped lines on each halo.
int getNRings()
Get the number of rings on each halo.
int getNStars()
Get the number of points in the halo stars.
float getRayMirr()
Get amount mirror reflection for raytrace.
int getRayMirrDepth()
Get amount of inter-reflections calculated maximal.
float getRef()
Get the reflectivity value.
float getRefracIndex()
Get the material's Index of Refraction (applies to the "Blinn" Specular Shader only)
list of 3 floats getRGBCol()
Get the rgb color triplet sequence.
float getRms()
Get the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only)
float getRoughness()
Get the material's roughness (applies to the "Oren Nayar" Diffuse Shader only)
list getScriptLinks(event)
Get a list with this Material's script links of type 'event'.
float getSpec()
Get the specularity value.
list of 3 floats getSpecCol()
Get the specular color triplet sequence.
int getSpecShader(specShader)
Get the material's specular shader from one of the shaders in Material.Shaders dict.
float getSpecSize()
Get the material's size of diffuse area (applies to the "Toon" Diffuse Shader only)
float getSpecSmooth()
Get the material's smoothing of specular area (applies to the "Toon" Specular Shader only)
float getSpecTransp()
Get the specular transparency.
float getSubSize()
Get the dimension of subflare, dots and circles.
list of MTex getTextures()
Get this Material's Texture list.
int getTransDepth()
Get amount of refractions calculated maximal.
float getTranslucency()
Get the material's amount of diffuse shading of the back side
float getZOffset()
Get the artificial offset for faces with this Material.
  insertIpoKey(keytype)
Inserts keytype values in material ipo at curframe.
  setAdd(add)
Set the glow factor.
  setAlpha(alpha)
Set the alpha (transparency) value.
  setAmb(amb)
Set the ambient color blend factor.
  setDiffuseDarkness(diffuseDarkness)
Set the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only)
  setDiffuseShader(diffuseShader)
Set the material's diffuse shader from one of the shaders in Material.Shaders dict.
  setDiffuseSmooth(diffuseSmooth)
Set the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only)
  setEmit(emit)
Set the emitting light intensity.
  setFilter(filter)
Set the material's amount of filtering when transparent raytrace is enabled
  setFlareBoost(flareboost)
Set the flare's extra strength.
  setFlareSeed(flareseed)
Set flare's offset in the seed table.
  setFlareSize(flaresize)
Set the ratio: flareSize / haloSize.
  setFresnelMirr(nrmirr)
Set power of Fresnel for mirror reflection.
  setFresnelMirrFac(nrmirr)
Set the number of ray mirror
  setFresnelTrans(nrmirr)
Set power of Fresnel for transparency.
  setFresnelTransFac(nrmirr)
Set blending factor for Fresnel.
  setHaloSeed(haloseed)
Set the seed for random ring dimension and line location in halos.
  setHaloSize(halosize)
Set the halo size.
  setHardness(hardness)
Set the hardness of the specularity.
  setIOR(nrmirr)
Set the angular index of refraction for raytrace.
  setIpo(ipo)
Link an ipo to this material.
  setMirCol(rgb)
Set the mirror color triplet sequence.
  setMode(param, stringN)
Set this Material's mode flags.
  setName(name)
Set the name of this Material object.
  setNFlares(nflares)
Set the number of halo subflares.
  setNLines(nlines)
Set the number of star shaped lines on each halo.
  setNRings(nrings)
Set the number of rings on each halo.
  setNStars(nstars)
Set the number of points in the halo stars.
  setRayMirr(nrmirr)
Set amount mirror reflection for raytrace.
  setRayMirrDepth(nrmirr)
Set amount mirror reflection for raytrace.
  setRef(ref)
Set the reflectivity value.
  setRefracIndex(refracIndex)
Set the material's Index of Refraction (applies to the "Blinn" Specular Shader only)
  setRGBCol(rgb)
Set the rgb color triplet sequence.
  setRms(rms)
Set the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only)
  setRoughness(roughness)
Set the material's roughness (applies to the "Oren Nayar" Diffuse Shader only)
  setSpec(spec)
Set the specularity value.
  setSpecCol(rgb)
Set the specular color triplet sequence.
  setSpecShader(specShader)
Set the material's specular shader from one of the shaders in Material.Shaders dict.
  setSpecSize(diffuseSize)
Set the material's size of diffuse area (applies to the "Toon" Diffuse Shader only)
  setSpecSmooth(specSmooth)
Set the material's smoothing of specular area (applies to the "Toon" Specular Shader only)
  setSpecTransp(spectransp)
Set the specular transparency.
  setSubSize(subsize)
Set the dimension of subflare, dots and circles.
  setTexture(index, texture, texco, mapto)
Assign a Blender Texture object to slot number 'number'.
  setTransDepth(nrmirr)
Set amount of refractions calculated maximal.
  setTranslucency(translucency)
Set the material's amount of diffuse shading of the back side
  setZOffset(zoffset)
Set the artificial offset for faces with this Material.

Instance Variable Summary
float add: Strength of the add effect.
float alpha: Alpha (translucency) component of the material.
float amb: Amount of global ambient color material receives.
float B: Diffuse color (rgbCol) blue component.
list colorband: Material colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos].
list colorbandDiffuse: Material colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos].
list colorbandSpecular: Material colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos].
float diffuseDarkness: Material's diffuse darkness ("Minnaert" diffuse shader only).
int diffuseShader: Diffuse shader type (see Shaders).
float diffuseSize: Material's diffuse area size ("Toon" diffuse shader only).
float diffuseSmooth: Material's diffuse area smoothing ("Toon" diffuse shader only).
float emit: Amount of light the material emits.
bool enableSSS: If True, subsurface scattering will be rendered on this material.
bool fakeUser: When set to True, this datablock wont be removed, even if nothing is using it.
float filter: Amount of filtering when transparent raytrace is enabled.
float flareBoost: Flare's extra strength.
int flareSeed: Offset in the flare seed table.
float flareSize: Ratio of flare size to halo size.
float fresnelDepth: Power of Fresnel for mirror reflection.
float fresnelDepthFac: Blending factor for Fresnel mirror.
float fresnelTrans: Power of Fresnel for transparency.
float fresnelTransFac: Blending factor for Fresnel transparency.
float G: Diffuse color (rgbCol) green component.
int haloSeed: Randomizes halo ring dimension and line location.
float haloSize: Dimension of the halo.
int hard: Hardness of the specularity.
float IOR: Angular index of refraction for raytrace.
Blender Ipo ipo: Material Ipo data.
string or None lib: path to the blend file this datablock is stored in (readonly).
Group or None lightGroup: Limits lights that affect this material to a group.
float mirB: Mirror color (mirCol) blue component.
list of 3 floats mirCol: Mirror RGB color triplet.
float mirG: Mirror color (mirCol) green component.
float mirR: Mirror color (mirCol) red component.
int mode: Mode mode bitfield.
string name: unique name within each blend file.
int nFlares: Number of subflares with halo.
int nLines: Number of star-shaped lines with halo.
int nRings: Number of rings with halo.
int nStars: Number of star points with halo.
list of 2 floats oopsLoc: Material OOPs location.
int oopsSel: Material OOPs selection flag.
IDGroup properties: Returns an IDGroup reference to this datablocks's ID Properties.
float R: Diffuse color (rgbCol) red component.
float rayMirr: Mirror reflection amount for raytrace.
int rayMirrDepth: Amount of raytrace inter-reflections.
float rbFriction: Rigid Body Friction coefficient.
float rbRestitution: Rigid Body Friction restitution.
float ref: Amount of reflections (for shader).
float refracIndex: Material's Index of Refraction (applies to the "Blinn" Specular Shader only.
list of 3 floats rgbCol: Diffuse RGB color triplet.
float rms: Material's surface slope standard deviation ("WardIso" specular shader only).
float roughness: Material's roughness ("Oren Nayar" diffuse shader only).
float shadAlpha: Shadow Alpha for irregular shadow buffer.
float spec: Degree of specularity.
float specB: Specular color (specCol) blue component.
list of 3 floats specCol: Specular RGB color triplet.
float specG: Specular color (specCol) green component.
float specR: Specular color (specCol) red component.
int specShader: Specular shader type.
float specSize: Material's specular area size ("Toon" specular shader only).
float specSmooth: Sets the smoothness of specular toon area.
float specTransp: Makes specular areas opaque on transparent materials.
float sssB: SubSsurface scattering color (sssCol) blue component.
float sssBack: Back scattering weight Value is clamped to the range [0.0,10.0].
list of 3 floats sssCol: SubSsurface scattering RGB color triplet.
float sssColorBlend: Blend factor for SSS colors.
float sssError: Error allowance for the calculation (a low value is slower).
float sssFront: Front scattering weight.
float sssG: SubSsurface scattering color (sssCol) green component.
float sssIOR: Refraction index.
float sssR: SubSsurface scattering color (sssCol) red component.
float sssRadiusBlue: Mean blue scattering path length.
float sssRadiusGreen: Mean green scattering path length.
float sssRadiusRed: Mean red scattering path length.
bool sssScale: If True, subsurface scattering will be rendered on this material.
float sssTextureScatter: Texture scattering factor.
float subSize: Dimension of subflares, dots and circles.
bool tag: A temporary tag that to flag data as being used within a loop.
int transDepth: calculated maximal.
float translucency: Amount of diffuse shading of the back side.
int users: The number of users this datablock has.
string uvlayer: The uv layer name to use, when UV mapping is enabled.
float zOffset: Artificial offset in the Z buffer (for Ztransp option).

Method Details

__copy__()

Make a copy of this material
Returns:
a copy of this material
           (type=Material)

addScriptLink(text, event)

Add a new script link to this Material.
Parameters:
text - the name of an existing Blender Text.
           (type=string)
event - "FrameChanged" or "Redraw".
           (type=string)

clearIpo()

Unlink the ipo from this material.
Returns:
True if there was an ipo linked or False otherwise.

clearScriptLinks(links=None)

Delete script links from this Material. If no list is specified, all script links are deleted.
Parameters:
links - None (default) or a list of Blender Text names.
           (type=list of strings)

clearTexture(index)

Clear the ith (given by 'index') texture channel of this material.
Parameters:
index - material's texture channel index in [0, 9].
           (type=int)

getAdd()

Get the glow factor.
Returns:
float

getAlpha()

Get the alpha (transparency) value.
Returns:
float

getAmb()

Get the ambient color blend factor.
Returns:
float

getDiffuseDarkness()

Get the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only)
Returns:
float

getDiffuseShader()

Get the material's diffuse shader from one of the shaders in Material.Shaders dict.
Returns:
int

getDiffuseSmooth()

Get the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only)
Returns:
float

getEmit()

Get the emitting light intensity.
Returns:
float

getFilter()

Get the material's amount of filtering when transparent raytrace is enabled
Returns:
float

getFlareBoost()

Get the flare's extra strength.
Returns:
float

getFlareSeed()

Get flare's offset in the seed table.
Returns:
int

getFlareSize()

Get the ratio: flareSize / haloSize.
Returns:
float

getFresnelMirr()

Get power of Fresnel for mirror reflection.
Returns:
float

getFresnelMirrFac()

Get the number of Ray Mirror.
Returns:
float

getFresnelTrans()

Get power of Fresnel for transparency.
Returns:
float

getFresnelTransFac()

Get blending factor for Fresnel.
Returns:
float

getHaloSeed()

Get the seed for random ring dimension and line location in halos.
Returns:
int

getHaloSize()

Get the halo size.
Returns:
float

getHardness()

Get the hardness of the specularity.
Returns:
int

getIOR()

Get the angular index of refraction for raytrace.
Returns:
float

getIpo()

Get the Ipo associated with this material, if any.
Returns:
the wrapped ipo or None.
           (type=Ipo)

getMirCol()

Get the mirror color triplet sequence.
Returns:
[mirR, mirG, mirb]
           (type=list of 3 floats)

getMode()

Get this Material's mode flags.
Returns:

OR'ed value. Use the Modes dictionary to check which flags are 'on'.

Example: 
       import Blender
       from Blender import Material
       flags = mymat.getMode()
       if flags & Material.Modes['HALO']:
               print "This material is rendered as a halo"
       else:
               print "Not a halo"

           (type=int)

getName()

Get the name of this Material object.
Returns:
string

getNFlares()

Get the number of halo subflares.
Returns:
int

getNLines()

Get the number of star shaped lines on each halo.
Returns:
int

getNRings()

Get the number of rings on each halo.
Returns:
int

getNStars()

Get the number of points in the halo stars.
Returns:
int

getRayMirr()

Get amount mirror reflection for raytrace.
Returns:
float

getRayMirrDepth()

Get amount of inter-reflections calculated maximal.
Returns:
int

getRef()

Get the reflectivity value.
Returns:
float

getRefracIndex()

Get the material's Index of Refraction (applies to the "Blinn" Specular Shader only)
Returns:
float

getRGBCol()

Get the rgb color triplet sequence.
Returns:
[r, g, b]
           (type=list of 3 floats)

getRms()

Get the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only)
Returns:
float

getRoughness()

Get the material's roughness (applies to the "Oren Nayar" Diffuse Shader only)
Returns:
float

getScriptLinks(event)

Get a list with this Material's script links of type 'event'.
Parameters:
event - "FrameChanged" or "Redraw".
           (type=string)
Returns:
a list with Blender Text names (the script links of the given 'event' type) or None if there are no script links at all.
           (type=list)

getSpec()

Get the specularity value.
Returns:
float

getSpecCol()

Get the specular color triplet sequence.
Returns:
[specR, specG, specB]
           (type=list of 3 floats)

getSpecShader(specShader)

Get the material's specular shader from one of the shaders in Material.Shaders dict.
Returns:
int

getSpecSize()

Get the material's size of diffuse area (applies to the "Toon" Diffuse Shader only)
Returns:
float

getSpecSmooth()

Get the material's smoothing of specular area (applies to the "Toon" Specular Shader only)
Returns:
float

getSpecTransp()

Get the specular transparency.
Returns:
float

getSubSize()

Get the dimension of subflare, dots and circles.
Returns:
float

getTextures()

Get this Material's Texture list.
Returns:
a list of Blender MTex objects. None is returned for each empty texture slot.
           (type=list of MTex)

getTransDepth()

Get amount of refractions calculated maximal.
Returns:
int

getTranslucency()

Get the material's amount of diffuse shading of the back side
Returns:
float

getZOffset()

Get the artificial offset for faces with this Material.
Returns:
float

insertIpoKey(keytype)

Inserts keytype values in material ipo at curframe. Uses module constants.
Parameters:
keytype - -RGB -ALPHA -HALOSIZE -MODE -ALLCOLOR -ALLMIRROR -OFS -SIZE -ALLMAPPING
           (type=Integer)
Returns:
py_none

setAdd(add)

Set the glow factor.
Parameters:
add - The new value in [0.0, 1.0].
           (type=float)

setAlpha(alpha)

Set the alpha (transparency) value.
Parameters:
alpha - The new value in [0.0, 1.0].
           (type=float)

setAmb(amb)

Set the ambient color blend factor.
Parameters:
amb - The new value in [0.0, 1.0].
           (type=float)

setDiffuseDarkness(diffuseDarkness)

Set the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only)
Parameters:
diffuseDarkness - The new value in [0.0, 2.0].
           (type=float)

setDiffuseShader(diffuseShader)

Set the material's diffuse shader from one of the shaders in Material.Shaders dict.
Parameters:
diffuseShader - The new value in [0, 3].
           (type=int)

setDiffuseSmooth(diffuseSmooth)

Set the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only)
Parameters:
diffuseSmooth - The new value in [0.0, 1.0].
           (type=float)

setEmit(emit)

Set the emitting light intensity.
Parameters:
emit - The new value in [0.0, 1.0].
           (type=float)

setFilter(filter)

Set the material's amount of filtering when transparent raytrace is enabled
Parameters:
filter - The new value in [0.0, 1.0].
           (type=float)

setFlareBoost(flareboost)

Set the flare's extra strength.
Parameters:
flareboost - The new value in [0.1, 10.0].
           (type=float)

setFlareSeed(flareseed)

Set flare's offset in the seed table.
Parameters:
flareseed - The new value in [0, 255].
           (type=int)

setFlareSize(flaresize)

Set the ratio: flareSize / haloSize.
Parameters:
flaresize - The new value in [0.1, 25.0].
           (type=float)

setFresnelMirr(nrmirr)

Set power of Fresnel for mirror reflection.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=float)

setFresnelMirrFac(nrmirr)

Set the number of ray mirror
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=float)

setFresnelTrans(nrmirr)

Set power of Fresnel for transparency.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=float)

setFresnelTransFac(nrmirr)

Set blending factor for Fresnel.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=float)

setHaloSeed(haloseed)

Set the seed for random ring dimension and line location in halos.
Parameters:
haloseed - The new value in [0, 255].
           (type=int)

setHaloSize(halosize)

Set the halo size.
Parameters:
halosize - The new value in [0.0, 100.0].
           (type=float)

setHardness(hardness)

Set the hardness of the specularity.
Parameters:
hardness - The new value in [1, 511].
           (type=int)

setIOR(nrmirr)

Set the angular index of refraction for raytrace.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=float)

setIpo(ipo)

Link an ipo to this material.
Parameters:
ipo - a material type ipo.
           (type=Blender Ipo)

setMirCol(rgb=None)

Set the mirror color triplet sequence. If rgb is None, set the color to black.
Parameters:
rgb - The rgb color values in [0.0, 1.0] as:
  • a list of three floats: setMirCol ([r, g, b]) or
  • three floats as separate parameters: setMirCol (r,g,b).

           (type=three floats or a list of three floats)

setMode(param, stringN=None)

Set this Material's mode flags. Up to 22 mode strings can be given and specify the modes which are turned 'on'. Those not provided are turned 'off', so mat.setMode() -- without arguments -- turns off all mode flags for Material mat. Valid mode strings are "Traceable", "Shadow", "Shadeless", "Wire", "VColLight", "VColPaint", "Halo", "ZTransp", "ZInvert", "HaloRings", "HaloLines", "OnlyShadow", "HaloXAlpha", "HaloStar", "TexFace", "HaloTex", "HaloPuno", "NoMist", "HaloShaded", "HaloFlare", "Radio", "RayMirr", "ZTransp", "RayTransp", "Env"

An integer can also be given, which directly sets the mode flag. The Modes dictionary keys can (and should) be added or ORed to specify which modes to turn 'on'. The value returned from getMode() can also be modified and input to this method.
Parameters:
param - A mode value (int) or flag (string). Can also be None.
           (type=string, None or int)
stringN - A mode flag. Up to 22 flags can be set at the same time.
           (type=string)

setName(name)

Set the name of this Material object.
Parameters:
name - The new name.
           (type=string)

setNFlares(nflares)

Set the number of halo subflares.
Parameters:
nflares - The new value in [1, 32].
           (type=int)

setNLines(nlines)

Set the number of star shaped lines on each halo.
Parameters:
nlines - The new value in [0, 250].
           (type=int)

setNRings(nrings)

Set the number of rings on each halo.
Parameters:
nrings - The new value in [0, 24].
           (type=int)

setNStars(nstars)

Set the number of points in the halo stars.
Parameters:
nstars - The new value in [3, 50].
           (type=int)

setRayMirr(nrmirr)

Set amount mirror reflection for raytrace.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=float)

setRayMirrDepth(nrmirr)

Set amount mirror reflection for raytrace.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=int)

setRef(ref)

Set the reflectivity value.
Parameters:
ref - The new value in [0.0, 1.0].
           (type=float)

setRefracIndex(refracIndex)

Set the material's Index of Refraction (applies to the "Blinn" Specular Shader only)
Parameters:
refracIndex - The new value in [1.0, 10.0].
           (type=float)

setRGBCol(rgb=None)

Set the rgb color triplet sequence. If rgb is None, set the color to black.
Parameters:
rgb - The rgb color values in [0.0, 1.0] as:
  • a list of three floats: setRGBCol ([r, g, b]) or
  • three floats as separate parameters: setRGBCol (r,g,b).

           (type=three floats or a list of three floats)

setRms(rms)

Set the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only)
Parameters:
rms - The new value in [0.0, 0.4].
           (type=float)

setRoughness(roughness)

Set the material's roughness (applies to the "Oren Nayar" Diffuse Shader only)
Parameters:
roughness - The new value in [0.0, 3.14].
           (type=float)

setSpec(spec)

Set the specularity value.
Parameters:
spec - The new value in [0.0, 2.0].
           (type=float)

setSpecCol(rgb=None)

Set the specular color triplet sequence. If rgb is None, set the color to black.
Parameters:
rgb - The rgb color values in [0.0, 1.0] as:
  • a list of three floats: setSpecCol ([r, g, b]) or
  • three floats as separate parameters: setSpecCol (r,g,b).

           (type=three floats or a list of three floats)

setSpecShader(specShader)

Set the material's specular shader from one of the shaders in Material.Shaders dict.
Parameters:
specShader - The new value in [0, 4].
           (type=int)

setSpecSize(diffuseSize)

Set the material's size of diffuse area (applies to the "Toon" Diffuse Shader only)
Parameters:
diffuseSize - The new value in [0.0, 3.14].
           (type=float)

setSpecSmooth(specSmooth)

Set the material's smoothing of specular area (applies to the "Toon" Specular Shader only)
Parameters:
specSmooth - The new value in [0.0, 1.0].
           (type=float)

setSpecTransp(spectransp)

Set the specular transparency.
Parameters:
spectransp - The new value in [0.0, 1.0].
           (type=float)

setSubSize(subsize)

Set the dimension of subflare, dots and circles.
Parameters:
subsize - The new value in [0.1, 25.0].
           (type=float)

setTexture(index, texture, texco, mapto)

Assign a Blender Texture object to slot number 'number'.
Parameters:
index - material's texture index in [0, 9].
           (type=int)
texture - a Blender Texture object.
           (type=Blender Texture)
texco - optional ORed bitflag -- defaults to TexCo.ORCO. See TexCo var in Texture.
           (type=int)
mapto - optional ORed bitflag -- defaults to MapTo.COL. See MapTo var in Texture.
           (type=int)

setTransDepth(nrmirr)

Set amount of refractions calculated maximal.
Parameters:
nrmirr - The new value in [0.0, 1.0].
           (type=int)

setTranslucency(translucency)

Set the material's amount of diffuse shading of the back side
Parameters:
translucency - The new value in [0.0, 1.0].
           (type=float)

setZOffset(zoffset)

Set the artificial offset for faces with this Material.
Parameters:
zoffset - The new value in [0.0, 10.0].
           (type=float)

Instance Variable Details

add

Strength of the add effect. Value is clamped to the range [0.0,1.0].
Type:
float

alpha

Alpha (translucency) component of the material. Value is clamped to the range [0.0,1.0].
Type:
float

amb

Amount of global ambient color material receives. Value is clamped to the range [0.0,1.0].
Type:
float

B

Diffuse color (rgbCol) blue component. Value is clamped to the range [0.0,1.0].
Type:
float

colorband

Material colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos]. The colorband can have between 1 and 31 colors.
Type:
list

colorbandDiffuse

Material colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos]. The colorband can have between 1 and 31 colors.
Type:
list

colorbandSpecular

Material colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos]. The colorband can have between 1 and 31 colors.
Type:
list

diffuseDarkness

Material's diffuse darkness ("Minnaert" diffuse shader only). Value is clamped to the range [0.0,2.0].
Type:
float

diffuseShader

Diffuse shader type (see Shaders). Value must be in the range [0,3].
Type:
int

diffuseSize

Material's diffuse area size ("Toon" diffuse shader only). Value is clamped to the range [0.0,3.14].
Type:
float

diffuseSmooth

Material's diffuse area smoothing ("Toon" diffuse shader only). Value is clamped to the range [0.0,1.0].
Type:
float

emit

Amount of light the material emits. Value is clamped to the range [0.0,1.0].
Type:
float

enableSSS

If True, subsurface scattering will be rendered on this material.
Type:
bool

fakeUser

When set to True, this datablock wont be removed, even if nothing is using it. All data has this disabled by default except for Actions.
Type:
bool

filter

Amount of filtering when transparent raytrace is enabled. Value is clamped to the range [0.0,1.0].
Type:
float

flareBoost

Flare's extra strength. Value is clamped to the range [0.1,1.0].
Type:
float

flareSeed

Offset in the flare seed table. Value is clamped to the range [1,255].
Type:
int

flareSize

Ratio of flare size to halo size. Value is clamped to the range [0.1,25.0].
Type:
float

fresnelDepth

Power of Fresnel for mirror reflection. Value is clamped to the range [0.0,5.0].
Type:
float

fresnelDepthFac

Blending factor for Fresnel mirror. Value is clamped to the range [1.0,5.0].
Type:
float

fresnelTrans

Power of Fresnel for transparency. Value is clamped to the range [0.0,5.0].
Type:
float

fresnelTransFac

Blending factor for Fresnel transparency. Value is clamped to the range [1.0,5.0].
Type:
float

G

Diffuse color (rgbCol) green component. Value is clamped to the range [0.0,1.0].
Type:
float

haloSeed

Randomizes halo ring dimension and line location. Value is clamped to the range [1,255].
Type:
int

haloSize

Dimension of the halo. Value is clamped to the range [0.0,100.0].
Type:
float

hard

Hardness of the specularity. Value is clamped to the range [1,255].
Type:
int

IOR

Angular index of refraction for raytrace. Value is clamped to the range [1.0,3.0].
Type:
float

ipo

Material Ipo data. Contains the Ipo if one is assigned to the object, None otherwise. Setting to None clears the current Ipo.
Type:
Blender Ipo

lib

path to the blend file this datablock is stored in (readonly).

lib will be None unless you are using external blend files with (File, Append/Link)

Note: the path may be relative, to get the full path use Blender.sys.expandpath
Type:
string or None

lightGroup

Limits lights that affect this material to a group.
Type:
Group or None

mirB

Mirror color (mirCol) blue component. Value is clamped to the range [0.0,1.0].
Type:
float

mirCol

Mirror RGB color triplet. Components are clamped to the range [0.0,1.0].
Type:
list of 3 floats

mirG

Mirror color (mirCol) green component. Value is clamped to the range [0.0,1.0].
Type:
float

mirR

Mirror color (mirCol) red component. Value is clamped to the range [0.0,1.0].
Type:
float

mode

Mode mode bitfield. See the Modes dictionary keys and descriptions.
Type:
int

name

unique name within each blend file.

The name is case sensitive and 21 characters maximum length.

Note: a blend file may have naming collisions when external library data is used, be sure to check the value of lib.

Note: Setting a value longer then 21 characters will be shortened
Type:
string

nFlares

Number of subflares with halo. Value is clamped to the range [1,32].
Type:
int

nLines

Number of star-shaped lines with halo. Value is clamped to the range [0,250].
Type:
int

nRings

Number of rings with halo. Value is clamped to the range [0,24].
Type:
int

nStars

Number of star points with halo. Value is clamped to the range [3,50].
Type:
int

oopsLoc

Material OOPs location. Returns None if material not found in list.
Type:
list of 2 floats

oopsSel

Material OOPs selection flag. Value must be in the range [0,1].
Type:
int

properties

Returns an IDGroup reference to this datablocks's ID Properties.
Type:
IDGroup

R

Diffuse color (rgbCol) red component. Value is clamped to the range [0.0,1.0].
Type:
float

rayMirr

Mirror reflection amount for raytrace. Value is clamped to the range [0.0,1.0].
Type:
float

rayMirrDepth

Amount of raytrace inter-reflections. Value is clamped to the range [0,10].
Type:
int

rbFriction

Rigid Body Friction coefficient. Value is clamped to the range [0.0,100.0].
Type:
float

rbRestitution

Rigid Body Friction restitution. Value is clamped to the range [0.0,1.0].
Type:
float

ref

Amount of reflections (for shader). Value is clamped to the range [0.0,1.0].
Type:
float

refracIndex

Material's Index of Refraction (applies to the "Blinn" Specular Shader only. Value is clamped to the range [1.0,10.0].
Type:
float

rgbCol

Diffuse RGB color triplet. Components are clamped to the range [0.0,1.0].
Type:
list of 3 floats

rms

Material's surface slope standard deviation ("WardIso" specular shader only). Value is clamped to the range [0.0,0.4].
Type:
float

roughness

Material's roughness ("Oren Nayar" diffuse shader only). Value is clamped to the range [0.0,3.14].
Type:
float

shadAlpha

Shadow Alpha for irregular shadow buffer. Value is clamped to the range [0.0,1.0].
Type:
float

spec

Degree of specularity. Value is clamped to the range [0.0,2.0].
Type:
float

specB

Specular color (specCol) blue component. Value is clamped to the range [0.0,1.0].
Type:
float

specCol

Specular RGB color triplet. Components are clamped to the range [0.0,1.0].
Type:
list of 3 floats

specG

Specular color (specCol) green component. Value is clamped to the range [0.0,1.0].
Type:
float

specR

Specular color (specCol) red component. Value is clamped to the range [0.0,1.0].
Type:
float

specShader

Specular shader type. See Shaders. Value must be in the range [0,4].
Type:
int

specSize

Material's specular area size ("Toon" specular shader only). Value is clamped to the range [0.0,1.53].
Type:
float

specSmooth

Sets the smoothness of specular toon area. Value is clamped to the range [0.0,1.0].
Type:
float

specTransp

Makes specular areas opaque on transparent materials. Value is clamped to the range [0.0,1.0].
Type:
float

sssB

SubSsurface scattering color (sssCol) blue component. Value is clamped to the range [0.0,1.0].
Type:
float

sssBack

Back scattering weight Value is clamped to the range [0.0,10.0].
Type:
float

sssCol

SubSsurface scattering RGB color triplet. Components are clamped to the range [0.0,1.0].
Type:
list of 3 floats

sssColorBlend

Blend factor for SSS colors. Value is clamped to the range [0.0,1.0].
Type:
float

sssError

Error allowance for the calculation (a low value is slower). Value is clamped to the range [0.0,10.0].
Type:
float

sssFront

Front scattering weight. Value is clamped to the range [0.0,2.0].
Type:
float

sssG

SubSsurface scattering color (sssCol) green component. Value is clamped to the range [0.0,1.0].
Type:
float

sssIOR

Refraction index. Value is clamped to the range [0.1,2.0].
Type:
float

sssR

SubSsurface scattering color (sssCol) red component. Value is clamped to the range [0.0,1.0].
Type:
float

sssRadiusBlue

Mean blue scattering path length. Value is clamped to the range [0.0,10000.0].
Type:
float

sssRadiusGreen

Mean green scattering path length. Value is clamped to the range [0.0,10000.0].
Type:
float

sssRadiusRed

Mean red scattering path length. Value is clamped to the range [0.0,10000.0].
Type:
float

sssScale

If True, subsurface scattering will be rendered on this material. Value is clamped to the range [0.1,1000.0].
Type:
bool

sssTextureScatter

Texture scattering factor. Value is clamped to the range [0.0,1.0].
Type:
float

subSize

Dimension of subflares, dots and circles. Value is clamped to the range [0.1,25.0].
Type:
float

tag

A temporary tag that to flag data as being used within a loop. always set all tags to True or False before using since blender uses this flag for its own internal operations.
Type:
bool

transDepth

calculated maximal. Amount of refractions for raytrace. Value is clamped to the range [0,10].
Type:
int

translucency

Amount of diffuse shading of the back side. Value is clamped to the range [0.0,1.0].
Type:
float

users

The number of users this datablock has. (readonly) Zero user datablocks are de-allocated after reloading and saving.
Type:
int

uvlayer

The uv layer name to use, when UV mapping is enabled.
Type:
string

zOffset

Artificial offset in the Z buffer (for Ztransp option). Value is clamped to the range [0.0,10.0].
Type:
float

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Thu May 10 20:32:00 2007 http://epydoc.sf.net