Package bpy :: Module types :: Class FieldSettings
[hide private]
[frames] | no frames]

Class FieldSettings

The Field Settings Object

Field settings for an object in physics simulation.

References

Instance Variables [hide private]
boolean do_absorption
Force gets absorbed by collision objects
boolean do_location
Effect particles' location
boolean do_rotation
Effect particles' dynamic rotation
float in [0, 10] falloff_power
Falloff power (real gravitational falloff = 2)
enum falloff_type
Fall-off shape.
float in [0, 10] flow
Convert effector force into air flow velocity
boolean force_2d
Apply force only in 2d
boolean global_coordinates
Use effector/global coordinates for turbulence
float in [-1, 1] guide_clump_amount
Amount of clumpimg
float in [-0.999, 0.999] guide_clump_shape
Shape of clumpimg
float in [0, 0.99] guide_free
Guide-free time from particle life's end
float in [0, 10] guide_kink_amplitude
The amplitude of the offset
enum guide_kink_axis
Which axis to use for offset in...
float in [0, 10] guide_kink_frequency
The frequency of the offset (1/total length)
float in [-0.999, 0.999] guide_kink_shape
djust the offset to the beginning/end
enum guide_kink_type
Type of periodic offset on the curve in...
float in [0, 1000] guide_minimum
The distance from which particles are affected fully.
boolean guide_path_add
Based on distance/falloff it adds a portion of the entire path
float in [0, 10] harmonic_damping
Damping of the harmonic force
float in [-10, 10] inflow
Inwards component of the vortex force
float in [-2, 2] linear_drag
Drag component proportional to velocity.
float in [0, 1000] maximum_distance
Maximum distance for the field to work
float in [0, 1000] minimum_distance
Minimum distance for the field's fall-off
float in [0, 10] noise
Noise of the force
float in [-2, 2] quadratic_drag
Drag component proportional to the square of velocity.
float in [0, 10] radial_falloff
Radial falloff power (real gravitational falloff = 2)
float in [0, 1000] radial_maximum
Maximum radial distance for the field to work
float in [0, 1000] radial_minimum
Minimum radial distance for the field's fall-off
boolean root_coordinates
Texture coordinates from root particle locations
int in [1, 128] seed
Seed of the noise
enum shape
Which direction is used to calculate the effector force.
float in [0, 10] size
Size of the noise
float in [-1000, 1000] strength
Strength of force field
Texture texture
Texture to use as force
enum texture_mode
How the texture effect is calculated (RGB & Curl need a RGB texture else Gradient will be used instead) in...
float in [0.0001, 1] texture_nabla
Defines size of derivative offset used for calculating gradient and curl
enum type
Type of field.
boolean use_coordinates
Use object/global coordinates for texture
boolean use_max_distance
Use a maximum distance for the field to work
boolean use_min_distance
Use a minimum distance for the field's fall-off
boolean use_radial_max
Use a maximum radial distance for the field to work
boolean use_radial_min
Use a minimum radial distance for the field's fall-off
enum z_direction
Effect in full or only positive/negative Z direction.
Instance Variable Details [hide private]

falloff_type

Fall-off shape. in...
  • SPHERE
  • TUBE
  • CONE
Type:
enum

guide_kink_axis

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

guide_kink_type

Type of periodic offset on the curve in...
  • NONE
  • CURL
  • RADIAL
  • WAVE
  • BRAID
  • ROTATION
  • ROLL
Type:
enum

shape

Which direction is used to calculate the effector force. in...
  • POINT
  • PLANE
  • SURFACE
  • POINTS
Type:
enum

texture_mode

How the texture effect is calculated (RGB & Curl need a RGB texture else Gradient will be used instead) in...
  • RGB
  • GRADIENT
  • CURL
Type:
enum

type

Type of field. in...
  • NONE
  • FORCE
  • WIND
  • VORTEX
  • MAGNET
  • HARMONIC
  • CHARGE
  • LENNARDJ
  • TEXTURE
  • GUIDE
  • BOID
  • TURBULENCE
  • DRAG
Type:
enum

z_direction

Effect in full or only positive/negative Z direction. in...
  • BOTH
  • POSITIVE
  • NEGATIVE
Type:
enum