Trees       Indices       Help   
Module Texture :: Class Texture
[hide private]
[frames] | no frames]

Class Texture

source code

The Texture object

This object gives access to Texture-specific data in Blender.

Note that many of the attributes of this object are only relevant for specific texture types.

Instance Methods [hide private]
string.
getExtend()
Get the extend mode of the texture.		 source code
Blender Image
getImage()
Get the Image associated with this texture (or None).		 source code
string
getName()
Get the name of this Texture object.		 source code
string
getType()
Get this Texture's type.		 source code
 
setExtend(extendmode)
Set the extend mode of this texture (only used for IMAGE textures)		 source code
 
setFlags(f1=None, f2=None, f3=None, f4=None)
Set this object's flags.		 source code
 
setImage(image)
Set the Image of this texture.		 source code
 
setImageFlags(f1=None, f2=None, f3=None, etc=None)
Set the Image flags (only makes sense for IMAGE textures).		 source code
 
setName(name)
Set the name of this Texture object.		 source code
 
setSType(stype)
Set the SType.		 source code
 
setType(type)
Set this Texture's type.		 source code
 
evaluate(coord)
Evaluates the texture at this location and returns the result.		 source code
Instance Variables [hide private]
int animFrames
Number of frames of a movie to use.
int animOffset
Offsets the number of the first movie frame to use.
int animStart
Starting frame of the movie to use.
int anti
Image anti-aliasing enabled.
boolean autoRefresh
Refresh image on frame changes enabled.
float brightness
Changes the brightness of a texture's color.
int calcAlpha
Calculation of image's alpha channel enabled.
list colorband
Texture colorband, a list of colors, each color a list of 5 floats [0 - 1], [r,g,b,a,pos].
float contrast
Changes the contrast of a texture's color.
tuple of 4 ints crop
Sets the cropping extents (for image textures).
boolean cyclic
Looping of animated frames enabled.
float distAmnt
Amount of distortion (for distorted noise textures).
int distMetric
The distance metric (for Voronoi textures).
float exp
Minkovsky exponent (for Minkovsky Voronoi textures).
int extend
Texture's 'Extend' mode (for image textures).
bool fakeUser
When set to True, this datablock wont be removed, even if nothing is using it.
int fields
Use of image's fields enabled.
int fieldsPerImage
Number of fields per rendered frame.
float filterSize
The filter size (for image and envmap textures).
int flags
Texture's 'Flag' bitfield.
float gain
Gain multiplier (for multifractal Musgrave textures).
float hFracDim
Highest fractional dimension (for Musgrave textures).
float iScale
Intensity output scale (for Musgrave and Voronoi textures).
Blender Image (or None) image
Texture's image object.
int imageFlags
Texture's 'ImageFlags' bits.
int interpol
Interpolate image's pixels to fit texture mapping enabled.
Blender Ipo ipo
Texture Ipo data.
float lacunarity
Gap between succesive frequencies (for Musgrave textures).
string or None lib
path to the blend file this datablock is stored in (readonly).
int mipmap
Mipmaps enabled.
int movie
Movie frames as images enabled.
string name
unique name within each blend file.
int noiseBasis
Noise basis type (wood, stucci, marble, clouds, Musgrave, distorted).
int noiseBasis2
Additional noise basis type (wood, marble, distorted noise).
int noiseDepth
Noise depth (magic, marble, clouds).
float noiseSize
Noise size (wood, stucci, marble, clouds, Musgrave, distorted noise).
string noiseType
Noise type (for wood, stucci, marble, clouds textures).
int normalMap
Use of image RGB values for normal mapping enabled.
float octs
Number of frequencies (for Musgrave textures).
float offset
Fractal offset (for hetero terrain and multifractal Musgrave textures).
IDGroup properties
Returns an IDGroup reference to this datablocks's ID Properties.
tuple of 2 ints repeat
Repetition multiplier (for image textures).
tuple of 3 floats rgbCol
RGB color tuple.
int rot90
X/Y flip for rendering enabled.
int saw
Produce bands using saw wave (marble, wood textures).
int sine
Produce bands using sine wave (marble, wood textures).
int stField
Standard field deinterlacing enabled.
int stype
Texture's 'SType' mode.
bool tag
A temporary tag that to flag data as being used within a loop.
int tri
Produce bands using triangle wave (marble, wood textures).
float turbulence
Turbulence (for magic, wood, stucci, marble textures).
int type
Texture's 'Type' mode.
int useAlpha
Use of image's alpha channel enabled.
int users
The number of users this datablock has.
float weight1
Weight 1 (for Voronoi textures).
float weight2
Weight 2 (for Voronoi textures).
float weight3
Weight 3 (for Voronoi textures).
float weight4
Weight 4 (for Voronoi textures).
Method Details [hide private]

