Module Effect :: Class Effect

Class Effect

The Effect object

This object gives access to particle effect data in Blender.

Method Summary
tuple of 4 ints	`getChild()` Retrieves the average number of children of the particles (4 generations).
tuple of 3 floats	`getDefvec()` Retrieves the x, y and z components of the force defined by the texture.
float	`getEndTime()` Retrieves the end time of a particle effect object
int	`getFlag()` Retrieves the flag of an effect object.
tuple of three floats	`getForce()` Retrieves the force applied to the particles.
tuple of 4 floats	`getLife()` Retrieves the average life of the particles (4 generations)
float	`getLifetime()` Retrieves the lifetime of a particle effect object
tuple of 4 ints	`getMat()` Retrieves the indexes of the materials associated to the particles (4 generations).
tuple of 4 floats	`getMult()` Retrieves the probabilities of a particle having a child.
float	`getNabla()` Retrieves the sensibility of the particles to the variations of the texture.
float	`getNormfac()` Retrieves the normal strength of the particles (relatively to mesh).
float	`getObfac()` Retrieves the initial strength of the particles relatively to objects.
List of x,y,z coordinates	`getParticlesLoc(time)` Get the location of each particle at a given time.
float	`getRandfac()` Retrieves the random strength applied to the particles.
float	`getRandlife()` Retrieves the variability of the life of the particles.
int	`getSeed()` Retrieves the random number generator seed.
float	`getStartTime()` Retrieves the starting time of a particle effect object
float	`getTexfac()` Retrieves the strength applied to the particles from the texture of the object.
int	`getTotkey()` Retrieves the number of keys associated to the particles (kind of degree of freedom)
int	`getTotpart()` Retrieves the total number of particles.
int	`getType()` Retrieves the type of an effect object.
float	`getVectsize()` Retrieves the size of the vector which is associated to the particles.
PyNone	`setChild(newchild)` Sets the average number of children of the particles (4 generations).
PyNone	`setDefvec(newdefvec)` Sets the x, y and z components of the force defined by the texture.
PyNone	`setEnd(newendrt)` Sets the end time of an particle effect object
PyNone	`setFlag(newflag)` Sets the flag of an effect object.
PyNone	`setForce(newforce)` Sets the force applied to the particles.
PyNone	`setLife(newlife)` Sets the average life of the particles (4 generations).
PyNone	`setLifetime(newlifetime)` Sets the lifetime of a particle effect object
PyNone	`setMat(newmat)` Sets the indexes of the materials associated to the particles (4 generations).
PyNone	`setMult(newmult)` Sets the probabilities of a particle having a child.
PyNone	`setNabla(newnabla)` Sets the sensibility of the particles to the variations of the texture.
PyNone	`setNormfac(newnormfac)` Sets the normal strength of the particles (relatively to mesh).
PyNone	`setObfac(newobfac)` Sets the initial strength of the particles relatively to objects.
PyNone	`setRandfac(newrandfac)` Sets the random strength applied to the particles.
PyNone	`setRandlife(newrandlife)` Sets the variability of the life of the particles.
PyNone	`setSeed(newseed)` Sets the random number generator seed.
PyNone	`setSta(newstart)` Sets the starting time of an particle effect object
PyNone	`setTexfac(newtexfac)` Sets the strength applied to the particles from the texture of the object.
PyNone	`setTotkey(newtotkey)` Sets the number of keys associated to the particles.
PyNone	`setTotpart(newtotpart)` Sets the the total number of particles.
PyNone	`setType(name)` Deprecated, since only particle effects are supported.
PyNone	`setVectsize(newvectsize)` Sets the size of the vector which is associated to the particles.

