Home       Trees       Indices       Help   
Package bpy :: Module types :: Class ParticleSettings
[hide private]
[frames] | no frames]

Class ParticleSettings

The Particle Settings Object

Particle settings, reusable by multiple particle systems.

References

Instance Methods [hide private]
 
animation_data_clear()
Clear animation on this this ID. (Inherited from bpy.types.ID)
AnimData
animation_data_create()
Create animation data to this ID, note that not all ID types support this. (Inherited from bpy.types.ID)
ID
copy()
Create a copy of this datablock (not supported for all datablocks). (Inherited from bpy.types.ID)
Instance Variables [hide private]
boolean abs_path_time
Path timing is in absolute frames
ParticleDupliWeight (readonly) active_dupliweight
Active Dupli Object
int in [0, inf] active_dupliweight_index
Active Dupli Object Index
int in [0, 45] adaptive_angle
How many degrees path has to curve to make another render segment
int in [0, 50] adaptive_pix
How many pixels path has to cover to make another render segment
int in [0, 10000000] amount
Total number of particles.
float in [-200, 200] angular_velocity_factor
Angular velocity amount
enum angular_velocity_mode
Particle angular velocity mode.
boolean animate_branching
Animate branching
AnimData (readonly) animation_data
Animation data for this datablock.
enum billboard_align
In respect to what the billboards are aligned in...
enum billboard_animation
How to animate billboard textures.
boolean billboard_lock
Lock the billboards align axis
Object billboard_object
Billboards face this object (default is active camera)
float array of 2 items in [-100, 100] billboard_offset
Billboard Offset
float in [0, 1] billboard_random_tilt
Random tilt of the billboards
enum billboard_split_offset
How to offset billboard textures in...
float in [-1, 1] billboard_tilt
Tilt of the billboards
int in [1, 100] billboard_uv_split
Amount of rows/columns to split uv coordinates for billboards
BoidSettings (readonly) boids
Boid Settings
boolean boids_2d
Constrain boids to a surface
float in [0, 1] branch_threshold
Threshold of branching.
boolean branching
Branch child paths from each other.
float in [0, 200] brownian_factor
Specify the amount of brownian motion
boolean child_effector
Apply effectors to children.
boolean child_guide
child_guide
float in [0, 1] child_length
Length of child paths
float in [0, 1] child_length_thres
Amount of particles left untouched by child path length.
int in [0, 100000] child_nbr
Amount of children/parent
float in [0, 10] child_radius
Radius of children around parent.
float in [0, 1] child_random_size
Random variation to the size of the child particles.
boolean child_render
child_render
float in [0, 1] child_roundness
Roundness of children around parent.
float in [0.001, 100000] child_size
A multiplier for the child particle size.
enum child_type
Create child particles in...
float in [-1, 1] clump_factor
Amount of clumping
float in [-0.999, 0.999] clumppow
Shape of clumping
float in [0, 1] damp_factor
Specify the amount of damping
boolean die_on_collision
Particles die when they collide with a deflector object.
boolean died
Show particles after they have died
int in [0, 100] display
Percentage of particles to display in 3d view
enum distribution
How to distribute particles on selected element in...
float in [0, 1] drag_factor
Specify the amount of air-drag.
enum draw_as
How particles are drawn in viewport in...
boolean draw_health
Draw boid health
int in [0, 10] draw_size
Size of particles on viewport in pixels (0=default)
int in [0, 7] draw_step
How many steps paths are drawn with (power of 2)
Group dupli_group
Show Objects in this Group in place of particles
Object dupli_object
Show this Object in place of particles.
Collection of ParticleDupliWeight (readonly) dupliweights
Weights for all of the objects in the dupli group.
float in [0, 1] effect_hair
Hair stiffness for effectors
EffectorWeights (readonly) effector_weights
Effector Weights
enum emit_from
Where to emit particles from in...
boolean emitter
Render emitter Object also.
boolean enable_simplify
Remove child strands as the object becomes smaller on the screen.
float in [-300000, 300000] end
Frame # to stop emitting particles.
boolean even_distribution
Use even distribution from faces based on face areas or edge lengths.
boolean fake_user
Saves this datablock even if it has no users (Inherited from bpy.types.ID)
FieldSettings (readonly) force_field_1
Force Field 1
FieldSettings (readonly) force_field_2
Force Field 2
boolean grid_invert
Invert what is considered object and what is not.
int in [1, 46] grid_resolution
The resolution of the particle grid.
boolean hair_bspline
Interpolate hair using B-Splines.
boolean hair_geometry
Hair Geometry
int in [2, 50] hair_step
Number of hair segments
enum integrator
Select physics integrator type in...
float in [0, 2] jitter_factor
Amount of jitter applied to the sampling.
int in [1, 10000] keyed_loops
Number of times the keys are looped.
int in [0, inf] keys_step
Keys Step
enum kink
Type of periodic offset on the path in...
float in [-100000, 100000] kink_amplitude
The amplitude of the offset.
enum kink_axis
Which axis to use for offset in...
float in [-100000, 100000] kink_frequency
The frequency of the offset (1/total length)
float in [-0.999, 0.999] kink_shape
Adjust the offset to the beginning/end
Library (readonly) library
Library file the datablock is linked from. (Inherited from bpy.types.ID)
float in [1, 300000] lifetime
Specify the life span of the particles
float in [0, 100000] line_length_head
Length of the line's head
float in [0, 100000] line_length_tail
Length of the line's tail
boolean loop
Loop particle lives.
float in [0.001, 100000] mass
Specify the mass of the particles
int in [1, 16] material
Specify material used for the particles
boolean material_color
Draw particles using material's diffuse color.
string name
Unique datablock ID name. (Inherited from bpy.types.ID)
float in [-200, 200] normal_factor
Let the surface normal give the particle a starting speed.
boolean num
Show particle number
float array of 3 items in [-200, 200] object_aligned_factor
Let the emitter object orientation give the particle a starting speed
float in [-200, 200] object_factor
Let the object give the particle a starting speed
boolean parent
Render parent particles.
float in [-200, 200] particle_factor
Let the target particle give the particle a starting speed.
float in [0.001, 100000] particle_size
The size of the particles
float in [-inf, inf] path_end
End time of drawn path.
float in [-inf, inf] path_start
Starting time of drawn path.
float in [-1, 1] phase_factor
Initial rotation phase
enum physics_type
Particle physics type in...
boolean rand_group
Pick objects from group randomly
float in [0, 200] random_factor
Give the starting speed a random variation.
float in [0, 1] random_length
Give path length a random variation.
float in [0, 1] random_lifetime
Give the particle life a random variation.
float in [0, 1] random_phase_factor
Randomize rotation phase
float in [0, 1] random_rotation_factor
Randomize rotation
float in [0, 1] random_size
Give the particle size a random variation
enum react_event
The event of target particles to react on.
boolean react_multiple
React multiple times.
boolean react_start_end
Give birth to unreacted particles eventually.
float in [0, 10] reaction_shape
Power of reaction strength dependence on distance to target.
float in [-10, 10] reactor_factor
Let the vector away from the target particles location give the particle a starting speed.
enum ren_as
How particles are rendered in...
boolean render_adaptive
Draw steps of the particle path
int in [0, 9] render_step
How many steps paths are rendered with (power of 2)
boolean render_strand
Use the strand primitive for rendering
int in [0, 100000] rendered_child_nbr
Amount of children/parent for rendering.
enum rotate_from
Rotate From in...
boolean rotation_dynamic
Sets rotation to dynamic/constant
enum rotation_mode
Particles initial rotation in...
float in [0, 100000] rough1
Amount of location dependent rough.
float in [0.01, 100000] rough1_size
Size of location dependent rough.
float in [0, 100000] rough2
Amount of random rough.
float in [0.01, 100000] rough2_size
Size of random rough.
float in [0, 1] rough2_thres
Amount of particles left untouched by random rough.
float in [0, 10] rough_end_shape
Shape of end point rough
float in [0, 100000] rough_endpoint
Amount of end point rough.
boolean self_effect
Particle effectors effect themselves.
boolean show_size
Show particle size
float in [0, 1] simplify_rate
Speed of simplification
int in [1, 32768] simplify_refsize
Reference size size in pixels, after which simplification begins.
float in [0, 1] simplify_transition
Transition period for fading out strands.
float in [0, 0.999] simplify_viewport
Speed of Simplification
boolean size_deflect
Use particle's size in deflection.
boolean sizemass
Multiply mass with particle size.
float in [-300000, 300000] start
Frame # to start emitting particles.
boolean symmetric_branching
Start and end points are the same.
boolean tag
Tools can use this to tag data, (initial state is undefined). (Inherited from bpy.types.ID)
float in [-200, 200] tangent_factor
Let the surface tangent give the particle a starting speed.
float in [-1, 1] tangent_phase
Rotate the surface tangent.
float in [0, 10] time_tweak
A multiplier for physics timestep (1.0 means one frame = 1/25 seconds)
int in [1, 100000] trail_count
Number of trail particles.
boolean trand
Emit in random order of elements
enum type
Type in...
boolean unborn
Show particles before they are emitted.
boolean use_global_dupli
Use object's global coordinates for duplication.
boolean use_group_count
Use object multiple times in the same group
int in [0, 1000] userjit
Emission locations / face (0 = automatic).
int (readonly) in [0, 32767] users
Number of times this datablock is referenced. (Inherited from bpy.types.ID)
boolean velocity
Show particle velocity
boolean velocity_length
Multiply line length by particle speed
boolean viewport
Viewport
float in [0, 1] virtual_parents
Relative amount of virtual parents.
boolean whole_group
Use whole group at once.
Instance Variable Details [hide private]

