RigidBodyWorld(bpy_struct)

base class — bpy_struct

class bpy.types.RigidBodyWorld(bpy_struct)

Self-contained rigid body simulation environment and settings

collection

Collection containing objects participating in this simulation

Type:

Collection

constraints

Collection containing rigid body constraint objects

Type:

Collection

effector_weights

(readonly)

Type:

EffectorWeights

enabled

Simulation will be evaluated (default True)

Type:

bool

point_cache

(readonly, never None)

Type:

PointCache

solver_iterations

Number of constraint solver iterations made per simulation step (higher values are more accurate but slower) (in [1, 1000], default 10)

Type:

int

substeps_per_frame

Number of simulation steps taken per frame (higher values are more accurate but slower) (in [1, 32767], default 10)

Type:

int

time_scale

Change the speed of the simulation (in [0, 100], default 1.0)

Type:

float

use_split_impulse

Reduce extra velocity that can build up when objects collide (lowers simulation stability a little so use only when necessary) (default False)

Type:

bool

convex_sweep_test(object, start, end)

Sweep test convex rigidbody against the current rigidbody world

Parameters:

  • object (Object) – Rigidbody object with a convex collision shape (never None)

  • start (mathutils.Vector) – (array of 3 items, in [-inf, inf])

  • end (mathutils.Vector) – (array of 3 items, in [-inf, inf])

Returns:

object_location, The hit location of this sweep test, mathutils.Vector

hitpoint, The hit location of this sweep test, mathutils.Vector

normal, The face normal at the sweep test hit location, mathutils.Vector

has_hit, If the function has found collision point, value is 1, otherwise 0, int

Return type:

(mathutils.Vector, mathutils.Vector, mathutils.Vector, int)

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

id (str) – The RNA type identifier.

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.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References