..    TODO/Review: {{Review|im= Requires image to show function.}}.

.. _bpy.types.WarpModifier:

*************
Warp Modifier
*************

This deformation modifier can be used to warp parts of a mesh to a new location in a very
flexible way by using two objects to select the "from" and "to" regions,
with options for using a curve falloff, texture and vertex group.

.. figure:: /images/modeling_modifiers_deform_warp_example.png

   Warp Modifier applied to a grid.

The Warp Modifier is a bit tricky at first, but it helps to understand how it works.
The modifier requires two points, specified by object origins.
The "from" point designates a point in space that is pulled toward the "to" point.
It is akin to using
the :doc:`Proportional Editing </editors/3dview/object/editing/transform/control/proportional_edit>`
in Edit Mode.


Options
=======

.. figure:: /images/modeling_modifiers_deform_warp_panel.png

   Warp Modifier.

From
   Specify the origin object transformation of the warp.
To
   Specify the destination object transformation of the warp.
Preserve Volume
   Enables volume preservation when rotating one of the transforms.
Vertex Group
   Limit the deformation to a specific vertex group.

Strength
   Sets how strong the effect is.
Radius
   Sets the distance from the transforms that can be warped by the transform handles.
Falloff Type
   Sets the way the strength of the warp change as it goes from the center of the transform to the Radius value.
   See :doc:`Proportional Editing </editors/3dview/object/editing/transform/control/proportional_edit>`
   for descriptions of the falloff types.
Texture
   Specify a texture the strength is offset by to create variations in the displacement.
Texture Coordinates
   Set the way textures are applied to the mesh when using a textured warp.

   Object
      Specify an object to use when set to Object.
   UV Map
      Specify a UV map when set to UV.


Usage
=====

The *Warp Modifier* can be awkward to use sometimes and the use case is rather small however,
there are a couple of uses. For example, The *Warp Modifier* can be used to have an interactive
:doc:`Proportional Editing </editors/3dview/object/editing/transform/control/proportional_edit>`
that can be used for animation.

Another way to use the *Warp Modifier* is to use it similar to
the :doc:`Deform Modifier </modeling/modifiers/deform/mesh_deform>`.
This allows you to deform parts of the mesh without having to make a vertex group.


Examples
========

.. figure:: /images/modeling_modifiers_deform_warp_example-curve-falloff.png

   Warp Modifier with custom falloff curve.