Instance Variable Summary
tuple of 4 ints	`child`: The number of children a particle may have.
tuple of 4 ints	`childMat`: The materials used by the 4 generation particles.
float	`damping`: The particle damping factor.
tuple of 3 floats	`defvec`: The x, y and z axis of the force defined by the texture.
int	`dispMat`: The material used for the particles.
int	`emissionTex`: The texture used for texture emission.
float	`end`: The end time of the effect.
int	`flag`: The flag bitfield.
tuple of 3 floats	`force`: The constant force applied to the parts.
int	`forceTex`: The texture used for force.
int	`jitter`: Jitter table distribution: maximum particles per face.
tuple of 4 floats	`life`: The lifetime of of the next generation of particles.
float	`lifetime`: The lifetime of the effect.
tuple of 4 floats	`mult`: The probabilities of a particle having a child.
float	`nabla`: The nabla value.
float	`normfac`: The normal strength of the particles relative to mesh.
float	`obfac`: The strength of the particles relative to objects.
float	`randfac`: The initial random speed of the particles.
float	`randlife`: The variability of the life of the particles.
int	`seed`: The seed of the random number generator.
int	`speedType`: Controls which texture property affects particle speeds.
str	`speedVGroup`: The name of the vertex group used for speed control.
float	`sta`: The start time of the effect.
float	`texfac`: The initial speed of the particles caused by the texture.
int	`totkey`: The total number of key positions.
int	`totpart`: The total number of particles.
int	`type`: The type of the effect.
float	`vectsize`: The size of vectors associated to the particles (if any).
str	`vGroup`: The name of the vertex group used for emitted particles.

Method Details

getChild()

Retrieves the average number of children of the particles (4 generations).

Returns:: average number of children of the particles (4 generations).
(type=tuple of 4 ints)

getDefvec()

Retrieves the x, y and z components of the force defined by the texture.

Returns:: x, y and z components of the force defined by the texture.
(type=tuple of 3 floats)

getEndTime()

Retrieves the end time of a particle effect object

Returns:: the end time of the effect.
(type=float)

getFlag()

Retrieves the flag of an effect object. The flag is a bit-mask.

Returns:: The flag of the effect is a combination of parameters. See Flags for values.
(type=int)

getForce()

Retrieves the force applied to the particles.

Returns:: force applied to the particles.
(type=tuple of three floats)

getLife()

Retrieves the average life of the particles (4 generations)

Returns:: average life of the particles (4 generations)
(type=tuple of 4 floats)

getLifetime()

Retrieves the lifetime of a particle effect object

Returns:: the lifetime of the effect.
(type=float)

getMat()

Retrieves the indexes of the materials associated to the particles (4 generations).

Returns:: indexes of the materials associated to the particles (4 generations).
(type=tuple of 4 ints)

getMult()

Retrieves the probabilities of a particle having a child.

Returns:: probabilities of a particle having a child.
(type=tuple of 4 floats)

getNabla()

Retrieves the sensibility of the particles to the variations of the texture.

Returns:: sensibility of the particles to the variations of the texture.
(type=float)

getNormfac()

Retrieves the normal strength of the particles (relatively to mesh).

Returns:: normal strength of the particles (relatively to mesh).
(type=float)

getObfac()

Retrieves the initial strength of the particles relatively to objects.

Returns:: initial strength of the particles (relatively to mesh).
(type=float)

getParticlesLoc(time)

Get the location of each particle at a given time.

Parameters:: time - The desired time during the particle effect.
(type=int)

Returns:: The coordinates of each particle at the requested time.
(type=List of x,y,z coordinates)

getRandfac()

Retrieves the random strength applied to the particles.

Returns:: random strength applied to the particles.
(type=float)

getRandlife()

Retrieves the variability of the life of the particles.

Returns:: variability of the life of the particles.
(type=float)

getSeed()

Retrieves the random number generator seed.

Returns:: current seed value.
(type=int)

getStartTime()

Retrieves the starting time of a particle effect object

Returns:: the starting time of the effect.
(type=float)

getTexfac()

Retrieves the strength applied to the particles from the texture of the object.

