[Bf-docboard-svn] bf-manual: [7965] branches/blender-2.93-release/blender_docs/manual: Grease Pencil: Add LineArt modifier
Aaron Carlisle
noreply at blender.org
Thu Apr 22 22:05:17 CEST 2021
Revision: 7965
https://developer.blender.org/rBM7965
Author: Blendify
Date: 2021-04-22 22:05:17 +0200 (Thu, 22 Apr 2021)
Log Message:
-----------
Grease Pencil: Add LineArt modifier
Author: @NicksBest
Differential Revision: https://developer.blender.org/D10742
Committed with edits
Modified Paths:
--------------
branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/index.rst
branches/blender-2.93-release/blender_docs/manual/grease_pencil/primitives.rst
branches/blender-2.93-release/blender_docs/manual/render/materials/index.rst
branches/blender-2.93-release/blender_docs/manual/scene_layout/collections/index.rst
branches/blender-2.93-release/blender_docs/manual/scene_layout/object/properties/index.rst
Added Paths:
-----------
branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/lineart.rst
branches/blender-2.93-release/blender_docs/manual/render/materials/lineart.rst
branches/blender-2.93-release/blender_docs/manual/scene_layout/collections/properties.rst
branches/blender-2.93-release/blender_docs/manual/scene_layout/object/properties/lineart.rst
Modified: branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/index.rst
===================================================================
--- branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/index.rst 2021-04-21 21:03:47 UTC (rev 7964)
+++ branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/index.rst 2021-04-22 20:05:17 UTC (rev 7965)
@@ -8,6 +8,7 @@
array.rst
build.rst
+ lineart.rst
mirror.rst
multiple_strokes.rst
simplify.rst
Added: branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/lineart.rst
===================================================================
--- branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/lineart.rst (rev 0)
+++ branches/blender-2.93-release/blender_docs/manual/grease_pencil/modifiers/generate/lineart.rst 2021-04-22 20:05:17 UTC (rev 7965)
@@ -0,0 +1,203 @@
+.. index:: Grease Pencil Modifiers; Line Art Modifier
+.. _bpy.types.LineartGpencilModifier:
+
+******************
+Line Art Modifier
+******************
+
+The *Line Art* modifier generates stylized line art from the scene or selected source collection/objects.
+
+.. note::
+
+ Due to lack of global cache at the moment, each line art modifier will run the entire
+ occlusion calculation for itself, so if you have multiple line art modifiers to select
+ different parts of the scene (to apply different styles etc.), the evaluation will take
+ much longer. There are plans to remedy this in the future, but this is a known limitation for now.
+
+
+Options
+=======
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_panel.png
+ :align: right
+
+ The Line Art modifier.
+
+Source Type
+ What type of geometry source should line art be generated from. Can be `Scene`, `Collection`, and `Object`.
+
+Source Selector
+ Based on the source type, `Collection` or `Object` can be selected as source geometry.
+
+.. note::
+
+ Line Art will still load and calculate the entire visible scene to produce correct occlusion result,
+ unless specified to do otherwise in Object/Collection Line Art `Usage` property.
+
+Edge Types
+ Line Art can identify different edge types. Selected edge types will be included in the result.
+
+ Contour
+ Where the edge becomes the separation line of front/back facing faces.
+
+ Material Borders
+ Where the edge separates faces with different materials.
+
+ Edge Marks
+ Freestyle edge marks.
+
+ Intersections
+ Intersection lines between faces.
+
+ Crease
+ Where the edge angle is small enough. Controlled by Crease Threshold property.
+
+Crease Threshold
+ Edge angles that are smaller than this value will be treated as crease.
+
+Target Layer
+ The Grease Pencil :ref:`bpy.types.GPencilLayer` to put the result in.
+
+Target Material
+ The Grease Pencil :ref:`bpy.types.MaterialGPencilStyle` to generate strokes with.
+
+Remove Doubles
+ Perform an automatic "merge by distance" operation when loading geometries into Line Art.
+ The threshold of this operation is internally set to a value that is optimal for Line Art algorithm precision.
+
+Overlapping Edges As Contour
+ This option allows overlapping edges (e.g. from an edge split modifier or imported geometry where
+ two edges occupy the exact same space) to be drawn as contour. Enabling this option will slow down
+ the calculation slightly but it will handle edge overlapping cases without erroneous occlusion results.
+
+Instanced Objects
+ This option enables particles and other instanced objects to be loaded for line art calculation.
+ There will be performance impact when there are a large amount of instanced objects in the scene.
+
+Clipping Boundaries
+ When enabled, line art will generate clipping lines as contour type at the place where near/far
+ clipping planes cut the model. Otherwise there will be no lines.
+
+
+Style
+-----
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_style_panel.png
+ :align: right
+
+ Style sub panel.
+
+Thickness
+ The strokes generated by line art are given this thickness.
+
+Opacity
+ The strokes generated by line art are given this Opacity.
+
+
+Occlusion
+---------
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_occlusion_panel.png
+ :align: right
+
+ Occlusion sub panel.
+
+Range
+ If enabled, the modifier will select lines that have an occlusion level between start and end values.
+
+Level
+ Desired occlusion level to be selected as line art result. A value of 0 means visible lines (no occlusion).
+ A value of 1 means selecting lines that have been occluded by exactly 1 layer of faces.
+
+Transparency
+ If enabled, Line Art will only select lines that are occluded by certain faces whose material
+ have specific occlusion masks set.
+
+Masks
+ To select edges that have been occluded by selected masks.
+
+Match All Masks
+ If enabled, only lines that are occluded with the exact transparency bit combination will be selected.
+ Otherwise, lines that have been occluded by any one of specified transparecy masks will be selected.
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_transparency_mask.png
+ :align: right
+
+ Demonstration of the usage of transparency masks.
+
+
+Chaining
+--------
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_chaining_panel.png
+ :align: right
+
+ Chaining sub panel.
+
+Chain Intersection With Contour
+ Allows intersection lines to be chained together with contour lines.
+
+.. note::
+ Enabling this option will lead to ambiguity in intersection edge types.
+ Intersection lines that have not been able to chain with any near-by contour lines will remain
+ as intersection lines.
+
+
+Chain All Lines
+ Enabling this option will cause all lines to have the type of contour and to be chained together.
+
+Threshold
+ Allow the end point of short segments to be chained together if the 2D image space distance
+ between them are within the specified threshold.
+
+Angle Splitting
+ Split a chain at sharp "turning" points specified by this angle.
+
+
+Vertex Weight Transfer
+----------------------
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_vertex_weight_panel.png
+ :align: right
+
+ Vertex Weight Transfer sub panel.
+
+Filter Source
+ If source mesh has vertex groups whose name starts with this string, then the vertex weight info
+ will be transferred into weight groups in grease pencil strokes.
+
+Match Output
+ Transfer the filtered object vertex weights into grease pencil weight groups with the same names
+ as the filtered ones.
+
+Target
+ If `Match Output` is off, then a `Target` vertex group has to be specified.
+ If there are multiple weight groups copied into `Target`, then the highest weight value is copied into it.
+
+
+Baking
+------
+
+.. figure:: /images/grease-pencil_modifiers_generate_lineart_baking_panel.png
+ :align: right
+
+ Baking sub panel.
+
+Bake Line Art
+ Bakes Line Art strokes for active grease pencil object within the *start*, *end* frame range in scene.
+ `Bake Line Art(All)` bakes all grease pencil objects that contains at least one line art modifier.
+ After baking, baked line art modifier will be deactivated automatically.
+
+Clear Baked Line Art
+ Clears baked line art frames within the scene frame range for active grease pencil object.
+ `Clear Baked Line Art(All)`, applies the same operation for all grease pencil objects that
+ contains at least one line art modifier.
+
+.. warning::
+
+ If you have drawn anything manually in the frame range of where line art runs, this operation
+ will also clear those strokes!
+
+Continue Without Clearing
+ Re-activate a specific line art modifier without clearing baked strokes. This is useful for working
+ on multiple portions of frames separately.
Modified: branches/blender-2.93-release/blender_docs/manual/grease_pencil/primitives.rst
===================================================================
--- branches/blender-2.93-release/blender_docs/manual/grease_pencil/primitives.rst 2021-04-21 21:03:47 UTC (rev 7964)
+++ branches/blender-2.93-release/blender_docs/manual/grease_pencil/primitives.rst 2021-04-22 20:05:17 UTC (rev 7965)
@@ -40,3 +40,24 @@
Adding Stroke or Monkey primitives also adds a set of preset materials and 2D layers
to help start drawing with the new object.
+
+
+Scene Line Art
+==============
+
+Sets up a :doc:`/grease_pencil/modifiers/generate/lineart` for the active scen
+by creating an "empty" Grease Pencil object with a Line Art modifier referencing each object in the scene.
+
+
+Collection Line Art
+===================
+
+Sets up a :doc:`/grease_pencil/modifiers/generate/lineart` for the active collection
+by creating an "empty" Grease Pencil object with a Line Art modifier referencing each object in the collection.
+
+
+Object Line Art
+===============
+
+Sets up a :doc:`/grease_pencil/modifiers/generate/lineart` for the active object
+by creating an "empty" Grease Pencil object with a Line Art modifier referencing the active object.
Modified: branches/blender-2.93-release/blender_docs/manual/render/materials/index.rst
===================================================================
--- branches/blender-2.93-release/blender_docs/manual/render/materials/index.rst 2021-04-21 21:03:47 UTC (rev 7964)
+++ branches/blender-2.93-release/blender_docs/manual/render/materials/index.rst 2021-04-22 20:05:17 UTC (rev 7965)
@@ -12,4 +12,5 @@
assignment.rst
preview.rst
settings.rst
+ lineart.rst
legacy_textures/index.rst
Added: branches/blender-2.93-release/blender_docs/manual/render/materials/lineart.rst
===================================================================
--- branches/blender-2.93-release/blender_docs/manual/render/materials/lineart.rst (rev 0)
+++ branches/blender-2.93-release/blender_docs/manual/render/materials/lineart.rst 2021-04-22 20:05:17 UTC (rev 7965)
@@ -0,0 +1,23 @@
+
+********
+Line Art
+********
+
+.. admonition:: Reference
+ :class: refbox
+
+ :Panel: :menuselection:`Material --> Line Art`
+
+.. figure:: /images/render_materials_lineart.png
+ :align: right
+
+ Line art transparency settings in material.
+
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list