Home | Trees | Index | Help |
|
---|
Module Material :: Class Material |
|
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 | |
---|---|
Add a new script link to this Material. | |
Unlink the ipo from this material. | |
Delete script links from this Material. | |
Clear the ith (given by 'index') texture channel of this material. | |
float |
Get the glow factor. |
float |
Get the alpha (transparency) value. |
float |
Get the ambient color blend factor. |
float |
Get the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only) |
int |
Get the material's diffuse shader from one of the shaders in Material.Shaders dict. |
float |
Get the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only) |
float |
Get the emitting light intensity. |
float |
Get the material's amount of filtering when transparent raytrace is enabled |
float |
Get the flare's extra strength. |
int |
Get flare's offset in the seed table. |
float |
Get the ratio: flareSize / haloSize. |
float |
Get power of Fresnel for mirror reflection. |
float |
Get the number of Ray Mirror. |
float |
Get power of Fresnel for transparency. |
float |
Get blending factor for Fresnel. |
int |
Get the seed for random ring dimension and line location in halos. |
float |
Get the halo size. |
int |
Get the hardness of the specularity. |
float |
Get the angular index of refraction for raytrace. |
Ipo |
Get the Ipo associated with this material, if any. |
list of 3 floats |
Get the mirror color triplet sequence. |
int |
Get this Material's mode flags. |
string |
Get the name of this Material object. |
int |
Get the number of halo subflares. |
int |
Get the number of star shaped lines on each halo. |
int |
Get the number of rings on each halo. |
int |
Get the number of points in the halo stars. |
float |
Get amount mirror reflection for raytrace. |
int |
Get amount of inter-reflections calculated maximal. |
float |
Get the reflectivity value. |
float |
Get the material's Index of Refraction (applies to the "Blinn" Specular Shader only) |
list of 3 floats |
Get the rgb color triplet sequence. |
float |
Get the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only) |
float |
Get the material's roughness (applies to the "Oren Nayar" Diffuse Shader only) |
list |
Get a list with this Material's script links of type 'event'. |
float |
Get the specularity value. |
list of 3 floats |
Get the specular color triplet sequence. |
int |
Get the material's specular shader from one of the shaders in Material.Shaders dict. |
float |
Get the material's size of diffuse area (applies to the "Toon" Diffuse Shader only) |
float |
Get the material's smoothing of specular area (applies to the "Toon" Specular Shader only) |
float |
Get the specular transparency. |
float |
Get the dimension of subflare, dots and circles. |
list of MTex |
Get this Material's Texture list. |
int |
Get amount of refractions calculated maximal. |
float |
Get the material's amount of diffuse shading of the back side |
float |
Get the artificial offset for faces with this Material. |
Inserts keytype values in material ipo at curframe. | |
Set the glow factor. | |
Set the alpha (transparency) value. | |
Set the ambient color blend factor. | |
Set the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only) | |
Set the material's diffuse shader from one of the shaders in Material.Shaders dict. | |
Set the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only) | |
Set the emitting light intensity. | |
Set the material's amount of filtering when transparent raytrace is enabled | |
Set the flare's extra strength. | |
Set flare's offset in the seed table. | |
Set the ratio: flareSize / haloSize. | |
Set power of Fresnel for mirror reflection. | |
Set the number of ray mirror | |
Set power of Fresnel for transparency. | |
Set blending factor for Fresnel. | |
Set the seed for random ring dimension and line location in halos. | |
Set the halo size. | |
Set the hardness of the specularity. | |
Set the angular index of refraction for raytrace. | |
Link an ipo to this material. | |
Set the mirror color triplet sequence. | |
Set this Material's mode flags. | |
Set the name of this Material object. | |
Set the number of halo subflares. | |
Set the number of star shaped lines on each halo. | |
Set the number of rings on each halo. | |
Set the number of points in the halo stars. | |
Set amount mirror reflection for raytrace. | |
Set amount mirror reflection for raytrace. | |
Set the reflectivity value. | |
Set the material's Index of Refraction (applies to the "Blinn" Specular Shader only) | |
Set the rgb color triplet sequence. | |
Set the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only) | |
Set the material's roughness (applies to the "Oren Nayar" Diffuse Shader only) | |
Set the specularity value. | |
Set the specular color triplet sequence. | |
Set the material's specular shader from one of the shaders in Material.Shaders dict. | |
Set the material's size of diffuse area (applies to the "Toon" Diffuse Shader only) | |
Set the material's smoothing of specular area (applies to the "Toon" Specular Shader only) | |
Set the specular transparency. | |
Set the dimension of subflare, dots and circles. | |
Assign a Blender Texture object to slot number 'number'. | |
Set amount of refractions calculated maximal. | |
Set the material's amount of diffuse shading of the back side | |
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. |
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. |
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. |
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. |
str | name : Material data name. |
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. |
float | R : Diffuse color (rgbCol ) red component. |
float | rayMirr : Mirror reflection amount for raytrace. |
int | rayMirrDepth : Amount of raytrace inter-reflections. |
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 | 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 | subSize : Dimension of subflares, dots and circles. |
int | transDepth : calculated maximal. |
float | translucency : Amount of diffuse shading of the back side. |
int | users : Number of material users. |
float | zOffset : Artificial offset in the Z buffer (for Ztransp option). |
Method Details |
---|
addScriptLink(text, event)Add a new script link to this Material.
|
clearIpo()Unlink the ipo from this material.
|
clearScriptLinks(links=None)Delete script links from this Material. If no list is specified, all script links are deleted.
|
clearTexture(index)Clear the ith (given by 'index') texture channel of this material.
|
getAdd()Get the glow factor.
|
getAlpha()Get the alpha (transparency) value.
|
getAmb()Get the ambient color blend factor.
|
getDiffuseDarkness()Get the material's diffuse darkness (applies to the "Minnaert" Diffuse Shader only)
|
getDiffuseShader()Get the material's diffuse shader from one of the shaders in Material.Shaders dict.
|
getDiffuseSmooth()Get the material's smoothing of diffuse area (applies to the "Toon" Diffuse Shader only)
|
getEmit()Get the emitting light intensity.
|
getFilter()Get the material's amount of filtering when transparent raytrace is enabled
|
getFlareBoost()Get the flare's extra strength.
|
getFlareSeed()Get flare's offset in the seed table.
|
getFlareSize()Get the ratio: flareSize / haloSize.
|
getFresnelMirr()Get power of Fresnel for mirror reflection.
|
getFresnelMirrFac()Get the number of Ray Mirror.
|
getFresnelTrans()Get power of Fresnel for transparency.
|
getFresnelTransFac()Get blending factor for Fresnel.
|
getHaloSeed()Get the seed for random ring dimension and line location in halos.
|
getHaloSize()Get the halo size.
|
getHardness()Get the hardness of the specularity.
|
getIOR()Get the angular index of refraction for raytrace.
|
getIpo()Get the Ipo associated with this material, if any.
|
getMirCol()Get the mirror color triplet sequence.
|
getMode()Get this Material's mode flags.
|
getName()Get the name of this Material object.
|
getNFlares()Get the number of halo subflares.
|
getNLines()Get the number of star shaped lines on each halo.
|
getNRings()Get the number of rings on each halo.
|
getNStars()Get the number of points in the halo stars.
|
getRayMirr()Get amount mirror reflection for raytrace.
|
getRayMirrDepth()Get amount of inter-reflections calculated maximal.
|
getRef()Get the reflectivity value.
|
getRefracIndex()Get the material's Index of Refraction (applies to the "Blinn" Specular Shader only)
|
getRGBCol()Get the rgb color triplet sequence.
|
getRms()Get the material's standard deviation of surface slope (applies to the "WardIso" Specular Shader only)
|
getRoughness()Get the material's roughness (applies to the "Oren Nayar" Diffuse Shader only)
|
getScriptLinks(event)Get a list with this Material's script links of type 'event'.
|
getSpec()Get the specularity value.
|
getSpecCol()Get the specular color triplet sequence.
|
getSpecShader(specShader)Get the material's specular shader from one of the shaders in Material.Shaders dict.
|
getSpecSize()Get the material's size of diffuse area (applies to the "Toon" Diffuse Shader only)
|
getSpecSmooth()Get the material's smoothing of specular area (applies to the "Toon" Specular Shader only)
|
getSpecTransp()Get the specular transparency.
|
getSubSize()Get the dimension of subflare, dots and circles.
|
getTextures()Get this Material's Texture list.
|
getTransDepth()Get amount of refractions calculated maximal.
|
getTranslucency()Get the material's amount of diffuse shading of the back side
|
getZOffset()Get the artificial offset for faces with this Material.
|
insertIpoKey(keytype)Inserts keytype values in material ipo at curframe. Uses module constants.
|
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=None)Set the mirror color triplet sequence. If rgb is None, set the color to black.
|
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.
|
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=None)Set the rgb color triplet sequence. If rgb is None, set the color to black.
|
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=None)Set the specular color triplet sequence. If rgb is None, set the color to black.
|
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 Details |
---|
addStrength of the add effect. Value is clamped to the range [0.0,1.0].
|
alphaAlpha (translucency) component of the material. Value is clamped to the range [0.0,1.0].
|
ambAmount of global ambient color material receives. Value is clamped to the range [0.0,1.0].
|
BDiffuse color (rgbCol ) blue component. Value is clamped to
the range [0.0,1.0].
|
diffuseDarknessMaterial's diffuse darkness ("Minnaert" diffuse shader only). Value is clamped to the range [0.0,2.0].
|
diffuseShaderDiffuse shader type (seeShaders ). Value must be in the range
[0,3].
|
diffuseSizeMaterial's diffuse area size ("Toon" diffuse shader only). Value is clamped to the range [0.0,3.14].
|
diffuseSmoothMaterial's diffuse area smoothing ("Toon" diffuse shader only). Value is clamped to the range [0.0,1.0].
|
emitAmount of light the material emits. Value is clamped to the range [0.0,1.0].
|
filterAmount of filtering when transparent raytrace is enabled. Value is clamped to the range [0.0,1.0].
|
flareBoostFlare's extra strength. Value is clamped to the range [0.1,1.0].
|
flareSeedOffset in the flare seed table. Value is clamped to the range [1,255].
|
flareSizeRatio of flare size to halo size. Value is clamped to the range [0.1,25.0].
|
fresnelDepthPower of Fresnel for mirror reflection. Value is clamped to the range [0.0,5.0].
|
fresnelDepthFacBlending factor for Fresnel mirror. Value is clamped to the range [1.0,5.0].
|
fresnelTransPower of Fresnel for transparency. Value is clamped to the range [0.0,5.0].
|
fresnelTransFacBlending factor for Fresnel transparency. Value is clamped to the range [1.0,5.0].
|
GDiffuse color (rgbCol ) green component. Value is clamped
to the range [0.0,1.0].
|
haloSeedRandomizes halo ring dimension and line location. Value is clamped to the range [1,255].
|
haloSizeDimension of the halo. Value is clamped to the range [0.0,100.0].
|
hardHardness of the specularity. Value is clamped to the range [1,255].
|
IORAngular index of refraction for raytrace. Value is clamped to the range [1.0,3.0].
|
ipoMaterial Ipo data. Contains the Ipo if one is assigned to the object, None otherwise. Setting to None clears the current Ipo.
|
mirBMirror color (mirCol ) blue component. Value is clamped to
the range [0.0,1.0].
|
mirColMirror RGB color triplet. Components are clamped to the range [0.0,1.0].
|
mirGMirror color (mirCol ) green component. Value is clamped
to the range [0.0,1.0].
|
mirRMirror color (mirCol ) red component. Value is clamped to
the range [0.0,1.0].
|
modeMode mode bitfield. Seethe Modes dictionary keys and
descriptions.
|
nameMaterial data name.
|
nFlaresNumber of subflares with halo. Value is clamped to the range [1,32].
|
nLinesNumber of star-shaped lines with halo. Value is clamped to the range [0,250].
|
nRingsNumber of rings with halo. Value is clamped to the range [0,24].
|
nStarsNumber of star points with halo. Value is clamped to the range [3,50].
|
oopsLocMaterial OOPs location. Returns None if materal not found in list.
|
oopsSelMaterial OOPs selection flag. Value must be in the range [0,1].
|
RDiffuse color (rgbCol ) red component. Value is clamped to
the range [0.0,1.0].
|
rayMirrMirror reflection amount for raytrace. Value is clamped to the range [0.0,1.0].
|
rayMirrDepthAmount of raytrace inter-reflections. Value is clamped to the range [0,10].
|
refAmount of reflections (for shader). Value is clamped to the range [0.0,1.0].
|
refracIndexMaterial's Index of Refraction (applies to the "Blinn" Specular Shader only. Value is clamped to the range [1.0,10.0].
|
rgbColDiffuse RGB color triplet. Components are clamped to the range [0.0,1.0].
|
rmsMaterial's surface slope standard deviation ("WardIso" specular shader only). Value is clamped to the range [0.0,0.4].
|
roughnessMaterial's roughness ("Oren Nayar" diffuse shader only). Value is clamped to the range [0.0,3.14].
|
specDegree of specularity. Value is clamped to the range [0.0,2.0].
|
specBSpecular color (specCol ) blue component. Value is clamped
to the range [0.0,1.0].
|
specColSpecular RGB color triplet. Components are clamped to the range [0.0,1.0].
|
specGSpecular color (specCol ) green component. Value is clamped
to the range [0.0,1.0].
|
specRSpecular color (specCol ) red component. Value is clamped to
the range [0.0,1.0].
|
specShaderSpecular shader type. SeeShaders . Value must be in the range
[0,4].
|
specSizeMaterial's specular area size ("Toon" specular shader only). Value is clamped to the range [0.0,1.53].
|
specSmoothSets the smoothness of specular toon area. Value is clamped to the range [0.0,1.0].
|
specTranspMakes specular areas opaque on transparent materials. Value is clamped to the range [0.0,1.0].
|
subSizeDimension of subflares, dots and circles. Value is clamped to the range [0.1,25.0].
|
transDepthcalculated maximal. Amount of refractions for raytrace. Value is clamped to the range [0,10].
|
translucencyAmount of diffuse shading of the back side. Value is clamped to the range [0.0,1.0].
|
usersNumber of material users.
|
zOffsetArtificial offset in the Z buffer (for Ztransp option). Value is clamped to the range [0.0,10.0].
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Thu Dec 22 22:38:13 2005 | http://epydoc.sf.net |