You are viewing the documentation for Deformable v0.5.0, an older version. Read the latest, v0.9.0
Engine
Simulation settings
Every setting of the Deformable Scene and of a deformable object, what a simulation gives you, and which settings you can animate.
On this page
Two places hold the simulation settings. The Deformable Scene holds what applies to the whole simulation. Each deformable object holds what applies to it alone.
Deformable Scene
| Setting | Default | What it does |
|---|---|---|
| Objects | The objects you create | The deformable objects of this Deformable Scene. An object that no Deformable Scene takes does not simulate, and the plugin names it in a message that starts with Add to a Deformable Scene. |
| Gravity | 9.81 down the up axis | Acceleration on every object, in simulation units per second squared. |
| Scale | 1 | Simulation units per scene unit, from 0.001 to 1,000. |
| Substeps | 8 | Solver steps per frame. 0 does not move. |
| Disable | Off | Hold every object where it is. You can animate it. |
| Glue All | On | Glue objects that touch at the start together. |
| Spring Constant | 0.1 | Stiffness of the Glue All glue. |
| Damping Coefficient | 0.05 | Damping of the Glue All glue. |
| Force Fields | Every field in Blender, none in Maya | The host’s force fields that push this scene’s objects: in Blender a collection, where empty takes every field; in Maya the fields Apply Field to Object connects. See Force fields. |
The Deformable Scene draws a short arrow along the gravity direction. It shows in the viewport only, never in renders.
See it in: Blender · Maya · C · Rust · Python
Scale
The simulation reads one simulation unit as one metre. Material values are in simulation units too. If your scene is not modelled in metres, set Scale so the simulation sees real sizes:
| Your scene | Scale |
|---|---|
| 1 scene unit is 1 m | 1 |
| 1 scene unit is 1 cm | 0.01 |
| 1 scene unit is 1 mm | 0.001 |
A wrong scale makes objects behave as if they were too big or too small: a 2 m pillar modelled in centimetres, with Scale 1, topples as slowly as a 200 m tower.
Resting objects keep about 0.02 simulation units (2 cm at Scale 1) of overlap with what they rest on, so a small prop, such as a 5 cm box, rests visibly into the floor. See An object rests a little into the floor.
Substeps
Each frame is split into Substeps solver steps. More substeps follow fast impacts and stiff materials more closely, and cost more time. The default, 8, suits most scenes.
A substep can be at most 0.04 seconds long. At 24 frames per second, a frame lasts about 0.042 seconds, so 1 substep is too few. When a substep is too long, nothing moves and the plugin says A substep would be longer than 0.04 s: raise Substeps.
Glue All
Glue All glues objects whose tetrahedrons overlap at the start frame, so they hold together until a hard hit breaks them apart. Glue never forms later in the simulation.
The default Spring Constant, 0.1, and Damping Coefficient, 0.05, make a weak glue: it does not hold up a hanging object. For a strong glue, set both to 0. A value of 0 uses the built-in strong glue: a spring constant of 4,905 and a damping coefficient of 2,452.5. To glue only some objects, turn Glue All off and use a glue region.
More than one Deformable Scene
Each Deformable Scene simulates on its own. Objects in different Deformable Scenes do not collide. Split the objects of a scene between two Deformable Scenes to simulate them apart, or to keep each scene under the Free license’s limit: under the Free license, each Deformable Scene simulates up to 2,500 tetrahedrons.
Deformable objects
Each deformable object has these settings:
| Setting | Default | What it does |
|---|---|---|
| Type | Dynamic | Dynamic: the simulation moves the object. Kinematic: the object follows its animation and pushes others. You can animate it. |
| Disabled | Off | Leave the object out of the simulation. |
| Self Collision | On | The object’s parts and pieces collide with each other. |
| Never Sleep | Off | Keep the whole object awake, even at rest. |
| Show Inner Faces | Off | Show the inner faces of the render surface before they open. |
| Start Splintered | Off | Show the splinter cells as separate pieces from the start. |
Its regions, the passive regions and material regions it reads, are on Kinematic objects and regions. Show Inner Faces and Start Splintered are on Render surfaces.
Make Dynamic, Make Kinematic, Enable and Disable set Type and Disabled for all selected objects at once, and report how many objects they changed, such as Made 2 objects Kinematic.
See it in: Blender · Maya · C · Rust · Python
Self Collision
With Self Collision on, an object does not pass through itself when it folds, and its broken pieces bounce off each other. Turn it off for an object that never folds or breaks, such as a floor, to save a little time.
Sleep
An object that comes to rest on a support goes to sleep and costs almost nothing. An impact nearby wakes it. Turn on Never Sleep for an object that falls asleep too early, such as one that should keep rocking slowly.
What a simulation gives
Besides the deformed render surface, each deformable object gives:
| Output | What it holds |
|---|---|
| Fracture points | One point on each inner face that opened at this frame, with the face’s outward direction and the index of its tetrahedron. |
| Simulated tetrahedrons | The simulated tetrahedrons, 4 triangles each, with the piece each belongs to (its island), how much it is stretched (its strain measure) and its flags. A crack gives each side its own points, so the point count grows as the object breaks. |
Use the fracture points to place effects where an object cracks, such as dust or sparks. The points exist only on the frame their faces open, so they suit an emitter.
Use the simulated tetrahedrons to show the inside of a simulation, for example to color each piece by its island, or to see where the object is most stretched.
See it in: Blender · Maya · C · Rust · Python
What you can animate
The simulation reads these settings on every frame, so you can keyframe them:
- Type on a deformable object: switch an object from Kinematic to Dynamic to drop or release it.
- Disable on the Deformable Scene: hold everything still, then let go.
- Every value of a Deformable Material, an object’s or a material region’s: for example, raise Young’s Modulus to stiffen an object as it falls, lower Toughness to let it break, or raise Density to make it heavier. A new Density keeps the speed the object has, so a heavier object moves on as fast and pushes harder. When a keyed value leaves its preset, the Preset turns to Custom, and the simulation goes on.
- Every setting of a force field, and where it stands: the simulation reads the fields on every frame (see Force fields).
The simulation also follows the animation of Kinematic objects, of passive regions, and of the vertices you drive. A sleeping part takes the new values once something wakes it. When the plugin reads an animated value is on When animated values are read.
Any other change while the simulation plays stops the simulation, and the plugin says Return to the start frame to apply changes.
See it in: Blender · Maya · C · Rust · Python
Repeatable results
The same file gives exactly the same simulation on every run, on the same computer and version. The number of CPU cores changes only the speed. In the SDKs, the same inputs and calls give bitwise identical results.