angular_velocity_mode

Particle angular velocity mode. in...
  • NONE
  • SPIN
  • RAND
Type:
enum

billboard_align

In respect to what the billboards are aligned in...
  • X
  • Y
  • Z
  • VIEW
  • VEL
Type:
enum

billboard_animation

How to animate billboard textures. in...
  • NONE
  • TIME
  • ANGLE
Type:
enum

billboard_split_offset

How to offset billboard textures in...
  • NONE
  • LINEAR
  • RANDOM
Type:
enum

child_type

Create child particles in...
  • NONE
  • PARTICLES
  • FACES
Type:
enum

distribution

How to distribute particles on selected element in...
  • JIT
  • RAND
  • GRID
Type:
enum

draw_as

How particles are drawn in viewport in...
  • NONE
  • RENDER
  • DOT
  • CIRC
  • CROSS
  • AXIS
Type:
enum

emit_from

Where to emit particles from in...
  • VERT
  • FACE
  • VOLUME
  • PARTICLE
Type:
enum

integrator

Select physics integrator type in...
  • EULER
  • VERLET
  • MIDPOINT
  • RK4
Type:
enum

kink

Type of periodic offset on the path in...
  • NO
  • CURL
  • RADIAL
  • WAVE
  • BRAID
Type:
enum

kink_axis

Which axis to use for offset in...
  • X
  • Y
  • Z
Type:
enum

physics_type

Particle physics type in...
  • NO
  • NEWTON
  • KEYED
  • BOIDS
Type:
enum

react_event

The event of target particles to react on. in...
  • DEATH
  • COLLIDE
  • NEAR
Type:
enum

ren_as

How particles are rendered in...
  • NONE
  • HALO
  • LINE
  • PATH
  • OBJECT
  • GROUP
  • BILLBOARD
Type:
enum

rotate_from

Rotate From in...
  • KEYS
  • ZINCR
  • IINCR
Type:
enum

rotation_mode

Particles initial rotation in...
  • NONE
  • NOR
  • VEL
  • GLOB_X
  • GLOB_Y
  • GLOB_Z
  • OB_X
  • OB_Y
  • OB_Z
Type:
enum

type

Type in...
  • EMITTER
  • HAIR
Type:
enum

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Dec 9 12:15:54 2009 http://epydoc.sourceforge.net