Returns:: strength applied to the particles from the texture of the object.
(type=float)

getTotkey()

Retrieves the number of keys associated to the particles (kind of degree of freedom)

Returns:: number of keys associated to the particles.
(type=int)

getTotpart()

Retrieves the total number of particles.

Returns:: the total number of particles.
(type=int)

getType()

Retrieves the type of an effect object. Deprecated, since only particle effects are supported.

Returns:: the type of an effect object : should always return 1 (particle effect)
(type=int)

getVectsize()

Retrieves the size of the vector which is associated to the particles.

Returns:: size of the vector which is associated to the particles.
(type=float)

setChild(newchild)

Sets the average number of children of the particles (4 generations).

Parameters:: newchild - average number of children of the particles (4 generations).
(type=tuple of 4 ints)

Returns:: PyNone
(type=PyNone)

setDefvec(newdefvec)

Sets the x, y and z components of the force defined by the texture.

Parameters:: newdefvec - the x, y and z components of the force defined by the texture.
(type=tuple of 3 floats)

Returns:: PyNone
(type=PyNone)

setEnd(newendrt)

Sets the end time of an particle effect object

Parameters:: newendrt - the new end time.
(type=float)

Returns:: PyNone
(type=PyNone)

setFlag(newflag)

Sets the flag of an effect object. See Flags for values.

Parameters:: newflag - the new flag.
(type=int)

Returns:: PyNone
(type=PyNone)

setForce(newforce)

Sets the force applied to the particles.

Parameters:: newforce - force applied to the particles.
(type=tuple of 3 floats)

Returns:: PyNone
(type=PyNone)

setLife(newlife)

Sets the average life of the particles (4 generations).

Parameters:: newlife - average life of the particles (4 generations).
(type=tuple of 4 floats)

Returns:: PyNone
(type=PyNone)

setLifetime(newlifetime)

Sets the lifetime of a particle effect object

Parameters:: newlifetime - the new lifetime.
(type=float)

Returns:: PyNone
(type=PyNone)

setMat(newmat)

Sets the indexes of the materials associated to the particles (4 generations).

Parameters:: newmat - the indexes of the materials associated to the particles (4 generations).
(type=tuple of 4 ints)

Returns:: PyNone
(type=PyNone)

setMult(newmult)

Sets the probabilities of a particle having a child.

Parameters:: newmult - probabilities of a particle having a child.
(type=tuple of 4 floats)

Returns:: PyNone
(type=PyNone)

setNabla(newnabla)

Sets the sensibility of the particles to the variations of the texture.

Parameters:: newnabla - the sensibility of the particles to the variations of the texture.
(type=float)

Returns:: PyNone
(type=PyNone)

setNormfac(newnormfac)

Sets the normal strength of the particles (relatively to mesh).

Parameters:: newnormfac - the normal strength of the particles (relatively to mesh).
(type=float)

Returns:: PyNone
(type=PyNone)

setObfac(newobfac)

Sets the initial strength of the particles relatively to objects.

Parameters:: newobfac - the initial strength of the particles relatively to objects.
(type=float)

Returns:: PyNone
(type=PyNone)

setRandfac(newrandfac)

Sets the random strength applied to the particles.

Parameters:: newrandfac - the random strength applied to the particles.
(type=float)

Returns:: PyNone
(type=PyNone)

setRandlife(newrandlife)

Sets the variability of the life of the particles.

Parameters:: newrandlife - the variability of the life of the particles.
(type=float)

Returns:: PyNone
(type=PyNone)

setSeed(newseed)

Sets the random number generator seed.

Parameters:: newseed - new seed value.
(type=int)

Returns:: PyNone
(type=PyNone)

setSta(newstart)

Sets the starting time of an particle effect object

Parameters:: newstart - the new starting time.
(type=float)

Returns:: PyNone
(type=PyNone)

setTexfac(newtexfac)

Sets the strength applied to the particles from the texture of the object.

