Upload 3 files

common_options.rst.txt

@@ -0,0 +1,127 @@
+
+***********************
+Common Modifier Options
+***********************
+
+Some options are commonly used by many modifiers, and share the same behavior across all of those.
+In particular, many offer ways to precisely mask and weight their effect on a vertex basis
+(using either vertex groups and/or textures).
+
+
+.. _modifiers-common-options-masking:
+
+Vertex Group
+============
+
+.. figure:: /images/modeling_modifiers_generic_vertex-group.png
+   :align: right
+
+   Typical modifier Vertex Group options.
+
+:doc:`Vertex Groups </modeling/meshes/properties/vertex_groups/introduction>` are an easy way to control
+which vertices are affected by a modifier, and to which extent (using their weights).
+They are available when modifying meshes or lattices.
+
+.. tip::
+
+   Vertex groups can also be edited and even animated using
+   the :ref:`Vertex Weight modifiers <bpy.types.VertexWeightEditModifier>`.
+
+Vertex Group
+   The vertex group name.
+
+   .. warning::
+
+      The group is referenced by its name. That means that if you rename it, the link to the renamed vertex group
+      will be lost by all modifiers using it (their field will turn red),
+      and you'll have to select the proper group again in all of them.
+
+Invert (double arrow icon)
+   Invert the influence of the vertex group. Only available in some modifiers.
+
+
+Texture
+=======
+
+.. figure:: /images/modeling_modifiers_generic_texture.png
+   :align: right
+
+   Typical modifier Texture options.
+
+Those options allow to use any kind of image (including parametric ones) to control the modifier's effect.
+Most of the time, only the value (grayscale) of the texture is used,
+but in some cases (like with some modes of the :ref:`Displace modifier <bpy.types.DisplaceModifier>`),
+the whole RGB color components might be exploited.
+
+.. tip::
+
+   Textures can be animated (either using videos, or by animating the mapping coordinates...).
+
+Texture
+   The :doc:`texture data-block </render/materials/legacy_textures/introduction>` to use.
+
+   .. tip::
+
+      By clicking on the right-most button of this field (with the settings icon),
+      you can go directly to the selected texture's settings in the *Texture Properties* editor.
+
+Texture Coordinates
+   The texture's coordinates to get each vertex' value:
+
+   UV
+      Take texture coordinates from face UV coordinates.
+
+      UV Map
+         The :term:`UV map` from which to take texture coordinates.
+         If the object has no UV coordinates, it falls back to the *Local* coordinate system.
+         If this field is blank, but there is a UV map available
+         (e.g. just after adding the first UV map to the mesh), the currently active UV map will be used.
+
+      .. note::
+
+         Since UV coordinates are specified per face, the UV texture coordinate system currently determines the UV
+         coordinate for each vertex from the first face encountered which uses that vertex.
+         Any other faces using that vertex are ignored.
+
+         This may lead to artifacts if the mesh has non-contiguous UV coordinates.
+
+   Object
+      Take the texture coordinates from another object's coordinate system.
+
+      Object
+         The object from which to take texture coordinates.
+         Moving the object will therefore alter the coordinates of the texture mapping.
+
+         If this field is blank, it falls back to the *Local* coordinate system.
+
+      .. note::
+
+         Moving the original object will **also** result in a texture coordinate update.
+         As such, if you need to maintain a displacement coordinate system while moving the modified object,
+         consider :ref:`parenting <bpy.ops.object.parent_set>` the coordinate object to the modified object.
+
+   Global
+      Take the texture coordinates from the global coordinate system.
+   Local
+      Take the texture coordinates from the object's local coordinate system.
+
+Use Channel
+   Which channel to use as value source
+   (only available with a few modifiers currently, others follow the *Intensity* behavior,
+   unless otherwise specified).
+
+   Intensity
+      The average of the RGB channels (if RGB(1.0, 0.0, 0.0) value is 0.33).
+   Red/Green/Blue/Alpha
+      One of the color channels' values.
+   Hue
+      The hue from the HSV color space
+      (i.e; the color in the standard wheel, e.g. blue has a higher hue value than yellow).
+   Saturation
+      The saturation from the HSV color space (e.g. the value for pure red is 1.0, for gray is 0.0).
+   Value
+      The value from the HSV color space.
+
+   .. note::
+
+      All of the channels above are gamma corrected, except for *Intensity*.

