unreal.CEClonerCollisionExtension

class unreal.CEClonerCollisionExtension(outer: Object | None = None, name: Name | str = 'None')

Bases: CEClonerExtensionBase

Extension dealing with collisions and physics related options

C++ Source:

  • Plugin: ClonerEffector

  • Module: ClonerEffector

  • File: CEClonerCollisionExtension.h

Editor Properties: (see get_editor_property/set_editor_property)

  • collision_grid_resolution (int32): [Read-Write] Resolution of the neighbor grid to detect collision between particles

  • collision_grid_size (Vector): [Read-Write] Size of the neighbor grid to detect collision between particles, particles outside this grid will not have collisions

  • collision_iterations (int32): [Read-Write] Amount of iterations to improve particle collision results but affects performance

  • collision_radii (Array[float]): [Read-Write] Radius expected around each particle for collision, order matches attachment index

  • collision_radius_mode (CEClonerCollisionRadiusMode): [Read-Write] Collision radius calculation mode

  • collision_velocity_enabled (bool): [Read-Write] Recalculate accurate velocity after collision is updated

  • mass_max (float): [Read-Write] Maximum particle mass, used for collisions to push apart

  • mass_min (float): [Read-Write] Minimum particle mass, used for collisions to push apart

  • particle_collision_enabled (bool): [Read-Write] Allow particles to react to other emitter particles, uses a neighbor grid to detect collision

  • preview_collision_grid (bool): [Read-Write] Preview 3D neighbor grid used for collision

  • surface_collision_enabled (bool): [Read-Write] Allow particles to react to surface by using the distance field, ensure the mesh you want particle to collide with is tick enough or increase its distance field resolution scale in static mesh editor

get_collision_grid_resolution() → int32

Get Collision Grid Resolution

Return type:

int32

get_collision_grid_size() → Vector

Get Collision Grid Size

Return type:

Vector

get_collision_iterations() → int32

Get Collision Iterations

Return type:

int32

get_collision_radii() → Array[float]

Get Collision Radii

Return type:

Array[float]

get_collision_radius_mode() → CEClonerCollisionRadiusMode

Get Collision Radius Mode

Return type:

CEClonerCollisionRadiusMode

get_collision_velocity_enabled() → bool

Get Collision Velocity Enabled

Return type:

bool

get_mass_max() → float

Get Mass Max

Return type:

float

get_mass_min() → float

Get Mass Min

Return type:

float

get_particle_collision_enabled() → bool

Get Particle Collision Enabled

Return type:

bool

get_surface_collision_enabled() → bool

Get Surface Collision Enabled

Return type:

bool

set_collision_grid_resolution(collision_grid_resolution) → None

Set Collision Grid Resolution

Parameters:

collision_grid_resolution (int32)

set_collision_grid_size(collision_grid_size) → None

Set Collision Grid Size

Parameters:

collision_grid_size (Vector)

set_collision_iterations(collision_iterations) → None

Set Collision Iterations

Parameters:

collision_iterations (int32)

set_collision_radius_mode(mode) → None

Set Collision Radius Mode

Parameters:

mode (CEClonerCollisionRadiusMode)

set_collision_velocity_enabled(collision_velocity_enabled) → None

Set Collision Velocity Enabled

Parameters:

collision_velocity_enabled (bool)

set_mass_max(mass_max) → None

Set Mass Max

Parameters:

mass_max (float)

set_mass_min(mass_min) → None

Set Mass Min

Parameters:

mass_min (float)

set_particle_collision_enabled(particle_collision_enabled) → None

Set Particle Collision Enabled

Parameters:

particle_collision_enabled (bool)

set_surface_collision_enabled(surface_collision_enabled) → None

Set Surface Collision Enabled

Parameters:

surface_collision_enabled (bool)