Parameters:: newtexfac - the strength applied to the particles from the texture of the object.
(type=float)

Returns:: PyNone
(type=PyNone)

setTotkey(newtotkey)

Sets the number of keys associated to the particles.

Parameters:: newtotkey - number of keys associated to the particles.
(type=int)

Returns:: PyNone
(type=PyNone)

setTotpart(newtotpart)

Sets the the total number of particles.

Parameters:: newtotpart - the the total number of particles.
(type=int)

Returns:: PyNone
(type=PyNone)

setType(name)

Deprecated, since only particle effects are supported.

Parameters:: name - the new type.
(type=int)

Returns:: PyNone
(type=PyNone)

setVectsize(newvectsize)

Sets the size of the vector which is associated to the particles.

Parameters:: newvectsize - the size of the vector which is associated to the particles.
(type=float)

Returns:: PyNone
(type=PyNone)

Instance Variable Details

child

The number of children a particle may have. Values are clamped to the range [1,600].

Type:: tuple of 4 ints

childMat

The materials used by the 4 generation particles. Values are clamped to the range [1,16].

Type:: tuple of 4 ints

damping

The particle damping factor. This controls the rate at which particles decelerate. Values are clamped to the range [0.0,1.0].

Type:: float

defvec

The x, y and z axis of the force defined by the texture. Values are clamped to the range [-1.0,1.0].

Type:: tuple of 3 floats

dispMat

The material used for the particles. Value is clamped to the range [1,16].

Type:: int

emissionTex

The texture used for texture emission. Value is clamped to the range [1,10].

Type:: int

end

The end time of the effect. Value is clamped to the range [1.0,30000.0].

Type:: float

flag

The flag bitfield. See Flags for values.

Type:: int

force

The constant force applied to the parts. Values are clamped to the range [-1.0,1.0].

Type:: tuple of 3 floats

forceTex

The texture used for force. Value is clamped to the range [1,10].

Type:: int

jitter

Jitter table distribution: maximum particles per face. Values are clamped to the range [0,200].

Type:: int

life

The lifetime of of the next generation of particles. Values are clamped to the range [1.0,30000.0].

Type:: tuple of 4 floats

lifetime

The lifetime of the effect. Value is clamped to the range [1.0,30000.0].

Type:: float

mult

The probabilities of a particle having a child. Values are clamped to the range [0.0,1.0].

Type:: tuple of 4 floats

nabla

The nabla value. Value is clamped to the range [0.0001,1.0].

Type:: float

normfac

The normal strength of the particles relative to mesh. Value is clamped to the range [-2.0,2.0].

Type:: float

obfac

The strength of the particles relative to objects. Value is clamped to the range [-1.0,1.0].

Type:: float

randfac

The initial random speed of the particles. Value is clamped to the range [0.0,2.0].

Type:: float

randlife

The variability of the life of the particles. Value is clamped to the range [0.0,2.0].

Type:: float

seed

The seed of the random number generator. Value is clamped to the range [0,255].

Type:: int

speedType

Controls which texture property affects particle speeds. See SpeedTypes for values and their meanings.

Type:: int

speedVGroup

The name of the vertex group used for speed control.

Type:: str

sta

The start time of the effect. Value is clamped to the range [-250.0,30000.0].

Type:: float

texfac

The initial speed of the particles caused by the texture. Value is clamped to the range [0.0,2.0].

Type:: float

totkey

The total number of key positions. Value is clamped to the range [1,100].

Type:: int

totpart

The total number of particles. Value is clamped to the range [1,100000].

Type:: int

type

The type of the effect. Deprecated.

Type:: int

vectsize

The size of vectors associated to the particles (if any). Value is clamped to the range [0.0,1.0].

Type:: float

vGroup

The name of the vertex group used for emitted particles.

Type:: str

Generated by Epydoc 2.1 on Thu Dec 22 22:38:13 2005

http://epydoc.sf.net