index.rst.txt

@@ -0,0 +1,89 @@
+.. _modifiers-index:
+.. _bpy.types.Modifier:
+
+#############
+  Modifiers
+#############
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction.rst
+   common_options.rst
+
+
+Modify
+======
+
+.. toctree::
+   :maxdepth: 1
+
+   modify/data_transfer.rst
+   modify/mesh_cache.rst
+   modify/mesh_sequence_cache.rst
+   modify/normal_edit.rst
+   modify/uv_project.rst
+   modify/uv_warp.rst
+   modify/weight_edit.rst
+   modify/weight_mix.rst
+   modify/weight_proximity.rst
+   modify/weighted_normal.rst
+
+
+Generate
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   generate/array.rst
+   generate/bevel.rst
+   generate/booleans.rst
+   generate/build.rst
+   generate/decimate.rst
+   generate/edge_split.rst
+   generate/mask.rst
+   generate/mirror.rst
+   generate/multiresolution.rst
+   generate/remesh.rst
+   generate/screw.rst
+   generate/skin.rst
+   generate/solidify.rst
+   generate/subdivision_surface.rst
+   generate/triangulate.rst
+   generate/wireframe.rst
+
+
+Deform
+======
+
+.. toctree::
+   :maxdepth: 1
+
+   deform/armature.rst
+   deform/cast.rst
+   deform/corrective_smooth.rst
+   deform/curve.rst
+   deform/displace.rst
+   deform/hooks.rst
+   deform/laplacian_smooth.rst
+   deform/laplacian_deform.rst
+   deform/lattice.rst
+   deform/mesh_deform.rst
+   deform/shrinkwrap.rst
+   deform/simple_deform.rst
+   deform/smooth.rst
+   deform/surface_deform.rst
+   deform/warp.rst
+   deform/wave.rst
+
+
+Simulate
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   simulate/explode.rst
+   simulate/ocean.rst
+   simulate/particle_instance.rst

introduction.rst.txt

