Module Effect

Module Effect

source code

The Blender.Effect submodule

Deprecated: This module is now maintained but not actively developed.

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)     


Classes
  Effect
This object gives access to particle effect data in Blender.
Functions
Blender Effect
New(name)
Creates a new particle effect and attaches to an object.
source code
Blender Effect or a list of Blender Effects
Get(name=None, position=None)
Get an Effect from Blender.
source code
Variables
read-only dictionary Flags
The particle effect flags.
read-only dictionary SpeedTypes
The available settings for selecting particle speed vectors.
Function Details

New(name)

source code 
Creates a new particle effect and attaches to an object.
Parameters:
  • name (string) - The name of object to associate with the effect. Only mesh objects are supported.
Returns: Blender Effect
the new effect

Get(name=None, position=None)

source code 
Get an Effect from Blender.
Parameters:
  • name (string) - The name of object linked to the effect.
  • position (int) - The position of the effect in the list of effects linked to the object.
Returns: Blender Effect or a list of Blender Effects
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

Variables Details

Flags

The particle effect flags. Values can be ORed.
  • SELECTED: The particle effect is selected in the UI. (Read-only)
  • BSPLINE: Use a B-spline formula for particle interpolation
  • STATIC: Make static particles
  • ANIMATED: Recalculate static particles for each rendered frame
  • VERTS: Emit particles from vertices
  • FACES: Emit particles from faces
  • EVENDIST: Use even distribution based on face area (requires FACES)
  • TRUERAND: Use true random distribution based on face area (requires FACES)
  • UNBORN: Make particles appear before they are emitted
  • DIED: Make particles appear after they have died
  • EMESH: Render emitter mesh
Type:
read-only dictionary

SpeedTypes

The available settings for selecting particle speed vectors. Only one setting is active at a time.
  • INTENSITY: Use texture intensity
  • RGB: Use RGB values
  • GRADIENT: Use texture gradient
Type:
read-only dictionary