FluidEffectorSettings(bpy_struct)

base class — bpy_struct

class bpy.types.FluidEffectorSettings(bpy_struct)

Smoke collision settings

effector_type

Change type of effector in the simulation (default 'COLLISION')

  • COLLISION Collision – Create collision object.

  • GUIDE Guide – Create guide object.

Type:

Literal[‘COLLISION’, ‘GUIDE’]

guide_mode

How to create guiding velocities (default 'OVERRIDE')

  • MAXIMUM Maximize – Compare velocities from previous frame with new velocities from current frame and keep the maximum.

  • MINIMUM Minimize – Compare velocities from previous frame with new velocities from current frame and keep the minimum.

  • OVERRIDE Override – Always write new guide velocities for every frame (each frame only contains current velocities from guiding objects).

  • AVERAGED Averaged – Take average of velocities from previous frame and new velocities from current frame.

Type:

Literal[‘MAXIMUM’, ‘MINIMUM’, ‘OVERRIDE’, ‘AVERAGED’]

subframes

Number of additional samples to take between frames to improve quality of fast moving effector objects (in [0, 200], default 0)

Type:

int

surface_distance

Additional distance around mesh surface to consider as effector (in [0, 10], default 0.0)

Type:

float

use_effector

Control when to apply the effector (default True)

Type:

bool

use_plane_init

Treat this object as a planar, unclosed mesh (default False)

Type:

bool

velocity_factor

Multiplier of obstacle velocity (in [-100, 100], default 1.0)

Type:

float

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References