@@ -0,0 +1,165 @@
+
+************
+Introduction
+************
+
+Modifiers are automatic operations that affect an object's geometry in a non-destructive way.
+With modifiers, you can perform many effects automatically that would otherwise be too tedious to do manually
+(such as subdivision surfaces) and without affecting the base geometry of your object.
+
+They work by changing how an object is displayed and rendered, but not the geometry which you can edit directly.
+You can add several modifiers to a single object to form `The Modifier Stack`_
+and *Apply* a modifier if you wish to make its changes permanent.
+
+.. figure:: /images/modeling_modifiers_introduction_menu.png
+
+   Modifiers menu.
+
+They can be added to the active object using the *Add Modifier* drop-down menu at the top of their properties tab.
+New modifiers are always added at the bottom of the :ref:`stack <modifier-stack>` (i.e. will be applied last).
+
+There are four types of modifiers:
+
+Modify
+   These are tools similar to the *Deform* ones (see below),
+   however, they usually do not directly affect the geometry of the object,
+   but some other data, such as vertex groups.
+Generate
+   These are constructive/destructive tools that will affect the whole :term:`topology` of the mesh.
+   They can change the general appearance of the object, or add new geometry to it...
+Deform
+   Unlike *Generate* ones above, these only change the shape of an object, without altering its topology.
+Simulate
+   Those represent :doc:`physics simulations </physics/index>`. In most cases, they are automatically added to
+   the modifiers stack whenever a *Particle System* or *Physics* simulation is enabled. Their only role is to define
+   the position in the modifier stack from which is taken the base data for the simulation they represent.
+   As such, they typically have no attributes, and are controlled by settings exposed in
+   separate sections of the :doc:`Properties editor </editors/properties_editor>`.
+
+
+.. _bpy.types.Modifier.show:
+
+Interface
+=========
+
+.. _fig-modifiers-panel-layout:
+
+.. figure:: /images/modeling_modifiers_introduction_panel-layout.png
+
+   Panel layout (Subdivision Surface as an example).
+
+Each modifier's interface shares the same basic components, see Fig. :ref:`fig-modifiers-panel-layout`.
+
+At the top is the panel header.
+The icons each represent different settings for the modifier (left to right):
+
+Expand (down/right arrow icon)
+   Collapse modifier to show only the header and not its options.
+Type
+   An icon as a quick visual reference of the modifier's type.
+Name
+   Every modifier has a unique name per object. Two modifiers on one object must have unique names,
+   but two modifiers on different objects can have the same name. The default name is based off the modifier type.
+Render (camera icon)
+   Toggle visibility of the modifier's effect in the render.
+Show in viewport (screen icon)
+   Toggle visibility of the modifier's effect in the 3D View.
+Show in Edit Mode (vertices-square icon)
+   Display the modified geometry in Edit mode, as well as the original geometry which you can edit.
+Show on cage (vertices-triangle icon) -- Meshes only
+   Depends on the previous setting, if enabled, the modified geometry can also be edited directly,
+   instead of the original one.
+
+   .. warning::
+
+      While it shows edited items in their final, modified positions, you are still actually editing original data.
+      This can lead to weird and unpredictable effects with some tools,
+      and should be disabled whenever you need to perform complex or precise editing on the mesh.
+
+Apply On Spline Points (point-surface icon) -- Curves, Surfaces and Texts only
+   Apply the whole modifier stack up to and including that one on the curve or surface control points,
+   instead of their tessellated geometry.
+
+   .. note::
+
+      By default, curves, texts and surfaces are always converted to mesh-like geometry
+      before that the modifier stack is evaluated on them.
+
+Move (up/down arrow icon)
+   Move the modifier up/down in the stack.
+Delete (``X`` icon)
+   Delete the modifier.
+
+.. note::
+
+   The *Square*, *Triangle* and *Surface* icons may not be available, depending on the type of object and modifier.
+
+Below the header are three buttons:
+
+Apply
+   Makes the modifier "real": converts the object's geometry to match the applied modifier's results,
+   and deletes the modifier.
+Apply as Shape Key
+   Stores the result of that modifier in a new relative :doc:`shape key </animation/shape_keys/introduction>`.
+   This is only available with modifiers that do not affect the topology (typically, *Deform* modifiers only).
+
+   .. note::
+
+      Even though it should work with any geometry type that supports shape keys,
+      currently it will only work with meshes.
+
+Copy
+   Creates a duplicate of the modifier just below current one in the stack.
+
+.. warning::
+
+   Applying a modifier that is not first in the stack will ignore the stack order
+   (it will be applied as if it was the first one), and may produce undesired results.
+
+Below this header, all of the options unique to each modifier will be displayed.
+
+
+.. _modifier-stack:
+
+The Modifier Stack
+------------------
+
+Modifiers are a series of non-destructive operations which can be applied on top of an object's geometry.
+They can be applied in just about any order the user chooses.
+
+This kind of functionality is often referred to as a "modifier stack"
+and is also found in several other 3D applications.
+
+In a modifier stack the order in which modifiers are applied has an effect on the result.
+Fortunately modifiers can be rearranged easily by clicking the convenient up and down arrow icons.
+For example, the image below shows :doc:`Subdivision Surface </modeling/modifiers/generate/subdivision_surface>`
+and :doc:`Mirror </modeling/modifiers/generate/mirror>` modifiers that have switched places.
+
+.. list-table:: Modifier Stack example.
+
+   * - .. figure:: /images/modeling_modifiers_introduction_mirror-subdiv2.png
+          :width: 320px
+
+          The Mirror modifier is the last item in the stack and
+          the result looks like two surfaces.
+
+     - .. figure:: /images/modeling_modifiers_introduction_mirror-subdiv1.png
+          :width: 320px
+
+          The Subdivision surface modifier is the last
+          item in the stack and the result is a single merged surface.
+
+Modifiers are calculated from top to bottom in the stack.
+In this example, the desired result (on right) is achieved by first mirroring the object,
+and then calculating the subdivision surface.
+
+
+Example
+^^^^^^^
+
+.. figure:: /images/modeling_modifiers_introduction_stack-example-3.png
+
+   In this example a simple subdivided cube has been transformed into a rather complex object using
+   a stack of modifiers.
+
+`Download example file <https://wiki.blender.org/wiki/File:25-Manual-Modifiers-example.blend>`__.