[Bf-docboard-svn] bf-manual: [9639] trunk/blender_docs/manual: Hair Curves: Update documentation
Aaron Carlisle
noreply at blender.org
Tue Oct 18 03:54:17 CEST 2022
Revision: 9639
https://developer.blender.org/rBM9639
Author: Blendify
Date: 2022-10-18 03:54:16 +0200 (Tue, 18 Oct 2022)
Log Message:
-----------
Hair Curves: Update documentation
- Add note to hair edit mode that hair editing is depricated
- Add centralized docs for properties
- Remove an old WIP hair object page
Modified Paths:
--------------
trunk/blender_docs/manual/modeling/curves/primitives.rst
trunk/blender_docs/manual/physics/particles/mode.rst
trunk/blender_docs/manual/sculpt_paint/curves_sculpting/introduction.rst
Removed Paths:
-------------
trunk/blender_docs/manual/modeling/hair.rst
Modified: trunk/blender_docs/manual/modeling/curves/primitives.rst
===================================================================
--- trunk/blender_docs/manual/modeling/curves/primitives.rst 2022-10-18 01:15:37 UTC (rev 9638)
+++ trunk/blender_docs/manual/modeling/curves/primitives.rst 2022-10-18 01:54:16 UTC (rev 9639)
@@ -53,6 +53,8 @@
with *Endpoint* knots and the *Curve Path* setting enabled.
+.. _bpy.ops.object.curves_empty_hair_add:
+
Empty Hair
==========
@@ -70,3 +72,47 @@
* No Edit Mode.
* Not supported in Wireframe viewport shading.
+
+
+Properties
+----------
+
+Hair Curves have different properties than regular Curve objects;
+these properties are documented below.
+
+
+Attributes
+^^^^^^^^^^
+
+The *Attributes* panel contains different hair characteristics such as the position and color of hair strands.
+
+Use the :ref:`List View <ui-list-view>` to manage attributes.
+
+.. seealso::
+
+ See the :doc:`Attribute Reference </modeling/geometry_nodes/attributes_reference>` for details on attributes.
+
+
+Surface
+^^^^^^^
+
+.. _bpy.types.Curves.surface:
+
+Surface
+ The curve surface is an optional mesh that is used to anchor the curves, and behave as a scalp for hair grooming.
+ When adding a new Curves object via the `Add Menu` the active object is automatically set as the surface.
+
+ To set a new surface press :kbd:`Ctrl-P` and select *Object (Attach Curves to Surface)*
+ in the *Set Parent To* pop-up menu. This option can be seen as part of the Curves settings in the Properties Editor.
+
+ .. figure:: /images/sculpt-paint_sculpting_curves-surface.png
+
+.. _bpy.types.Curves.surface_uv_map:
+
+Surface UV Map
+ The name of the attribute on the surface mesh used to define the attachment of each curve.
+
+ .. note::
+
+ If the UV from the surface changed,
+ run :ref:`Snap to Nearest Surfaces <bpy.ops.curves.snap_curves_to_surface>` to re-attach the curves.
Deleted: trunk/blender_docs/manual/modeling/hair.rst
===================================================================
--- trunk/blender_docs/manual/modeling/hair.rst 2022-10-18 01:15:37 UTC (rev 9638)
+++ trunk/blender_docs/manual/modeling/hair.rst 2022-10-18 01:54:16 UTC (rev 9639)
@@ -1,69 +0,0 @@
-:orphan:
-
-****
-Hair
-****
-
-Hair type particle system can be used for strand-like objects,
-such as hair, fur, grass, quills, etc.
-
-.. figure:: /images/physics_particles_hair_introduction_example.jpg
-
- Particle hair systems example. Used for the grass and fur.
-
-
-Properties
-==========
-
-Attributes
-----------
-
-The *Attributes* panel contains different hair characteristics such as the position and color of hair strands.
-
-Use the :ref:`List View <ui-list-view>` to manage attributes.
-
-
-Attribute Types
-^^^^^^^^^^^^^^^
-
-Position
- The position of the point in 3D space.
-
- :Type: Vector
-
-Radius
- The radius of each point.
-
- :Type: Float
-
-Color
- The color of each point.
-
- :Type: Color
-
-Custom Attributes
- Custom attribute can be given to particles to hold a custom characteristic.
-
- Name
- The name of the attribute.
- Data Type
- The type of data to store in the attribute.
-
- :Float: Floating-point value
- :Integer: 32-bit integer
- :Vector: 3D vector with floating-point values
- :Color: RGBA color with floating-point precision
- :Byte Color: RGBA color with 8-bit precision
- :String: Text string
-
- Domain
- The type of element the attribute is stored in.
-
- :Point: The attribute is stored per hair point.
- :Curve: The attribute is stored per hair curve.
-
-
-Custom Properties
------------------
-
-See the :ref:`Custom Properties <files-data_blocks-custom-properties>` page for more information.
Modified: trunk/blender_docs/manual/physics/particles/mode.rst
===================================================================
--- trunk/blender_docs/manual/physics/particles/mode.rst 2022-10-18 01:15:37 UTC (rev 9638)
+++ trunk/blender_docs/manual/physics/particles/mode.rst 2022-10-18 01:54:16 UTC (rev 9639)
@@ -17,6 +17,13 @@
a particle system and then give a reference of the various functions.
+.. important::
+
+ Particle Edit Mode, specifically for hair is deprecated;
+ please use the new :ref:`bpy.ops.object.curves_empty_hair_add`
+ object with its associated :doc:`Sculpt Mode </sculpt_paint/curves_sculpting/introduction>` instead.
+
+
Usage
=====
Modified: trunk/blender_docs/manual/sculpt_paint/curves_sculpting/introduction.rst
===================================================================
--- trunk/blender_docs/manual/sculpt_paint/curves_sculpting/introduction.rst 2022-10-18 01:15:37 UTC (rev 9638)
+++ trunk/blender_docs/manual/sculpt_paint/curves_sculpting/introduction.rst 2022-10-18 01:54:16 UTC (rev 9639)
@@ -15,30 +15,6 @@
Curves Sculpt tools only use the original mesh of the surface object and don't take its modifiers into account.
-.. _bpy.types.Curves.surface:
-
-Surface
-=======
-
-The curve surface is an optional mesh that is used to anchor the curves, and behave as a scalp for hair grooming.
-When adding a new Curves object via the `Add Menu` the active object is automatically set as the surface.
-
-To set a new surface press :kbd:`Ctrl-P` and select *Object (Attach Curves to Surface)*
-in the *Set Parent To* pop-up menu. This option can be seen as part of the Curves settings in the Properties Editor.
-
-.. figure:: /images/sculpt-paint_sculpting_curves-surface.png
-
-.. _bpy.types.Curves.surface_uv_map:
-
-Surface UV Map
- The name of the attribute on the surface mesh used to define the attachment of each curve.
-
- .. note::
-
- If the UV from the surface changed,
- run :ref:`Snap to Nearest Surfaces <bpy.ops.curves.snap_curves_to_surface>` to re-attach the curves.
-
-
Curves Menu
===========
More information about the Bf-docboard-svn
mailing list