[Bf-docboard-svn] bf-manual: [8387] trunk/blender_docs/manual/render/freestyle: Freestyle: Add RNA reference links
Aaron Carlisle
noreply at blender.org
Wed Sep 15 19:13:21 CEST 2021
Revision: 8387
https://developer.blender.org/rBM8387
Author: Blendify
Date: 2021-09-15 19:13:21 +0200 (Wed, 15 Sep 2021)
Log Message:
-----------
Freestyle: Add RNA reference links
Modified Paths:
--------------
trunk/blender_docs/manual/render/freestyle/material.rst
trunk/blender_docs/manual/render/freestyle/render.rst
trunk/blender_docs/manual/render/freestyle/view_layer/freestyle.rst
trunk/blender_docs/manual/render/freestyle/view_layer/line_set.rst
trunk/blender_docs/manual/render/freestyle/view_layer/line_style/alpha.rst
trunk/blender_docs/manual/render/freestyle/view_layer/line_style/color.rst
trunk/blender_docs/manual/render/freestyle/view_layer/line_style/geometry.rst
trunk/blender_docs/manual/render/freestyle/view_layer/line_style/strokes.rst
trunk/blender_docs/manual/render/freestyle/view_layer/line_style/texture.rst
Modified: trunk/blender_docs/manual/render/freestyle/material.rst
===================================================================
--- trunk/blender_docs/manual/render/freestyle/material.rst 2021-09-15 03:15:44 UTC (rev 8386)
+++ trunk/blender_docs/manual/render/freestyle/material.rst 2021-09-15 17:13:21 UTC (rev 8387)
@@ -7,9 +7,13 @@
:Panel: :menuselection:`Properties --> Material --> Freestyle Line`
+.. _bpy.types.Material.line_color:
+
Line Color
Specifies the line colors on a per-material basis.
+.. _bpy.types.Material.line_priority:
+
Priority
Specify the ordering of competing line colors at material boundaries.
Modified: trunk/blender_docs/manual/render/freestyle/render.rst
===================================================================
--- trunk/blender_docs/manual/render/freestyle/render.rst 2021-09-15 03:15:44 UTC (rev 8386)
+++ trunk/blender_docs/manual/render/freestyle/render.rst 2021-09-15 17:13:21 UTC (rev 8387)
@@ -15,6 +15,8 @@
Freestyle Render Properties.
+.. _bpy.types.RenderSettings.line_thickness_mode:
+
Line Thickness Mode
There are two different modes for defining the base line thickness:
@@ -25,5 +27,7 @@
For instance, the "unit line thickness" is 1.0 when the image height set to 480px, 1.5 with 720px
and 2.0 with 960px.
+.. _bpy.types.RenderSettings.line_thickness:
+
Line Thickness
Line thickness to use for rendering (only for *Absolute* line thickness).
Modified: trunk/blender_docs/manual/render/freestyle/view_layer/freestyle.rst
===================================================================
--- trunk/blender_docs/manual/render/freestyle/view_layer/freestyle.rst 2021-09-15 03:15:44 UTC (rev 8386)
+++ trunk/blender_docs/manual/render/freestyle/view_layer/freestyle.rst 2021-09-15 17:13:21 UTC (rev 8387)
@@ -18,6 +18,8 @@
View Layer: Freestyle panel.
+.. _bpy.types.FreestyleSettings.mode:
+
Control Mode
Which detected edges are actually rendered, and how, can be controlled either through:
@@ -30,6 +32,8 @@
:Python Scripting Mode:
Lines are rendered via :doc:`Python scripting </render/freestyle/python>`, powerful but complex.
+.. _bpy.types.FreestyleSettings.use_view_map_cache:
+
View Map Cache
An option to reuse a previously computed view map for subsequent rendering.
The cache is automatically updated when the mesh geometry of the input 3D scene has been changed.
@@ -45,6 +49,8 @@
then the cached view map for one view layer is replaced by a new view map
for another view layer and hence no performance gain is expected.
+.. _bpy.types.FreestyleSettings.as_render_pass:
+
As Render Pass
Freestyle lines will not immediately be visible on top of the render image.
Instead, Freestyle lines are rendered as a :doc:`Render Pass </render/layers/passes>`
@@ -54,18 +60,26 @@
Edge Detection
==============
+.. _bpy.types.FreestyleSettings.crease_angle:
+
Crease Angle
If two adjacent faces form an angle less than the defined *Crease Angle*,
the edge between them will be rendered when using *Crease* edge type selection in a line set.
The value also affects *Silhouette* edge type selection.
+.. _bpy.types.FreestyleSettings.use_culling:
+
Culling
Ignore the edges that are out of view.
(Saves some processing time and memory, but may reduce the quality of the result in some cases.)
+.. _bpy.types.FreestyleSettings.use_smoothness:
+
Face Smoothness
Takes *Smooth Shading* into account for edges calculation.
+.. _bpy.types.FreestyleSettings.sphere_radius:
+
Sphere Radius
Affects the calculation of curvatures for *Ridge*, *Valley*
and *Suggestive Contour* edge type selection in a line set.
@@ -73,6 +87,8 @@
of the surface within the specified radius.
Increasing the value reduces noise and detail.
+.. _bpy.types.FreestyleSettings.kr_derivative_epsilon:
+
Kr Derivative Epsilon
Controls the threshold on the minimum rate of change of curvature used to filter the output
of the *Suggestive Contour* edge type selection. Increasing the value reduces the amount of
Modified: trunk/blender_docs/manual/render/freestyle/view_layer/line_set.rst
===================================================================
--- trunk/blender_docs/manual/render/freestyle/view_layer/line_set.rst 2021-09-15 03:15:44 UTC (rev 8386)
+++ trunk/blender_docs/manual/render/freestyle/view_layer/line_set.rst 2021-09-15 17:13:21 UTC (rev 8387)
@@ -17,6 +17,7 @@
Freestyle Line Set panel.
+.. _bpy.types.FreestyleLineSet.select_by_image_border:
Select By
Image Border
@@ -28,6 +29,8 @@
Visibility
==========
+.. _bpy.types.FreestyleLineSet.visibility:
+
Type
Determine how to use visibility for feature edge selection.
@@ -46,6 +49,9 @@
:QI Range:
QI stands for *Quantitative Invisibility*. Lines occluded by a number of surfaces in the given range are rendered.
+ .. _bpy.types.FreestyleLineSet.qi_start:
+ .. _bpy.types.FreestyleLineSet.qi_end:
+
Start, End
Min/max number of occluding surfaces for a line to be rendered.
@@ -57,6 +63,9 @@
(`blend-file <https://wiki.blender.org/wiki/File:QI-Range.zip>`__)
+.. _bpy.types.FreestyleLineSet.exclude:
+.. _bpy.types.FreestyleLineSet.select_by_edge_types:
+
Edge Types
==========
@@ -74,11 +83,16 @@
(`blend-file <https://wiki.blender.org/wiki/File:EdgeType.zip>`__ by LightBWK).
Type
+
+ .. _bpy.types.FreestyleLineSet.select_silhouette:
+
Silhouette
Draws silhouettes around your closed objects by rendering lines where the surface normal transitions between
pointing toward and away from the camera. It is often good for organic objects (like Suzanne & Sphere),
and bad for sharp edges, like a box. It cannot render open mesh objects like open cylinders and flat planes.
+ .. _bpy.types.FreestyleLineSet.select_crease:
+
Crease
Shows only edges whose adjacent faces form an angle sharper than the defined view map's *Crease Angle*.
@@ -89,16 +103,24 @@
Crease Angle proof of concept for 121° by LightBWK
(`blend-file <https://wiki.blender.org/wiki/File:CreaseAngle.zip>`__).
+ .. _bpy.types.FreestyleLineSet.select_border:
+
Border
Border shows open mesh edges, i.e. edges that belong to only one face. An open cylinder has open edges at
the top and bottom, and a plane is open all around. Suzanne's eye socket is an open edge.
+ .. _bpy.types.FreestyleLineSet.select_edge_mark:
+
Edge Marks
Renders marked edges. See `Edge Marks`_ for details.
+ .. _bpy.types.FreestyleLineSet.select_contour:
+
Contour
Draws lines around each object, separating it from other objects behind it, or the scene background.
+ .. _bpy.types.FreestyleLineSet.select_external_contour:
+
External Contour
Draws lines around all objects, separating them from the scene background, but not each other.
@@ -107,9 +129,13 @@
:width: 60%
Left pair: Contour; Right pair: External Contour.
+
+ .. _bpy.types.FreestyleLineSet.select_material_boundary:
Material Boundary
Draws lines where two materials meet on the same object.
+
+ .. _bpy.types.FreestyleLineSet.select_suggestive_contour:
Suggestive Contour
Draws some lines which would form the *Silhouette* of the mesh if the view point was shifted.
@@ -116,6 +142,8 @@
Depends on your view map settings for *Kr Derivative Epsilon* and *Sphere Radius*
(further information: `File:Manual-2.6-Render-Freestyle-PrincetownLinestyle.pdf
<https://wiki.blender.org/wiki/File:Manual-2.6-Render-Freestyle-PrincetownLinestyle.pdf>`__).
+
+ .. _bpy.types.FreestyleLineSet.select_ridge_valley:
Ridge & Valley
Draws lines marking crests of ridges and valleys, i.e. places where the surface curvature is at
@@ -168,6 +196,8 @@
- Round outer edges (use instead *Contour/External Contour/Silhouette*).
+.. _bpy.types.FreestyleLineSet.select_by_face_marks:
+
Face Marks
==========
@@ -194,9 +224,13 @@
The line selection can be controlled via inclusion and faces options:
+.. _bpy.types.FreestyleLineSet.face_mark_negation:
+
Negation
Whether to include or exclude edges matching defined face mark conditions from the line set.
+.. _bpy.types.FreestyleLineSet.face_mark_condition:
+
Condition
:One Face:
(De)select all edges which have one or both neighbor faces marked.
@@ -222,6 +256,8 @@
Exclusive, Both Faces.
+.. _bpy.types.FreestyleLineSet.select_by_collection:
+
Collection
==========
@@ -228,8 +264,12 @@
Include or exclude objects for line calculation,
based on their belonging to a :doc:`Collection </scene_layout/collections/index>`.
-Linset Collection
+.. _bpy.types.FreestyleLineSet.collection:
+
+Line Set Collection
The name of the object collection to use.
+.. _bpy.types.FreestyleLineSet.collection_negation:
+
Negation
Whether to include or exclude lines from those objects in this line set.
Modified: trunk/blender_docs/manual/render/freestyle/view_layer/line_style/alpha.rst
===================================================================
--- trunk/blender_docs/manual/render/freestyle/view_layer/line_style/alpha.rst 2021-09-15 03:15:44 UTC (rev 8386)
+++ trunk/blender_docs/manual/render/freestyle/view_layer/line_style/alpha.rst 2021-09-15 17:13:21 UTC (rev 8387)
@@ -11,10 +11,14 @@
Line Style: Alpha.
+.. _bpy.types.FreestyleLineStyle.alpha:
+
Base Transparency
The base alpha for this line style.
+.. _bpy.ops.scene.freestyle_alpha_modifier_add:
+
Modifiers
=========
Modified: trunk/blender_docs/manual/render/freestyle/view_layer/line_style/color.rst
===================================================================
--- trunk/blender_docs/manual/render/freestyle/view_layer/line_style/color.rst 2021-09-15 03:15:44 UTC (rev 8386)
+++ trunk/blender_docs/manual/render/freestyle/view_layer/line_style/color.rst 2021-09-15 17:13:21 UTC (rev 8387)
@@ -11,10 +11,14 @@
Line Style: Color.
+.. _bpy.types.FreestyleLineStyle.color:
+
Base Color
The base color for this line style.
+.. _bpy.ops.scene.freestyle_color_modifier_add:
+
Modifiers
=========
Modified: trunk/blender_docs/manual/render/freestyle/view_layer/line_style/geometry.rst
===================================================================
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list