API Docs: add example use cases for mesh functions, fix wrong description
authorBrecht Van Lommel <brechtvanlommel@gmail.com>
Fri, 17 May 2019 08:30:41 +0000 (10:30 +0200)
committerBrecht Van Lommel <brechtvanlommel@gmail.com>
Fri, 17 May 2019 08:34:20 +0000 (10:34 +0200)
doc/python_api/examples/bpy.types.Depsgraph.4.py
doc/python_api/examples/bpy.types.Depsgraph.5.py

index a7b6068cfae19b4f77ff778de5a2a4ee885d8de4..c2017afa2f9fc51df7e47ed0b07af056d355882c 100644 (file)
@@ -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.
 
index 353161a547ab697f5b8dfa90a9cf1c487bdecc70..335e87071e5e634bf4a8e03e2018f2e3ca13ed17 100644 (file)
@@ -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