Logo Search packages:      
Sourcecode: blender version File versions  Download package

Material::Material Class Reference

List of all members.


Detailed Description

The Material object
===================
 This object gives access to Materials in Blender.
@ivar B:  Diffuse color (L{rgbCol}) blue component.
Value is clamped to the range [0.0,1.0].
@type B:  float
@ivar G:  Diffuse color (L{rgbCol}) green component.
Value is clamped to the range [0.0,1.0].
@type G:  float
@ivar IOR:  Angular index of refraction for raytrace.
Value is clamped to the range [1.0,3.0].
@type IOR:  float
@ivar R:  Diffuse color (L{rgbCol}) red component.
Value is clamped to the range [0.0,1.0].
@type R:  float
@ivar add:  Strength of the add effect.
Value is clamped to the range [0.0,1.0].
@type add:  float
@ivar alpha:  Alpha (translucency) component of the material.
Value is clamped to the range [0.0,1.0].
@type alpha:  float
@ivar shadAlpha:  Shadow Alpha for irregular shadow buffer.
Value is clamped to the range [0.0,1.0].
@type shadAlpha:  float
@ivar amb:  Amount of global ambient color material receives.
Value is clamped to the range [0.0,1.0].
@type amb:  float
@ivar diffuseDarkness:  Material's diffuse darkness ("Minnaert" diffuse shader only).
Value is clamped to the range [0.0,2.0].
@type diffuseDarkness:  float
@ivar diffuseShader:  Diffuse shader type (see L{Shaders}).
Value must be in the range [0,3].
@type diffuseShader:  int
@ivar diffuseSize:  Material's diffuse area size ("Toon" diffuse shader only).
Value is clamped to the range [0.0,3.14].
@type diffuseSize:  float
@ivar diffuseSmooth:  Material's diffuse area smoothing ("Toon" diffuse shader only).
Value is clamped to the range [0.0,1.0].
@type diffuseSmooth:  float
@ivar emit:  Amount of light the material emits.
Value is clamped to the range [0.0,1.0].
@type emit:  float
@ivar filter:  Amount of filtering when transparent raytrace is enabled.
Value is clamped to the range [0.0,1.0].
@type filter:  float
@ivar flareBoost:  Flare's extra strength.
Value is clamped to the range [0.1,1.0].
@type flareBoost:  float
@ivar flareSeed:  Offset in the flare seed table.
Value is clamped to the range [1,255].
@type flareSeed:  int
@ivar flareSize:  Ratio of flare size to halo size.
Value is clamped to the range [0.1,25.0].
@type flareSize:  float
@ivar fresnelDepth:  Power of Fresnel for mirror reflection.
Value is clamped to the range [0.0,5.0].
@type fresnelDepth:  float
@ivar fresnelDepthFac:  Blending factor for Fresnel mirror.
Value is clamped to the range [1.0,5.0].
@type fresnelDepthFac:  float
@ivar fresnelTrans:  Power of Fresnel for transparency.
Value is clamped to the range [0.0,5.0].
@type fresnelTrans:  float
@ivar fresnelTransFac:  Blending factor for Fresnel transparency.
Value is clamped to the range [1.0,5.0].
@type fresnelTransFac:  float
@ivar rbFriction:  Rigid Body Friction coefficient.
Value is clamped to the range [0.0,100.0].
@type rbFriction:  float
@ivar rbRestitution:  Rigid Body Friction restitution.
Value is clamped to the range [0.0,1.0].
@type rbRestitution:  float
@ivar haloSeed:  Randomizes halo ring dimension and line location.
Value is clamped to the range [1,255].
@type haloSeed:  int
@ivar haloSize:  Dimension of the halo.
Value is clamped to the range [0.0,100.0].
@type haloSize:  float
@ivar hard:  Hardness of the specularity.
Value is clamped to the range [1,255].
@type hard:  int
@ivar ipo:  Material Ipo data.
Contains the Ipo if one is assigned to the object, None otherwise.  Setting to None clears the current Ipo.
@type ipo:  Blender Ipo

@ivar mirCol:  Mirror RGB color triplet.
Components are clamped to the range [0.0,1.0].
@type mirCol:  list of 3 floats
@ivar mirB:  Mirror color (L{mirCol}) blue component.
Value is clamped to the range [0.0,1.0].
@type mirB:  float
@ivar mirG:  Mirror color (L{mirCol}) green component.
Value is clamped to the range [0.0,1.0].
@type mirG:  float
@ivar mirR:  Mirror color (L{mirCol}) red component.
Value is clamped to the range [0.0,1.0].
@type mirR:  float

