[Bf-docboard-svn] bf-manual: [7330] trunk/blender_docs/manual: Cleanup: RNA links & some format changes
Aaron Carlisle
noreply at blender.org
Wed Nov 4 03:52:51 CET 2020
Revision: 7330
https://developer.blender.org/rBM7330
Author: Blendify
Date: 2020-11-04 03:52:50 +0100 (Wed, 04 Nov 2020)
Log Message:
-----------
Cleanup: RNA links & some format changes
Modified Paths:
--------------
trunk/blender_docs/manual/animation/armatures/posing/introduction.rst
trunk/blender_docs/manual/editors/outliner/interface.rst
trunk/blender_docs/manual/scene_layout/object/editing/apply.rst
trunk/blender_docs/manual/scene_layout/object/editing/clear.rst
trunk/blender_docs/manual/scene_layout/object/editing/transform/randomize.rst
trunk/blender_docs/manual/scene_layout/object/properties/display.rst
trunk/blender_docs/manual/scene_layout/object/properties/relations.rst
trunk/blender_docs/manual/scene_layout/object/properties/transforms.rst
trunk/blender_docs/manual/scene_layout/object/properties/visibility.rst
trunk/blender_docs/manual/scene_layout/object/selecting.rst
Modified: trunk/blender_docs/manual/animation/armatures/posing/introduction.rst
===================================================================
--- trunk/blender_docs/manual/animation/armatures/posing/introduction.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/animation/armatures/posing/introduction.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -15,7 +15,7 @@
(i.e. 0.0 for position and rotation, and 1.0 for scale). Hence, when you edit a bone in *Pose Mode*,
you create an offset in the transform properties, from its rest position.
This may seem quite similar if you have worked with :doc:`relative shape keys </animation/shape_keys/index>`
-or :ref:`Delta Transformations <transform-delta>`.
+or :ref:`Delta Transformations <bpy.types.Object.delta>`.
Even though it might be used for completely static purposes,
posing is heavily connected with animation features and techniques.
Modified: trunk/blender_docs/manual/editors/outliner/interface.rst
===================================================================
--- trunk/blender_docs/manual/editors/outliner/interface.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/editors/outliner/interface.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -17,6 +17,12 @@
- Holding :kbd:`Shift` sets or unsets the value to all its child collections or objects.
- Holding :kbd:`Ctrl` isolates the object or collection, so they are the only ones with its value set.
+.. _bpy.types.LayerCollection.exclude:
+
+Enable Collection (checkbox, collection only)
+ Exclude the collection from the view layer. This option is shown in front of
+ the collection icon, it is not part of the restrictions column.
+
Visibility (eye icon)
Toggles the visibility of the object or collection in the 3D Viewport.
This is a file-local setting, and does not get imported when this data-block
@@ -23,9 +29,6 @@
is linked into another blend-file. Objects hidden this way are still part of
the :doc:`View Layer </scene_layout/view_layers/index>` and evaluated,
so they still affect playback performance.
-Enable Collection (checkbox, collection only)
- Exclude the collection from the view layer. This option is shown in front of
- the collection icon, it is not part of the restrictions column.
.. note::
Modified: trunk/blender_docs/manual/scene_layout/object/editing/apply.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/editing/apply.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/editing/apply.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -73,7 +73,7 @@
:Menu: :menuselection:`Object --> Apply --> Location / Rotation / Scale to Deltas`
:Hotkey: :kbd:`Ctrl-A`
-Converts primary object transformations to :ref:`delta transforms <transform-delta>`,
+Converts primary object transformations to :ref:`delta transforms <bpy.types.Object.delta>`,
any existing delta transforms will be included as well.
- Location to Deltas
Modified: trunk/blender_docs/manual/scene_layout/object/editing/clear.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/editing/clear.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/editing/clear.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -32,5 +32,5 @@
=======
Clear Delta
- Clear the :ref:`delta transform <transform-delta>` in addition to clearing the primary transforms.
+ Clear the :ref:`delta transform <bpy.types.Object.delta>` in addition to clearing the primary transforms.
(Appears in the :ref:`ui-undo-redo-adjust-last-operation` panel.)
Modified: trunk/blender_docs/manual/scene_layout/object/editing/transform/randomize.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/editing/transform/randomize.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/editing/transform/randomize.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -24,7 +24,7 @@
The random seed is an offset to the randomized transformation.
A different seed will produce a new result.
Transform Delta
- Randomize :ref:`Delta Transform <transform-delta>`
+ Randomize :ref:`Delta Transform <bpy.types.Object.delta>`
values instead of regular transform.
Randomize Location
Modified: trunk/blender_docs/manual/scene_layout/object/properties/display.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/properties/display.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/properties/display.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -1,6 +1,3 @@
-.. _bpy.types.Object.show:
-.. _bpy.types.Object.display_type:
-.. _bpy.types.Object.color:
****************
Viewport Display
@@ -12,6 +9,8 @@
The *Viewport Display* panel is used to enable extra display options for the 3D Viewport.
+.. _bpy.types.Object.show:
+
Show
Name
Displays the name of the object in the 3D Viewport.
@@ -28,11 +27,13 @@
In Front
Makes the object display in front of others. (Unsupported for instanced objects.)
+.. _bpy.types.Object.display_type:
+
Display As
The shading mode to display in the 3D Viewport; this can be useful if you have
a high-poly object that is slowing down the viewport.
-.. _objects-display-object-color:
+.. _bpy.types.Object.color:
Color
Allows to specify the object's color when using the Workbench renderer.
Modified: trunk/blender_docs/manual/scene_layout/object/properties/relations.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/properties/relations.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/properties/relations.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -1,6 +1,3 @@
-.. _bpy.types.Object.track_axis:
-.. _bpy.types.Object.up_axis:
-.. _bpy.types.Object.use_extra:
*********
Relations
@@ -12,9 +9,14 @@
The type of parenting used. See :doc:`parenting </scene_layout/object/editing/parent>`
for information on the different types.
+.. _bpy.types.Object.track_axis:
+
Tracking Axis
Axis that points in the "forward" direction.
Applies to *Instance Vertices* when *Align to Vertex Normal* is enabled.
+
+.. _bpy.types.Object.up_axis:
+
Up Axis
Axis that points in the "upward" direction.
Applies to *Instance Vertices* when *Align to Vertex Normal* is enabled.
Modified: trunk/blender_docs/manual/scene_layout/object/properties/transforms.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/properties/transforms.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/properties/transforms.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -1,7 +1,3 @@
-.. _bpy.types.Object.location:
-.. _bpy.types.Object.rotation:
-.. _bpy.types.Object.scale:
-.. _bpy.types.Object.dimensions:
*********
Transform
@@ -32,8 +28,13 @@
Transform Properties.
+.. _bpy.types.Object.location:
+
Location
The object's origin location in global coordinates.
+
+.. _bpy.types.Object.rotation:
+
Rotation
The object's orientation, relative to the global axes and its own origin.
@@ -53,11 +54,16 @@
Quaternion
X, Y, Z and W correspond to the :term:`Quaternion` components.
+.. _bpy.types.Object.scale:
+
Scale
The object's relative scale along the local axis
(e.g. the *Scale X* value represents the scale along the local X axis).
Each object (cube, sphere, etc.), when created, has a scale of one unit in each local direction.
To make the object bigger or smaller, you scale it in the desired axis.
+
+.. _bpy.types.Object.dimensions:
+
Dimensions
The size of the object's bounding box
(aligned with the local axes -- think of a cardboard box just big enough to hold the object).
@@ -81,13 +87,16 @@
.. _bpy.types.Object.delta:
-.. _transform-delta:
Delta Transforms
================
+.. admonition:: Reference
+ :class: refbox
+
+ :Mode: Object Mode
+ :Panel: :menuselection:`Properties --> Object Properties --> Transform --> Delta Transforms`
+
Delta Transforms are simply transformations that are applied on top of the transforms described above.
-They can be found in the :menuselection:`Properties --> Object Properties --> Delta Transforms`.
-
Delta Transforms are particularly useful in animations. For example,
you can animate an object with the primary transforms then move them around with Delta Transforms.
Modified: trunk/blender_docs/manual/scene_layout/object/properties/visibility.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/properties/visibility.rst 2020-11-04 02:28:38 UTC (rev 7329)
+++ trunk/blender_docs/manual/scene_layout/object/properties/visibility.rst 2020-11-04 02:52:50 UTC (rev 7330)
@@ -3,21 +3,33 @@
Visibility
**********
+.. admonition:: Reference
+ :class: refbox
+
+ :Mode: Object Mode
+ :Panel: :menuselection:`Properties --> Object Properties --> Transform`
+
The Visibility panel controls how objects are interacted with in the viewport and in the final render.
+These visibility options can also be set in the :doc:`Outliner </editors/outliner/editing>`.
+.. _bpy.types.Object.hide_select:
+
Selectable
The object is able to be selected in the 3D Viewport.
+.. (todo) we should probably use a rubric directive for UI headings instead of indented blocks
+ This way we can can have RNA links above properties without affecting the HTML rendering
+
+.. _bpy.types.Object.hide_viewport:
+.. _bpy.types.Object.hide_render:
+
Show in
Viewports
The object will be displayed in the 3D Viewport.
+
Renders
The object is able to be in the final render, note that it will still be visible in rendered shading view.
-.. note::
-
- These visibility options can also be set in the :doc:`Outliner </editors/outliner/editing>`.
-
.. seealso::
Cycles has additional :ref:`Visibility properties <render-cycles-object-settings-visibility>`
Modified: trunk/blender_docs/manual/scene_layout/object/selecting.rst
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list