[Bf-docboard-svn] bf-manual: [7336] trunk/blender_docs/manual/modeling/modifiers: Modifiers: initial documentation for new volume modifiers

[Jacques Lucke]

Revision: 7336
          https://developer.blender.org/rBM7336
Author:   JacquesLucke
Date:     2020-11-04 14:50:01 +0100 (Wed, 04 Nov 2020)
Log Message:
-----------
Modifiers: initial documentation for new volume modifiers

Modified Paths:
--------------
    trunk/blender_docs/manual/modeling/modifiers/index.rst

Added Paths:
-----------
    trunk/blender_docs/manual/modeling/modifiers/deform/volume_displace.rst
    trunk/blender_docs/manual/modeling/modifiers/generate/mesh_to_volume.rst
    trunk/blender_docs/manual/modeling/modifiers/generate/volume_to_mesh.rst

Added: trunk/blender_docs/manual/modeling/modifiers/deform/volume_displace.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/deform/volume_displace.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/modifiers/deform/volume_displace.rst	2020-11-04 13:50:01 UTC (rev 7336)
@@ -0,0 +1,29 @@
+.. index:: Modeling Modifiers; Volume Displace
+
+************************
+Volume Displace Modifier
+************************
+
+The *Volume Displace* modifier displaces existing volume grids based on a 3D texture.
+It uses the red, green and blue components of the texture to displace the volume into the x, y and z direction.
+
+.. note::
+
+   Greyscale textures lead to stretching along one axis.
+   It's best to use a color texture.
+
+Options
+=======
+
+Texture
+   The texture that is evaluated at every voxel to determine how far and in what direction to displace.
+
+Strength
+   Controls how far voxels are displaced.
+
+Sample Radius
+   Smaller values result in better performance, but might cut off the volume outside.
+
+Mid Level
+   This should be modified if the texture offsets the entire volume in one direction and you want to center it again.
+   For performance reasons, the displaced volume should stay close to its original position.


Property changes on: trunk/blender_docs/manual/modeling/modifiers/deform/volume_displace.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/blender_docs/manual/modeling/modifiers/generate/mesh_to_volume.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/generate/mesh_to_volume.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/modifiers/generate/mesh_to_volume.rst	2020-11-04 13:50:01 UTC (rev 7336)
@@ -0,0 +1,44 @@
+.. index:: Modeling Modifiers; Mesh to Volume
+
+***********************
+Mesh to Volume Modifier
+***********************
+
+The *Mesh to Volume* modifier uses a mesh to create a new volume grid.
+All previously existing volume grids on the volume object are discarded.
+Therefore, this modifier is usually added to an empty volume object.
+The new volume grid is called "density".
+
+
+Options
+=======
+
+Object
+   The mesh object that determines where the volume data will be generated.
+
+Density
+   Makes the generated volume appear denser or less dense when rendering.
+
+Fill Volume
+   This setting is only used when the mesh object actually encloses a volume.
+   If it is set, the entire enclosed volume will get a density greater than zero.
+   Otherwise, only the voxels close to the surface are initialized.
+
+Exterior Band Width
+   The maximum distance of the included voxels to the surface on the outside of the mesh.
+
+Interior Band Width
+   The maximum distance of the included voxles to the surface on the inside of the mesh.
+   Activating *Fill Volume* is similar to increasing the interior band width to a high number.
+
+Resolution Mode
+   Mode for how the voxel size is specified.
+
+   Voxel Amount
+      This allows setting an approximate number of voxels that will be used to represent mesh along its diagonal.
+      When the dimensions of the mesh changes, the voxel size will change as well.
+      For final rendering of animations, it's better to specify the voxel size explitely to avoid artifacts.
+
+   Voxel Size
+      This allows setting the exact voxel size that will be used.
+      This is idea for rendering when the voxel size should not change between frames.


Property changes on: trunk/blender_docs/manual/modeling/modifiers/generate/mesh_to_volume.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/blender_docs/manual/modeling/modifiers/generate/volume_to_mesh.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/generate/volume_to_mesh.rst	                        (rev 0)
+++ trunk/blender_docs/manual/modeling/modifiers/generate/volume_to_mesh.rst	2020-11-04 13:50:01 UTC (rev 7336)
@@ -0,0 +1,46 @@
+.. index:: Modeling Modifiers; Volume to Mesh
+
+***********************
+Volume to Mesh Modifier
+***********************
+
+This modifier is the inverse of the *Mesh to Volume* modifier.
+It takes an existing volume object and converts one of its grids to a mesh.
+Only scalar grids (such as the density grid) can be converted.
+
+Options
+=======
+
+Object
+   The source volume object.
+
+Grid Name
+   The name of the grid that will be converted.
+   This has to be a scalar grid.
+
+Resolution Mode
+   Mode for how the resolution of the final mesh is controlled.
+
+   Grid
+      This makes the resolution dependend on the resolution of the grid that is converted.
+      Higher resolution grids result in a higher resolution mesh.
+      In many cases, that is the most efficient mode.
+
+   Voxel Amount
+      Specifies the approximate resolution of the final mesh.
+      The voxel size adapts to the size of the entire volume.
+
+   Voxel Size
+       Use a fixed resolution that does not change when the volume changes.
+
+Threshold
+   Voxels with a larger value are considered to be inside the mesh.
+   All other voxels are outside.
+   The mesh will be generated on the boundary of inside and outside voxels.
+   This is sometimes also called the *iso value*.
+
+Adaptivity
+   This is similar to decimating the final to reduce resolution where it is not needed.
+
+Smooth Shading
+   Enables smooth shading on the generated mesh.


Property changes on: trunk/blender_docs/manual/modeling/modifiers/generate/volume_to_mesh.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/blender_docs/manual/modeling/modifiers/index.rst
===================================================================
--- trunk/blender_docs/manual/modeling/modifiers/index.rst	2020-11-04 09:05:38 UTC (rev 7335)
+++ trunk/blender_docs/manual/modeling/modifiers/index.rst	2020-11-04 13:50:01 UTC (rev 7336)
@@ -43,6 +43,7 @@
    generate/decimate.rst
    generate/edge_split.rst
    generate/mask.rst
+   generate/mesh_to_volume.rst
    generate/mirror.rst
    generate/multiresolution.rst
    generate/remesh.rst
@@ -51,6 +52,7 @@
    generate/solidify.rst
    generate/subdivision_surface.rst
    generate/triangulate.rst
+   generate/volume_to_mesh.rst
    generate/weld.rst
    generate/wireframe.rst
 
@@ -75,6 +77,7 @@
    deform/corrective_smooth.rst
    deform/laplacian_smooth.rst
    deform/surface_deform.rst
+   deform/volume_displace.rst
    deform/warp.rst
    deform/wave.rst