You are viewing the documentation for Deformable v0.4.1, an older version. Read the latest, v0.9.0
Engine
Render surfaces
How your mesh rides on the simulated tetrahedrons, what it keeps, the three clip modes, and the inner faces that show where it breaks.
On this page
The simulation moves tetrahedrons, but you render your mesh. The render surface is that mesh, attached to the tetrahedrons by the Prepare tool. Every frame, it follows them: it bends, dents and breaks with them, and keeps its materials, UV maps and shading.
Where the surface comes from
| Made with | Render surface | Clip Mode |
|---|---|---|
| Create Primitive Object, Create Object from Polygon Mesh | The triangulated mesh, which is also the cage | Tetrahedral Mesh Boundary |
| Create Object with Autocage | Your mesh, exactly as you modelled it | Clip With Inner Faces, or Assign Only with Breakable off |
| Add Surface Mesh to Object | Another mesh you pick, such as the object’s hidden original | Clip With Inner Faces, or Assign Only with Breakable off |
| Use Tetrahedral Mesh as Surface Mesh | The object’s cage, or the outer faces of its tetrahedrons | Tetrahedral Mesh Boundary |
| Create Bare Object | None: the tetrahedrons show, in orange | None |
See it in: Blender · Maya · C · Rust · Python
What the surface keeps
- Materials. Each face keeps its material.
- UV maps. Every UV map is kept, with the current one.
- Shading. Each corner keeps the normal your mesh shows, smooth or hard, locked normals included, and the normal turns with the surface as it bends. The outer faces of tetrahedrons, from Use Tetrahedral Mesh as Surface Mesh, are shaded flat.
The surface keeps its shape relative to the tetrahedrons. Parts of your mesh outside the tetrahedrons follow the nearest ones.
See it in: Blender · Maya · C · Rust · Python
Prepare
Prepare holds these settings:
| Setting | Default | What it does |
|---|---|---|
| Clip Mode | Clip With Inner Faces | How the surface is cut. See below. |
| UV Scale | 1 | How many times a texture repeats per unit on the inner faces. |
| Inner Material | None | The material of the inner faces. None uses the object’s first material. |
| Run | Auto | Auto prepares the surface on every change. Wait keeps the last one until Update Now. |
Prepare can take a while on a dense mesh. It runs in the background, and the plugin shows how long it has run, with a way to cancel it.
See it in: Blender · Maya · C · Rust · Python
Clip modes
| Clip Mode | The surface | Use it for |
|---|---|---|
| Assign Only | Stays whole. Each vertex follows the tetrahedron it is in, and the faces stretch across cracks. | Objects whose surface should never open, and the lightest surface: your mesh’s faces stay as they are. |
| Clip With Inner Faces | Is cut where it crosses tetrahedron faces, and gets hidden inner faces that show where the object breaks. | Breakable objects with a detailed surface. |
| Tetrahedral Mesh Boundary | Is the outer faces of the tetrahedrons themselves, cut nowhere. | A surface that is the object’s own cage. The create actions set it. |
Make Breakable and Make Unbreakable switch the selected objects between Clip With Inner Faces and Assign Only. They keep a surface in Tetrahedral Mesh Boundary mode, which is always breakable. See Make Breakable and Make Unbreakable.
Clip With Inner Faces adds faces where it cuts. A UV sphere of 512 faces, in an autocage, becomes a surface of about 2,700 faces. It still renders as smooth as before.
Inner faces
The inner faces of a breakable surface fill the inside of the object. At the start, they are all hidden. When a crack opens, the inner faces along it show, so the object looks solid where it broke.
To give them their own material, make a material for the inside, such as raw stone or wood grain, and make it the Inner Material. The surface gets the inner material as one more material, after the object’s own. Inner faces are flat, with planar UVs at a random angle. UV Scale sets how many times a texture repeats per unit on them: raise it for a finer texture on the cracks.
To check the inner material without breaking the object, turn on Show Inner Faces on the object. Every inner face shows from the start. Turn it off before you render.
See it in: Blender · Maya · C · Rust · Python
Splinters
A splinter cage shapes how the surface breaks, into bricks, tiles or shards, instead of along the tetrahedrons. It needs a surface in Clip With Inner Faces. See Splinters.
See it in: Blender · Maya · C · Rust · Python
The surface and contact
The tetrahedrons collide, not the surface. In an autocage, the cage sits a little outside your mesh, so a resting object can float above the floor. A UV sphere 2 m wide, with the default 100 cage faces, rests about 3 cm above the floor. To bring the cage closer to the mesh, raise Target Face Count on its Autocage: with 300, the same sphere rests about 5 mm above it. More cage faces also make more tetrahedrons, 359 instead of 212 here.
See it in: Blender · Maya · C · Rust · Python
Change the surface
Edit the mesh at the start frame. The plugin prepares the surface again, and the next play uses the new surface.
To keep a frame of the deformed surface as a plain mesh, use Extract Output Shapes.
See it in: Blender (Extract Output Shapes) · Maya (Extract Output Shapes) · C · Rust · Python