Module Texture :: Class Texture

Class Texture

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 if specific modes are enabled.

Method Summary
string.	`getExtend()` Get the extend mode of the texture.
Blender Image	`getImage()` Get the Image associated with this texture (or None).
string	`getName()` Get the name of this Texture object.
string	`getType()` Get this Texture's type.
	`setExtend(extendmode)` Set the extend mode of this texture (only used for IMAGE textures)
	`setFlags(f, f2, f3)` Set this object's flags.
	`setImage(image)` Set the Image of this texture.
	`setImageFlags(f, f2, f3, and_so_on)` Set the Image flags (only makes sense for IMAGE textures).
	`setName(name)` Set the name of this Texture object.
	`setSType(stype)` Set the SType.
	`setType(type)` Set this Texture's type.

Class Variable Summary
	`animFrames`: Frames of the animation.
	`animLength`: Length of the animation.
	`animMontage`: Montage mode data as a tuple of tuples, like `( (fra1,dur1), (fra2,dur2), (fra3,dur3), (fra4,dur4) )`
	`animOffset`: The number of the first picture of the animation.
	`animStart`: Start frame of the animation.
	`brightness`: The brightness in range [0,2].
	`contrast`: The contrast in range [0,2].
	`crop`: Tuple of image crop values as floats, like `(xmin, ymin, xmax, ymax)`
	`extend`: Texture extend/repeat mode.
	`fieldsPerImage`: The number of fields per rendered frame.
	`filterSize`: The filter size for the image.
	`flags`: The texture flags (OR'd together).
Blender Image	`image`: The image associated with this texture, or None.
	`imageFlags`: The texture image flags (OR'd tegether).
	`name`: The Texture name.
	`noiseDepth`: The noise depth.
	`noiseSize`: The noise size.
	`noiseType`: The noise type: 'soft' or 'hard'.
	`repeat`: Tuple of image repeat values as ints, like `(xrepeat, yrepeat)`
	`rgbCol`: The texture's RGB color triplet.
	`stype`: Texture-type specific data.
	`type`: The Texture type.

Method Details

getExtend()

Get the extend mode of the texture. See setExtend

Returns:: string.

getImage()

Get the Image associated with this texture (or None).

Returns:: Blender Image

getName()

Get the name of this Texture object.

Returns:: string

getType()

Get this Texture's type.

Returns:: The Texture's type. See setType
(type=string)

setExtend(extendmode)

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

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

setFlags(f=None, f2=None, f3=None)

Set this object's flags.

Parameters:: f - Flags to be set (omitted flags are cleared). Can be any of 'ColorBand', 'FlipBlendXY', and 'NegAlpha'
(type=string)

setImage(image)

Set the Image of this texture.

Parameters:: image - The new Image.
(type=Blender Image)

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

setImageFlags(f=None, f2=None, f3=None, and_so_on=None)

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

Parameters:: f - Flag to set. See ImageFlags for their meanings. Can be any of: 'InterPol', 'UseAlpha', 'MipMap', 'Fields', 'Rot90', 'CalcAlpha', 'StField', 'Movie' and 'Cyclic'
(type=string)

setName(name)

Set the name of this Texture object.

Parameters:: name - The new name.
(type=string)

setSType(stype)

Set the SType.

Parameters:: stype - The new stype. This can be one of the following values or 'Default' which sets the stype to the default value. See STypes for their meanings. 'CloudDefault', 'CloudColor', 'WoodBands', 'WoodRings', 'WoodBandNoise', 'WoodRingNoise', 'MarbleSoft', 'MarbleSharp', 'MarbleSharper', 'BlendLin', 'BlendQuad', 'BlendEase', 'BlendDiag', 'BlendSphere', 'BlendHalo', 'StucciPlastic', 'StucciWallIn', 'StucciWallOut', 'EnvmapStatic', 'EnvmapAnim', 'EnvmapLoad'
(type=string)

setType(type)

Set this Texture's type.

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

Class Variable Details

animFrames

Frames of the animation.

animLength

Length of the animation.

animMontage

Montage mode data as a tuple of tuples, like

( (fra1,dur1), 
(fra2,dur2), (fra3,dur3), (fra4,dur4) )

animOffset

The number of the first picture of the animation.

animStart

Start frame of the animation.

brightness

The brightness in range [0,2].

contrast

The contrast in range [0,2].

crop

Tuple of image crop values as floats, like

(xmin, ymin, xmax, 
ymax)

extend

Texture extend/repeat mode. See ExtendModes

fieldsPerImage

The number of fields per rendered frame.

filterSize

The filter size for the image.

flags

The texture flags (OR'd together). See Flags

image

The image associated with this texture, or None.

Type:: Blender Image

imageFlags

The texture image flags (OR'd tegether). See ImageFlags

name

The Texture name.

noiseDepth

The noise depth.

noiseSize

The noise size.

noiseType

The noise type: 'soft' or 'hard'.

repeat

Tuple of image repeat values as ints, like

(xrepeat, 
yrepeat)

rgbCol

The texture's RGB color triplet.

stype

Texture-type specific data. See STypes

type

The Texture type. See Types

Generated by Epydoc 2.0 on Wed May 12 22:11:00 2004

http://epydoc.sf.net