[Bf-blender-cvs] [32b5f24c2a9] master: API Docs: add example use cases for mesh functions, fix wrong description

Brecht Van Lommel noreply at git.blender.org
Fri May 17 10:36:17 CEST 2019


Commit: 32b5f24c2a9cdf3a7c1f2f695bbc8704eb159a12
Author: Brecht Van Lommel
Date:   Fri May 17 10:30:41 2019 +0200
Branches: master
https://developer.blender.org/rB32b5f24c2a9cdf3a7c1f2f695bbc8704eb159a12

API Docs: add example use cases for mesh functions, fix wrong description

===================================================================

M	doc/python_api/examples/bpy.types.Depsgraph.4.py
M	doc/python_api/examples/bpy.types.Depsgraph.5.py

===================================================================

diff --git a/doc/python_api/examples/bpy.types.Depsgraph.4.py b/doc/python_api/examples/bpy.types.Depsgraph.4.py
index a7b6068cfae..c2017afa2f9 100644
--- a/doc/python_api/examples/bpy.types.Depsgraph.4.py
+++ b/doc/python_api/examples/bpy.types.Depsgraph.4.py
@@ -2,6 +2,9 @@
 Dependency graph: Object.to_mesh()
 +++++++++++++++++++++++++++++++++++
 
+Function to get a mesh from any object with geometry. It is typically used by exporters, render
+engines and tools that need to access the evaluated mesh as displayed in the viewport.
+
 Object.to_mesh() is closely interacting with dependency graph: its behavior depends on whether it
 is used on original or evaluated object.
 
diff --git a/doc/python_api/examples/bpy.types.Depsgraph.5.py b/doc/python_api/examples/bpy.types.Depsgraph.5.py
index 353161a547a..335e87071e5 100644
--- a/doc/python_api/examples/bpy.types.Depsgraph.5.py
+++ b/doc/python_api/examples/bpy.types.Depsgraph.5.py
@@ -2,8 +2,9 @@
 Dependency graph: bpy.data.meshes.new_from_object()
 +++++++++++++++++++++++++++++++++++++++++++++++++++
 
-Object.to_mesh() is closely interacting with dependency graph: its behavior depends on whether it
-is used on original or evaluated object.
+Function to copy a new mesh from any object with geometry. The mesh is added to the main
+database and can be referenced by objects. Typically used by tools that create new objects
+or apply modifiers.
 
 When is used on original object, the result mesh is calculated from the object without taking
 animation or modifiers into account:
@@ -17,7 +18,6 @@ When is used on evaluated object all modifiers are taken into account.
 All the references (such as materials) are re-mapped to original. This ensures validity and
 consistency of the main database.
 
-.. note:: The result mesh is added to the main database. This mesh can be referenced by any object,
 .. note:: If object does not have geometry (i.e. camera) the functions returns None.
 """
 import bpy



More information about the Bf-blender-cvs mailing list