getExtend()

source code 

Get the extend mode of the texture. See setExtend.

Returns: string.

getType()

source code 

Get this Texture's type. See setType.

Returns: string

setExtend(extendmode)

source code 

Set the extend mode of this texture (only used for IMAGE textures)

Parameters:
  • extendmode (string) - The new extend mode. One of: 'Extend', 'Clip', 'ClipCube' and 'Repeat'

setFlags(f1=None, f2=None, f3=None, f4=None)

source code 

Set this object's flags.

Parameters:
  • f1, f2, f3, f4 - Flags to be set (omitted flags are cleared). Can be any of 'FlipBlendXY', 'NegAlpha', 'CheckerOdd', and 'CheckerEven'

setImage(image)

source code 

Set the Image of this texture.

Parameters:
  • image (Blender Image or None.) - The new Image.

Warning: This sets the texture's type to 'Image' if it is not already.

setImageFlags(f1=None, f2=None, f3=None, etc=None)

source code 

Set the Image flags (only makes sense for IMAGE textures). Omitted flags are cleared.

Parameters:
  • f1, f2, f3, etc - Flag to set. See ImageFlags for their meanings. Can be any of: 'InterPol', 'UseAlpha', 'MipMap', 'Fields', 'Rot90', 'CalcAlpha', 'Cyclic', 'Movie', 'StField', 'Anti' and 'NormalMap'

setName(name)

source code 

Set the name of this Texture object.

Parameters:
  • name (string) - The new name.

setSType(stype)

source code 

Set the SType.

Parameters:
  • stype (string) - The new stype. This can be any of the values listed in STypes or 'Default' which sets the stype to the default value.

Note: the set of valid parameters is dependent on the current texture type. Be sure to always set the texture type before setting the texture's stype; otherwise an exception might occur.

setType(type)

source code 

Set this Texture's type.

Parameters:
  • type (string) - The new type. Possible options are: 'None', 'Clouds', 'Wood', 'Marble', 'Magic', 'Blend', 'Stucci', 'Noise', 'Image', 'Plugin', 'EnvMap', 'Musgrave', 'Voronoi' and 'DistNoise'

evaluate(coord)

source code 

Evaluates the texture at this location and returns the result.

The return value is a 4D vector where (x,y,z,w) are (red, green, blue, intensity) For greyscale textures, often intensity only will be used.

Parameters:
  • coord (vector or tuple of 3 numbers)

Instance Variable Details [hide private]

animFrames

Number of frames of a movie to use. Value is clamped to the range [0,300000].
Type:
int

animOffset

Offsets the number of the first movie frame to use. Value is clamped to the range [-300000,300000].
Type:
int

animStart

Starting frame of the movie to use. Value is clamped to the range [1,300000].
Type:
int

anti

Image anti-aliasing enabled. Also see ImageFlags.
Type:
int

brightness

Changes the brightness of a texture's color. Value is clamped to the range [0.0,2.0].
Type:
float

calcAlpha

Calculation of image's alpha channel enabled. Also see ImageFlags.
Type:
int

colorband

Texture 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

contrast

Changes the contrast of a texture's color. Value is clamped to the range [0.01,5.0].
Type:
float

cyclic

