You are viewing the documentation for Deformable v0.2.1, an older version. Read the latest, v0.9.0

Engine

Kinematic objects and regions

Animate objects, hold or release parts of them, push them with forces, and give parts their own material or glue with regions.

On this page

A deformable object is Dynamic by default: the simulation moves it. This page shows every way to take control back: Kinematic objects that follow your animation, passive regions that hold part of an object, vertices you drive or push, and the regions that give part of an object its own material or glue objects together.

Ways to control an object

You want to Use
Move a whole object by hand, such as a floor, a wall or a hammer Kinematic objects
Hold an object, then drop it at a given frame Release an object
Hold one part of an object, such as the top of a rope or the edge of a flag Passive regions
Pick the held vertices one by one, or push vertices Driven vertices and forces
Push objects with the host’s force fields, such as wind or a vortex Force fields
Give part of an object another material, such as a steel core Material regions
Glue some objects together and leave the others loose Glue regions
Leave an object out, or hold every object still Disabled on the object, Disable on the scene. See Simulation settings.

Regions, cages and bare objects draw in a see-through color, one per kind, with their wire over it:

Object Color Renders
Passive region Green No
Glue region Yellow No
Material region Purple No
Density region Red No
Autocage mesh Magenta Yes
Splinters Cyan No
Bare object Orange Yes, until you add a surface or pick a material

See it in: Blender · Maya · C · Rust · Python

Kinematic objects

A Kinematic object does not fall and does not bend. It stays where it is, or follows its animation, and it pushes the Dynamic objects it touches. They never push it back.

Make Kinematic sets the Type of the selected objects to Kinematic, and Make Dynamic sets it back. A Kinematic object follows its object animation: keys on its position, rotation and scale, and its parent. To animate one, key it at the start frame and at a later frame, then return to the start frame and play.

Floors and walls are Kinematic objects too. A thin floor is cheap: see Extrude.

See it in: Blender · Maya · C · Rust · Python

Release an object

Type is one of the settings you can keyframe. Keyframe it to hold an object, then let it go:

  1. Go to the start frame. Set Type to Kinematic and key it.
  2. Go to the frame of the release, for example frame 20. Set Type to Dynamic and key it again.
  3. Return to the start frame and play.

The object hangs still until the release, then falls from where it was.

Start frame Held Released Falling Kinematic Dynamic

The frame it first moves on depends on when the plugin reads the key. See When animated values are read.

Keyframe Disable on the Deformable Scene the same way to hold every object of the simulation still, then let go. See What you can animate.

See it in: Blender · Maya · C · Rust · Python

Passive regions

A passive region is a convex mesh. The vertices of a Dynamic object that are inside it follow the object’s animation instead of the simulation. The rest of the object stays free. Use it to pin the top of a column, the end of a beam, or the corner of a sheet.

Add New Region > Passive adds a cube, 1 unit wide, at the center of the selected objects, drawn in see-through green and hidden in renders. Move and scale it over the part to hold. Return to the start frame and play: the vertices inside it stay put, and the rest of the object hangs from them.

Passive Region

Make Mesh into Region > Passive makes a mesh of your own a passive region instead. The mesh must be convex. A mesh that is not is refused with A region must be convex: <mesh>.

The simulation reads passive regions on every frame, so you can animate them:

  • Move the held part. Animate the object itself. The held vertices follow its animation, and the rest swings after them.
  • Keep the region on the object. When a region does not move with the object, the held vertices leave the region and fall. Parent the region to the object when the object moves.
  • Let go. Move the region away from the object. The vertices it no longer covers fall free.

See it in: Blender · Maya · C · Rust · Python

Driven vertices and forces

For full control, pick the vertices to hold one by one, and push vertices with forces:

  • A driven vertex follows the object’s animation, as inside a passive region.
  • A force on a vertex pushes it on each frame, in newtons in simulation units. The scene’s Scale never changes a force, as it never changes Gravity.

The simulation reads both on every frame, on the object’s tetrahedral mesh, whose vertices are the ones the tetrahedrons share.

See it in: Blender · Maya (Apply Field to Object) · C (forces) · Rust (forces) · Python

Force fields

The plugins push objects with the host’s own force fields, such as wind, a vortex or turbulence, as the host pushes its particles. A field pushes each vertex that nothing holds, from where it is and how it moves. Like a force on a vertex, its push is in newtons in simulation units, and the scene’s Scale never changes it. A held vertex saves nothing up: once released, it takes the field’s push from its first free frame. A field whose force is not a finite number at some vertex of an object it reaches, held vertices and Kinematic objects included, pushes nothing on that frame, and the scene says so once.

See it in: Blender · Maya

Material regions

A material region gives the tetrahedrons of an object that are inside a convex mesh their own material. Use it for a steel core in a concrete pillar, a soft spot in a hard shell, or a weak line where a wall should break.

Add New Region > Material adds a cube, 1 unit wide, at the center of the selected objects, drawn in see-through purple and hidden in renders, with the preset you pick, such as steel. Move and scale it over the part to change. To change its material, edit its values, or give it another preset with Assign Material Preset. Make Mesh into Region > Material makes a convex mesh of your own a material region.

Material regions apply at the start frame. To see a change to a region’s place or shape, return to the start frame and play again. Its material values you can keyframe, as the object’s own.

A tetrahedron takes the region’s material when its center is inside the region. So a region smaller than the object’s tetrahedrons may change nothing: use a density region, with a smaller Maximum Edge Length, to make smaller tetrahedrons there.

Material Region

Where two regions overlap, the region whose mesh is smaller wins. The size is measured before the region’s own scale. Two cubes made with Add New Region have the same mesh size however you scale them, and then either one may win. To overlap regions, scale the mesh itself, or apply its scale. Or do not overlap material regions.

A region that the object reads but that is not a material region is named in a warning: not a material region: <name>.

See it in: Blender · Maya · C · Rust · Python

Glue regions

Glue holds objects together until a hard hit breaks them apart. By default, Glue All on the Deformable Scene glues every pair of objects that overlap at the start frame. A glue region glues only the objects you pick, its members, and only where they overlap inside the region.

Add Glue Region adds a box that covers the selected objects, drawn in see-through yellow and hidden in renders, with the selected objects as its members. Make Mesh into Region > Glue makes a convex mesh of your own a glue region.

Then make sure the objects overlap a little where they should hold, and decide what Glue All does:

  • To glue only the members, turn Glue All off on the Deformable Scene.
  • To keep Glue All for the other objects, leave it on. Glue All and the region both apply.

Objects that only touch, with no overlap, do not glue.

The glue region has two settings:

Setting Default What it does
Spring Constant 0 Stiffness of the glue. 0 uses the built-in strong glue, 4,905.
Damping Coefficient 0 Damping of the glue. 0 uses the built-in strong glue, 2,452.5.

So a new glue region is strong: it holds a block hanging from a Kinematic one, and the block rides along when you animate the Kinematic object. The weak default of Glue All, 0.1 and 0.05, does not hold it. See Glue All.

Glue forms at the start frame only. Glue regions apply at the start frame too: to see a change, return to the start frame and play again.

See it in: Blender · Maya · C · Rust · Python