@ivar sssCol:  SubSsurface scattering RGB color triplet.
Components are clamped to the range [0.0,1.0].
@type sssCol:  list of 3 floats
@ivar sssB:  SubSsurface scattering color (L{sssCol}) blue component.
Value is clamped to the range [0.0,1.0].
@type sssB:  float
@ivar sssG:  SubSsurface scattering color (L{sssCol}) green component.
Value is clamped to the range [0.0,1.0].
@type sssG:  float
@ivar sssR:  SubSsurface scattering color (L{sssCol}) red component.
Value is clamped to the range [0.0,1.0].
@type sssR:  float

@ivar mode:  Mode mode bitfield.  See L{the Modes dictionary<Modes>} keys and descriptions.
@type mode:  int
@ivar nFlares:  Number of subflares with halo.
Value is clamped to the range [1,32].
@type nFlares:  int
@ivar nLines:  Number of star-shaped lines with halo.
Value is clamped to the range [0,250].
@type nLines:  int
@ivar nRings:  Number of rings with halo.
Value is clamped to the range [0,24].
@type nRings:  int
@ivar nStars:  Number of star points with halo.
Value is clamped to the range [3,50].
@type nStars:  int
@ivar oopsLoc: Material OOPs location.  Returns None if material not found in list.
@type oopsLoc:  list of 2 floats
@ivar oopsSel:  Material OOPs selection flag.
Value must be in the range [0,1].
@type oopsSel:  int
@ivar rayMirr:  Mirror reflection amount for raytrace.
Value is clamped to the range [0.0,1.0].
@type rayMirr:  float
@ivar glossMir: Amount of reflection glossy.
Value is clamped to the range [0.0,1.0].
@type glossMir: float
@ivar sampGloss_mir: Reflection glossy samples.
Value is clamped to the range [1,1024].
@type sampGloss_mir: int
@ivar glossTra: Amount of refraction glossy.
Value is clamped to the range [0.0,1.0].
@type glossTra: float
@ivar sampGlossTra: Refraction glossy samples.
Value is clamped to the range [1,1024].
@type sampGlossTra: int
@ivar rayMirrDepth:  Amount of raytrace inter-reflections.
Value is clamped to the range [0,10].
@type rayMirrDepth:  int
@ivar ref:   Amount of reflections (for shader).
Value is clamped to the range [0.0,1.0].
@type ref:  float
@ivar refracIndex:  Material's Index of Refraction (applies to the "Blinn" Specular Shader only.
Value is clamped to the range [1.0,10.0].
@type refracIndex:  float
@ivar rgbCol:  Diffuse RGB color triplet.
Components are clamped to the range [0.0,1.0].
@type rgbCol:  list of 3 floats
@ivar rms: Material's surface slope standard deviation ("WardIso" specular shader only).
Value is clamped to the range [0.0,0.4].
@type rms:  float
@ivar roughness:  Material's roughness ("Oren Nayar" diffuse shader only).
Value is clamped to the range [0.0,3.14].
@type roughness:  float
@ivar spec:  Degree of specularity.
Value is clamped to the range [0.0,2.0].
@type spec:  float
@ivar specB:  Specular color (L{specCol}) blue component.
Value is clamped to the range [0.0,1.0].
@type specB:  float
@ivar specCol:  Specular RGB color triplet.
Components are clamped to the range [0.0,1.0].
@type specCol:  list of 3 floats
@ivar specG:  Specular color (L{specCol}) green component.
Value is clamped to the range [0.0,1.0].
@type specG:  float
@ivar specR:  Specular color (L{specCol}) red component.
Value is clamped to the range [0.0,1.0].
@type specR:  float
@ivar specShader: Specular shader type.  See L{Shaders}.
Value must be in the range [0,4].
@type specShader:  int
@ivar specSize:  Material's specular area size ("Toon" specular shader only).
Value is clamped to the range [0.0,1.53].
@type specSize:  float
@ivar specSmooth:  Sets the smoothness of specular toon area.
Value is clamped to the range [0.0,1.0].
@type specSmooth:  float
@ivar specTransp:  Makes specular areas opaque on transparent materials.
Value is clamped to the range [0.0,1.0].
@type specTransp:  float
@ivar subSize:   Dimension of subflares, dots and circles.
Value is clamped to the range [0.1,25.0].
@type subSize:  float
@ivar transDepth:  calculated maximal.  Amount of refractions for raytrace.
Value is clamped to the range [0,10].
@type transDepth:  int
@ivar translucency:  Amount of diffuse shading of the back side.
Value is clamped to the range [0.0,1.0].
@type translucency:  float
@ivar zOffset:  Artificial offset in the Z buffer (for Ztransp option).
Value is clamped to the range [0.0,10.0].
@type zOffset:  float
@ivar lightGroup:  Limits lights that affect this material to a group.
@type lightGroup:  Group or None
@ivar uvlayer:  The uv layer name to use, when UV mapping is enabled.
@type uvlayer:  string
@ivar 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 colorband:  list