Looping of animated frames enabled. Also see ImageFlags.
Type:
boolean

distAmnt

Amount of distortion (for distorted noise textures). Value is clamped to the range [0.0,10.0].
Type:
float

exp

Minkovsky exponent (for Minkovsky Voronoi textures). Value is clamped to the range [0.01,10.0].
Type:
float

extend

Texture's 'Extend' mode (for image textures). See ExtendModes.
Type:
int

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

fields

Use of image's fields enabled. Also see ImageFlags.
Type:
int

fieldsPerImage

Number of fields per rendered frame. Value is clamped to the range [1,200].
Type:
int

filterSize

The filter size (for image and envmap textures). Value is clamped to the range [0.1,25.0].
Type:
float

flags

Texture's 'Flag' bitfield. See Flags. bitmask.
Type:
int

gain

Gain multiplier (for multifractal Musgrave textures). Value is clamped to the range [0.0,6.0].
Type:
float

hFracDim

Highest fractional dimension (for Musgrave textures). Value is clamped to the range [0.0001,2.0].
Type:
float

iScale

Intensity output scale (for Musgrave and Voronoi textures). Value is clamped to the range [0.0,10.0].
Type:
float

interpol

Interpolate image's pixels to fit texture mapping enabled. Also see ImageFlags.
Type:
int

ipo

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

lacunarity

Gap between succesive frequencies (for Musgrave textures). Value is clamped to the range [0.0,6.0].
Type:
float

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

mipmap

Mipmaps enabled. Also see ImageFlags.
Type:
int

movie

Movie frames as images enabled. Also see ImageFlags.
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

noiseBasis

Noise basis type (wood, stucci, marble, clouds, Musgrave, distorted). See Noise dictionary.
Type:
int

noiseBasis2

Additional noise basis type (wood, marble, distorted noise). See Noise dictionary.
Type:
int

noiseDepth

Noise depth (magic, marble, clouds). Value is clamped to the range [0,6].
Type:
int

noiseSize

Noise size (wood, stucci, marble, clouds, Musgrave, distorted noise). Value is clamped to the range [0.0001,2.0].
Type:
float

noiseType

Noise type (for wood, stucci, marble, clouds textures). Valid values are 'hard' or 'soft'.
Type:
string

normalMap

Use of image RGB values for normal mapping enabled. Also see ImageFlags.
Type:
int

octs

Number of frequencies (for Musgrave textures). Value is clamped to the range [0.0,8.0].
Type:
float

offset

Fractal offset (for hetero terrain and multifractal Musgrave textures). Value is clamped to the range [0.0,6.0].
Type:
float

rot90

X/Y flip for rendering enabled. Also see ImageFlags.
Type:
int

saw

Produce bands using saw wave (marble, wood textures). Also see Noise.
Type:
int

sine

Produce bands using sine wave (marble, wood textures). Also see Noise.
Type:
int

stField

Standard field deinterlacing enabled. Also see ImageFlags.
Type:
int

stype

Texture's 'SType' mode. See STypes.
Type:
int

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

tri

Produce bands using triangle wave (marble, wood textures). Also see Noise.
Type:
int

turbulence

Turbulence (for magic, wood, stucci, marble textures). Value is clamped to the range [0.0,200.0].
Type:
float

type

Texture's 'Type' mode. See Types. Value must be in the range [0,13].
Type:
int

useAlpha

Use of image's alpha channel enabled. Also see ImageFlags.
Type:
int

users

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

weight1

Weight 1 (for Voronoi textures). Value is clamped to the range [-2.0,2.0].
Type:
float

weight2

Weight 2 (for Voronoi textures). Value is clamped to the range [-2.0,2.0].
Type:
float

weight3

Weight 3 (for Voronoi textures). Value is clamped to the range [-2.0,2.0].
Type:
float

weight4

Weight 4 (for Voronoi textures). Value is clamped to the range [-2.0,2.0].
Type:
float

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Oct 24 10:23:53 2008 http://epydoc.sourceforge.net