This repo contains nsfw code as examples. If you're under 18 please leave.
A gpu-based deformation system for mapping penetrators along orifice paths. Supports DX11, Vulkan, Metal, and modern OpenGL.
For a write-up on this technology, and some more detailed examples-- see here
- Advanced Catmull-rom skinning system.
- Arbitrary soft turns and bends!
- Allows for all-the-way-through deformations.
- GPU powered skinning, its very fast!
- GPU cross-sectional girth and offset analysis.
- Abuses GPU rasterization to analyze the shape of penetrators. Its very fast!
- Analytical push/tug forces, computed from the derivative of the girth map.
- Approximates offsets needed to ensure things line up.
- Simple cginc for easy custom shader creation.
- Also includes Amplify Shader Editor function nodes for easy drag-and-drop support.
- Can be used in Shader Graph as well, though this is not recommended as Shader Graph is currently buggy.
- Penetration event listeners, for both orifices and penetrators.
- Easily create custom listeners to detect particular things.
- Play custom sound effects, trigger animations, apply forces, etc.
- Works entirely within the editor
- Work with and adjust animations while previewing exactly how the penetrators and penetrables will react.
First, install the dependency: https://github.com/mackysoft/Unity-SerializeReferenceExtensions.git?path=Assets/MackySoft/MackySoft.SerializeReferenceExtensions#1.3.0 as a package using the package manager.
Then add https://github.com/naelstrof/UnityPenetrationTech.git#upm as a package using the package manager.
Or if that doesn't work, add it to the manifest.json like so.
{
"dependencies": {
"com.mackysoft.serializereference-extensions": https://github.com/mackysoft/Unity-SerializeReferenceExtensions.git?path=Assets/MackySoft/MackySoft.SerializeReferenceExtensions#1.3.0",
"com.naelstrof.penetrationtech": "https://github.com/naelstrof/PenetrationTech.git#upm",
}
}
This guide is for someone who has a model, and some blender experience. Lets say we have a model we want to penetrate, like a donut!
While this could possibly deform well with procedural deformations, it's more common to manually author the deformations. There's two kind of deformations that PenetrationTech requires: Offset, and girth.
- Girth deformations can be supported with a blendshape! For this donut, we only have to worry about a single cross-section of a deformation, for more complicated set ups you might need a chain of blendshapes.
donutGirthBlendshape.mp4
- Offset deformations must be supported with a bone, this is to correct for off-center or bumpy penetrators. Don't worry about the orientation of the bone, just make sure its somewhat in the center.
donutArmatureOffset.mp4
- Done! That's all the model requirements, export it to Unity as an FBX (or save as a .blend).
Now we can use the model within Unity.
- Add the Penetrable Monobehaviour to an object.
- Add Empty transforms to represent the path the penetrator will follow, these can be parented to deform with the mesh. For this donut, we want to avoid using the Offset Correction bone, or a child of it, to prevent feed-back loops.
- Add listeners, depending on the kind of mesh, in order to have the mesh react. For the donut, we will use a Simple Blendshape Listener, which will trigger the blendshape we set up.
- Correct errors that appear at the top of the inspector, each listener has its own requirements to run properly. In this case, Simple Blendshape Listener needs a target mesh, a blendshape, and an Offset Correction bone to deal with off-center penetrations.
- Now we need to manually trigger our blendshape to set up the girth variable of the Simple Blendshape Listener.
simpleBlendshapeSetup.mp4
- Now you can test the model using another penetrator in the scene by enabling Auto penetrate on the penetrator.
success.mp4
This guide is for someone who has a model that represents a penetrator. Lets say we have a banana!
There's two requirements for penetrators: It must have a transform at the center of its base (either a bone or the origin), and it must be straight. Our banana in this case doesn't meet either requirement, so lets fix that!
- Straighten the penetrator, no curves allowed! This is because girth analysis happens along one axis. Don't worry about how funny it looks, we can re-introduce the curve later within Unity. Ensure that this shape is the "basis shape", as blendshapes aren't supported in the girth analysis (yet).
bananaStraighten.mp4
- Ensure that the bone, or origin, is at the center of the base of the penetrator.
For the banana, we just need to use the
Set Origin to 3D Cursorcommand since the banana isn't on an armature. It's helpful to have the penetrator go along a cardinal axis, though this isn't required. - Done! That's all that needs to be done for a penetrator to support the tech properly.
Now we can use the model within Unity.
- Add a Penetrator Monobehaviour to the gameobject, then start fixing the errors at the top of the inspector.
- Once all the errors are fixed, the renderer is now receiving deformation data. But there's no material to receive it!
Lets quickly create one, just make sure it uses a shader that supports the deformation data, like
PenetrationTech/Penetrator.
- Applying that to our model, we'll see that its broken/invisible!
This is due to our axis being set up incorrectly, and is easy to fix. Simply change the forward axis (the blue dotted line) in the same direction of the penetrator, then flip the Right or Up axis if it ends up inside-out.
bananaInsideOut.mp4
- Now that the banana is correctly rendering, and the girth display (white circles) are displaying correctly we can reintroduce the curve with the Tip Target option like so.
bananaRecurve.mp4
- Finally enable Auto-Penetrate, or specify a penetrable, and it should start working!
success.mp4
Many things were not covered here, if you need help with this technology please contact me! I'd love to help.