@ivar 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 colorbandDiffuse:  list
@ivar 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 colorbandSpecular:  list

@ivar enableSSS:  If True, subsurface scattering will be rendered on this material.
@type enableSSS:  bool
@ivar sssScale:  If True, subsurface scattering will be rendered on this material.
Value is clamped to the range [0.1,1000.0].
@type sssScale:  bool
@ivar sssRadiusRed:  Mean red scattering path length.
Value is clamped to the range [0.0,10000.0].
@type sssRadiusRed:  float
@ivar sssRadiusGreen:  Mean green scattering path length.
Value is clamped to the range [0.0,10000.0].
@type sssRadiusGreen:  float
@ivar sssRadiusBlue:  Mean blue scattering path length.
Value is clamped to the range [0.0,10000.0].
@type sssRadiusBlue:  float
@ivar sssIOR:  Refraction index.
Value is clamped to the range [0.1,2.0].
@type sssIOR:  float
@ivar sssError:  Error allowance for the calculation (a low value is slower).
Value is clamped to the range [0.0,10.0].
@type sssError:  float
@ivar sssColorBlend:  Blend factor for SSS colors.
Value is clamped to the range [0.0,1.0].
@type sssColorBlend:  float
@ivar sssTextureScatter:  Texture scattering factor.
Value is clamped to the range [0.0,1.0].
@type sssTextureScatter:  float
@ivar sssFront:  Front scattering weight.
Value is clamped to the range [0.0,2.0].
@type sssFront:  float
@ivar sssBack:  Back scattering weight
Value is clamped to the range [0.0,10.0].
@type sssBack:  float

@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.

Definition at line 105 of file Material.py.


Public Member Functions

def __copy__
def addScriptLink
def clearIpo
def clearScriptLinks
def clearTexture
def getAdd
def getAlpha
def getAmb
def getDiffuseDarkness
def getDiffuseShader
def getDiffuseSmooth
def getEmit
def getFilter
def getFlareBoost
def getFlareSeed
def getFlareSize
def getFresnelMirr
def getFresnelMirrFac
def getFresnelTrans
def getFresnelTransFac
def getHaloSeed
def getHaloSize
def getHardness
def getIOR
def getIpo
def getMirCol
def getMode
def getName
def getNFlares
def getNLines
def getNRings
def getNStars
def getRayMirr
def getRayMirrDepth
def getRef
def getRefracIndex
def getRGBCol
def getRms
def getRoughness
def getScriptLinks
def getSpec
def getSpecCol
def getSpecShader
def getSpecSize
def getSpecSize
def getSpecSmooth
def getSpecTransp
def getSubSize
def getTextures
def getTransDepth
def getTranslucency
def getZOffset
def insertIpoKey
def setAdd
def setAlpha
def setAmb
def setDiffuseDarkness
def setDiffuseShader
def setDiffuseSmooth
def setEmit
def setFilter
def setFlareBoost
def setFlareSeed
def setFlareSize
def setFresnelMirr
def setFresnelMirrFac
def setFresnelTrans
def setFresnelTransFac
def setHaloSeed
def setHaloSize
def setHardness
def setIOR
def setIpo
def setMirCol
def setMode
def setName
def setNFlares
def setNLines
def setNRings
def setNStars
def setRayMirr
def setRayMirrDepth
def setRef
def setRefracIndex
def setRGBCol
def setRms
def setRoughness
def setSpec
def setSpecCol
def setSpecShader
def setSpecSize
def setSpecSize
def setSpecSmooth
def setSpecTransp
def setSubSize
def setTexture
def setTransDepth
def setTranslucency
def setZOffset

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index