979c28bf06
remaining effect type, it didn't make much sense to leave things implemented in two separate files. Changes include: * two bug fixes (the getChild() and getMat() methods were using floats instead of shorts) * performing clamping on input values * implementing attributes using tp_getset * merging Effect and Particle functions: the Particle module exists in name only, with the Particle.New() and Particle.Get() functions remaining for backward compatibility (they are in fact identical to Effect.New() and Effect.Get() functions) * update of doc/Effect.py (including remove all old references to wave and build effects)
507 lines
14 KiB
Python
507 lines
14 KiB
Python
# Blender.Effect module and the Effect PyType effect
|
|
|
|
"""
|
|
The Blender.Effect submodule
|
|
|
|
B{new}: now L{Get}('objname') (without specifying second paramenter: 'position') returns a list of all effects linked to object "objname".
|
|
|
|
Effect
|
|
======
|
|
|
|
INTRODUCTION
|
|
|
|
The Effect module allows you to access all the data of particle effects.
|
|
An effect can modify a mesh object using particles, where vertex of
|
|
the mesh emits particles, which can themselves emit new particles.
|
|
|
|
In the Blender internals, the effect object is just a placeholder for
|
|
the particle effect. Prior to v2.39 build and wave effects were also
|
|
supported by Blender, and the Python API supported all three types of
|
|
effects. They were removed in v2.39 when the build and wave modifiers
|
|
were implemented.
|
|
|
|
|
|
Example::
|
|
import Blender
|
|
listffects = Blender.Effect.Get()
|
|
print listeffects
|
|
eff = listeffects[0]
|
|
#we suppose the first effect is a build effect
|
|
print eff.getLen()
|
|
eff.setLen(500)
|
|
|
|
@type Flags: read-only dictionary
|
|
@var Flags: The particle effect flags. Values can be ORed.
|
|
- SELECTED: The particle effect is selected in the UI. (Read-only)
|
|
- FACE: Also emit particles from faces
|
|
- STATIC: Make static particles
|
|
- ANIMATED: Recalculate static particles for each rendered frame
|
|
- BSPLINE: Use a B-spline formula for particle interpolation
|
|
"""
|
|
|
|
def New (name):
|
|
"""
|
|
Creates a new particle effect and attaches to an object.
|
|
@type name: string
|
|
@param name: The name of object to associate with the effect. Only mesh
|
|
objects are supported.
|
|
@rtype: Blender Effect
|
|
@return: the new effect
|
|
"""
|
|
|
|
def Get (name = None, position = None):
|
|
"""
|
|
Get an Effect from Blender.
|
|
@type name: string
|
|
@param name: The name of object linked to the effect.
|
|
@type position: int
|
|
@param position: The position of the effect in the list of effects linked to the object.
|
|
@rtype: Blender Effect or a list of Blender Effects
|
|
@return: It depends on the 'objname, position' parameters:
|
|
- (): A list with all Effects in the current scene;
|
|
- (name): A list with all Effects linked to the given object;
|
|
- (name, position): The Effect linked to the given object at the given position
|
|
"""
|
|
|
|
def GetParticlesLoc (name, position, time ):
|
|
"""
|
|
Get the location of each particle at a given time.
|
|
@type name: string
|
|
@param name: The name of object linked to the effect.
|
|
@type position: int
|
|
@param position: The position of the effect in the list of effects
|
|
linked to the object.
|
|
@type time: int
|
|
@param time: The desired time during the particle effect.
|
|
@rtype: List of x,y,z coordinates
|
|
@return: The coordinates of each particle at the requested time.
|
|
"""
|
|
|
|
|
|
class Effect:
|
|
"""
|
|
The Effect object
|
|
=================
|
|
This object gives access to particle effect data in Blender.
|
|
|
|
@ivar child: The number of children a particle may have.
|
|
Values are clamped to the range [1,600].
|
|
@type child: tuple of 4 ints
|
|
@ivar 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 defvec: tuple of 3 floats
|
|
@ivar end: The end time of the effect
|
|
Value is clamped to the range [1.0,30000.0].
|
|
@type end: float
|
|
@ivar flag: The flag bitfield. See L{Flags} for values.
|
|
@type flag: int
|
|
@ivar force: The constant force applied to the parts.
|
|
Values are clamped to the range [-1.0,1.0].
|
|
@type force: tuple of 3 floats
|
|
@ivar life: The lifetime of of the next generation of particles.
|
|
Values are clamped to the range [1.0,30000.0].
|
|
@type life: tuple of 4 floats
|
|
@ivar lifetime: The lifetime of the effect.
|
|
Value is clamped to the range [1.0,30000.0].
|
|
@type lifetime: float
|
|
@ivar mat: The materials used by the 4 generation particles.
|
|
Values are clamped to the range [1,8].
|
|
@type mat: tuple of 4 ints
|
|
@ivar mult: The probabilities of a particle having a child.
|
|
Values are clamped to the range [0.0,1.0].
|
|
@type mult: tuple of 4 floats
|
|
@ivar nabla: The nabla value.
|
|
Value is clamped to the range [0.0001,1.0].
|
|
@type nabla: float
|
|
@ivar normfac: The normal strength of the particles relative to mesh.
|
|
Value is clamped to the range [-2.0,2.0].
|
|
@type normfac: float
|
|
@ivar obfac: The strength of the particles relative to objects.
|
|
Value is clamped to the range [-1.0,1.0].
|
|
@type obfac: float
|
|
@ivar randfac: The initial random speed of the particles.
|
|
Value is clamped to the range [0.0,2.0].
|
|
@type randfac: float
|
|
@ivar randlife: The variability of the life of the particles.
|
|
Value is clamped to the range [0.0,2.0].
|
|
@type randlife: float
|
|
@ivar seed: The seed of the random number generator.
|
|
Value is clamped to the range [0,255].
|
|
@type seed: int
|
|
@ivar sta: The start time of the effect.
|
|
Value is clamped to the range [-250.0,30000.0].
|
|
@type sta: float
|
|
@ivar texfac: The initial speed of the particles caused by the texture.
|
|
Value is clamped to the range [0.0,2.0].
|
|
@type texfac: float
|
|
@ivar totpart: The total number of particles.
|
|
Value is clamped to the range [1,100000].
|
|
@type totpart: int
|
|
@ivar totkey: The total number of key positions.
|
|
Value is clamped to the range [1,100].
|
|
@type totkey: int
|
|
@ivar type: The type of the effect. Deprecated.
|
|
@type type: int
|
|
@ivar vectsize: The size of vectors associated to the particles (if any).
|
|
Value is clamped to the range [0.0,1.0].
|
|
@type vectsize: float
|
|
"""
|
|
|
|
def getType():
|
|
"""
|
|
Retrieves the type of an effect object.
|
|
Deprecated, since only particle effects are supported.
|
|
@rtype: int
|
|
@return: the type of an effect object : should always return 1
|
|
(particle effect)
|
|
"""
|
|
|
|
def setType(name):
|
|
"""
|
|
Deprecated, since only particle effects are supported.
|
|
@type name: int
|
|
@param name : the new type.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getFlag():
|
|
"""
|
|
Retrieves the flag of an effect object. The flag is a bit-mask.
|
|
@rtype: int
|
|
@return: The flag of the effect is a combination of parameters. See
|
|
L{Flags} for values.
|
|
|
|
"""
|
|
|
|
def setFlag(newflag):
|
|
"""
|
|
Sets the flag of an effect object. See L{Flags} for values.
|
|
@type newflag: int
|
|
@param newflag: the new flag.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getStartTime():
|
|
"""
|
|
Retrieves the starting time of a particle effect object
|
|
@rtype: float
|
|
@return: the starting time of the effect.
|
|
"""
|
|
|
|
def setSta(newstart):
|
|
"""
|
|
Sets the starting time of an particle effect object
|
|
@type newstart: float
|
|
@param newstart: the new starting time.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getEndTime():
|
|
"""
|
|
Retrieves the end time of a particle effect object
|
|
@rtype: float
|
|
@return: the end time of the effect.
|
|
"""
|
|
|
|
|
|
def setEnd(newendrt):
|
|
"""
|
|
Sets the end time of an particle effect object
|
|
@type newendrt: float
|
|
@param newendrt: the new end time.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getLifetime():
|
|
"""
|
|
Retrieves the lifetime of a particle effect object
|
|
@rtype: float
|
|
@return: the lifetime of the effect.
|
|
"""
|
|
|
|
|
|
def setLifetime(newlifetime):
|
|
"""
|
|
Sets the lifetime of a particle effect object
|
|
@type newlifetime: float
|
|
@param newlifetime: the new lifetime.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getNormfac():
|
|
"""
|
|
Retrieves the normal strength of the particles (relatively to mesh).
|
|
@rtype: float
|
|
@return: normal strength of the particles (relatively to mesh).
|
|
"""
|
|
|
|
|
|
def setNormfac(newnormfac):
|
|
"""
|
|
Sets the normal strength of the particles (relatively to mesh).
|
|
@type newnormfac: float
|
|
@param newnormfac: the normal strength of the particles (relatively to mesh).
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getObfac():
|
|
"""
|
|
Retrieves the initial strength of the particles relatively to objects.
|
|
@rtype: float
|
|
@return: initial strength of the particles (relatively to mesh).
|
|
"""
|
|
|
|
|
|
def setObfac(newobfac):
|
|
"""
|
|
Sets the initial strength of the particles relatively to objects.
|
|
@type newobfac: float
|
|
@param newobfac: the initial strength of the particles relatively to objects.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getRandfac():
|
|
"""
|
|
Retrieves the random strength applied to the particles.
|
|
@rtype: float
|
|
@return: random strength applied to the particles.
|
|
"""
|
|
|
|
|
|
def setRandfac(newrandfac):
|
|
"""
|
|
Sets the random strength applied to the particles.
|
|
@type newrandfac: float
|
|
@param newrandfac: the random strength applied to the particles.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getTexfac():
|
|
"""
|
|
Retrieves the strength applied to the particles from the texture of the object.
|
|
@rtype: float
|
|
@return: strength applied to the particles from the texture of the object.
|
|
"""
|
|
|
|
|
|
def setTexfac(newtexfac):
|
|
"""
|
|
Sets the strength applied to the particles from the texture of the object.
|
|
@type newtexfac: float
|
|
@param newtexfac: the strength applied to the particles from the texture of the object.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getRandlife():
|
|
"""
|
|
Retrieves the variability of the life of the particles.
|
|
@rtype: float
|
|
@return: variability of the life of the particles.
|
|
"""
|
|
|
|
|
|
def setRandlife(newrandlife):
|
|
"""
|
|
Sets the variability of the life of the particles.
|
|
@type newrandlife: float
|
|
@param newrandlife: the variability of the life of the particles.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getNabla():
|
|
"""
|
|
Retrieves the sensibility of the particles to the variations of the texture.
|
|
@rtype: float
|
|
@return: sensibility of the particles to the variations of the texture.
|
|
"""
|
|
|
|
|
|
def setNabla(newnabla):
|
|
"""
|
|
Sets the sensibility of the particles to the variations of the texture.
|
|
@type newnabla: float
|
|
@param newnabla: the sensibility of the particles to the variations of the texture.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getVectsize():
|
|
"""
|
|
Retrieves the size of the vector which is associated to the particles.
|
|
@rtype: float
|
|
@return: size of the vector which is associated to the particles.
|
|
"""
|
|
|
|
|
|
def setVectsize(newvectsize):
|
|
"""
|
|
Sets the size of the vector which is associated to the particles.
|
|
@type newvectsize: float
|
|
@param newvectsize: the size of the vector which is associated to the particles.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getTotpart():
|
|
"""
|
|
Retrieves the total number of particles.
|
|
@rtype: int
|
|
@return: the total number of particles.
|
|
"""
|
|
|
|
|
|
def setTotpart(newtotpart):
|
|
"""
|
|
Sets the the total number of particles.
|
|
@type newtotpart: int
|
|
@param newtotpart: the the total number of particles.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getTotkey():
|
|
"""
|
|
Retrieves the number of keys associated to the particles (kind of degree of freedom)
|
|
@rtype: int
|
|
@return: number of keys associated to the particles.
|
|
"""
|
|
|
|
|
|
def setTotkey(newtotkey):
|
|
"""
|
|
Sets the number of keys associated to the particles.
|
|
@type newtotkey: int
|
|
@param newtotkey: number of keys associated to the particles.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getSeed():
|
|
"""
|
|
Retrieves the random number generator seed.
|
|
@rtype: int
|
|
@return: current seed value.
|
|
"""
|
|
|
|
def setSeed(newseed):
|
|
"""
|
|
Sets the random number generator seed.
|
|
@type newseed: int
|
|
@param newseed: new seed value.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getForce():
|
|
"""
|
|
Retrieves the force applied to the particles.
|
|
@rtype: tuple of three floats
|
|
@return: force applied to the particles.
|
|
"""
|
|
|
|
|
|
def setForce(newforce):
|
|
"""
|
|
Sets the force applied to the particles.
|
|
@type newforce: tuple of 3 floats
|
|
@param newforce: force applied to the particles.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getMult():
|
|
"""
|
|
Retrieves the probabilities of a particle having a child.
|
|
@rtype: tuple of 4 floats
|
|
@return: probabilities of a particle having a child.
|
|
"""
|
|
|
|
|
|
def setMult(newmult):
|
|
"""
|
|
Sets the probabilities of a particle having a child.
|
|
@type newmult: tuple of 4 floats
|
|
@param newmult: probabilities of a particle having a child.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getLife():
|
|
"""
|
|
Retrieves the average life of the particles (4 generations)
|
|
@rtype: tuple of 4 floats
|
|
@return: average life of the particles (4 generations)
|
|
"""
|
|
|
|
|
|
def setLife(newlife):
|
|
"""
|
|
Sets the average life of the particles (4 generations).
|
|
@type newlife: tuple of 4 floats
|
|
@param newlife: average life of the particles (4 generations).
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getChild():
|
|
"""
|
|
Retrieves the average number of children of the particles (4 generations).
|
|
@rtype: tuple of 4 ints
|
|
@return: average number of children of the particles (4 generations).
|
|
"""
|
|
|
|
def setChild(newchild):
|
|
"""
|
|
Sets the average number of children of the particles (4 generations).
|
|
@type newchild: tuple of 4 ints
|
|
@param newchild: average number of children of the particles (4 generations).
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
def getMat():
|
|
"""
|
|
Retrieves the indexes of the materials associated to the particles (4 generations).
|
|
@rtype: tuple of 4 ints
|
|
@return: indexes of the materials associated to the particles (4 generations).
|
|
"""
|
|
|
|
|
|
def setMat(newmat):
|
|
"""
|
|
Sets the indexes of the materials associated to the particles (4 generations).
|
|
@type newmat: tuple of 4 ints
|
|
@param newmat: the indexes of the materials associated to the particles (4 generations).
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|
|
|
|
def getDefvec():
|
|
"""
|
|
Retrieves the x, y and z components of the force defined by the texture.
|
|
@rtype: tuple of 3 floats
|
|
@return: x, y and z components of the force defined by the texture.
|
|
"""
|
|
|
|
|
|
def setDefvec(newdefvec):
|
|
"""
|
|
Sets the x, y and z components of the force defined by the texture.
|
|
@type newdefvec: tuple of 3 floats
|
|
@param newdefvec: the x, y and z components of the force defined by the texture.
|
|
@rtype: PyNone
|
|
@return: PyNone
|
|
"""
|
|
|