keenanwoodall / deform-prototype

A prototyped framework for deforming meshes in the editor and at runtime in Unity. Not in development anymore, but it's still pretty awesome!

Heads Up!

I've written a new version from scratch! It's objectively better and you should totally check it out! Here's a little teaser.

Deform

Deform is a framework for deforming meshes in the editor and at runtime that comes with a component based deformation system build on top. If you don't want to make your own deformers, it comes with many standard ones you'd find in 3D modeling packages.

IMPORTANT

1. If you are using this in a pre-existing project, you need to go to Edit/Project Settings/Player/ and set the Scripting Runtime Version (under the Other Settings dropdown) to 4.6.
2. Right now this project is not suitable for professional development. Don't use it on large projects unless you are happy with the feature-set at the time of downloading/cloning it. If you aren't using version control DO NOT update to new versions of this system without backing up your project. Stuff you've made will break 99% of the time because I'm doing large/sweeping changes almost every time I push.

How it works

1. Find a game object (with a mesh filter or skinned mesh renderer) in your scene.
2. Add any deformer component.
3. That's it. Your mesh is deformed.

Tutorials

• Introduction
• Playlist

Features

• Runs in edit and play mode
• Multithreaded (optional)
• Meshes can be saved
• Deformers can be stacked and reordered
• Works with skinned meshes (kinda)
• Easily Extendable

Built-in Deformers

• Bend
• Color Mask
• Curve
• Cylindrify
• Noise (Value, Perlin, Simplex, Cellular, Cubic)
• Pivot To Bounds
• Pivot To Center
• Ripple
• Scale Along Axis
• Scale Along Normal
• Sine
• Skew
• Spherify
• Squash and Stretch
• Taper
• Texture Mask
• Transform
• Twist
• Wave

Releases

• v0.1

FAQ

I don't want all the fluff. What can I safely remove?

• You can delete everything except for the Code and Plugins folder.

How do I make my own deformer?

1. Make a script that uses the Deform namespace
2. Inherit from the 'DeformerComponent' class.
3. Override the 'Modify' method.
4. Make changes to the mesh data and return it.
5. Drag your script onto any object with a MeshFilter or SkinnedMeshRenderer.
6. Mission complete.

What is the MeshData struct?

• It holds the positions and normals (as well as some other stuff) of a mesh.

Why am I getting the error, xxx can only be called from the main thread?

• Unity locks access to most things from other threads. You are probably accessing something like a Transform component from inside the Modify method, which runs on another thread when UpdateMode is set to UpdateAsync. I recommend overriding the virtual method, PreModify, and caching anything you need that is inaccessable from another thread. PreModify is called on the main thread right before any deformations calculations are run.

Why am I getting the error, xxx asynchronous functions cannot be used because it is not part of the C# 4.0 language specification?

• You need to go to Edit/Project Settings/Player/ and set the Scripting Runtime Version (under the Other Settings dropdown) to 4.6.

Help

• Please send any suggestions/feedback to [email protected]
• Pull requests are welcome!

deform-prototype's Issues

Deformation on a skinned mesh renderer doesn't function correctly

The mesh is changed by deformers and then changed by the bones. The opposite needs to happen, but I can't figure out how to force the skinned mesh to deform the mesh before script deformations occur.

Baking a mesh once edited in editor

Can you include a feature to bake the mesh down if it is edited in Editor?

Animating curve of Taper Deformer

Is this possible?

Weird artifacting when deforming very high resolution meshes asynchronously.

Any way to change the vertex count?

I'm still thinking about Deformers as if they were 3DS Max modifiers. I had an idea to create an array deformer but looking at the code it seems like you can't modify the vertex count - or the topology in general.

Before I spend any time on this, I wondered if this is even in scope for the project or if you've given it any thought?

MeshUtil breaks build

The editor specific code in MeshUtil is breaking the build process in 2017.4.0f1. Not sure what the best fix is for this yet. Depends on how that AssetDatabase asset is being used throughout the rest of the code.

how to drag one corner of the cube?

hi,is there an example to drag the corner of the cube?
or how to change a cube to a pyramid by dragging four corners of the top of the cube?
please help

Add bounds to deformers

I'd love to be able to restrict deformers like squash/stretch, bend, twist and taper to user defined bounds, but can't quite figure it out.

Something like this: