Depsgraph: State behavior details more explicitly

This commit is contained in:
Sergey Sharybin 2019-05-17 10:23:31 +02:00
parent e02f68c577
commit 5186cfbea4
3 changed files with 7 additions and 2 deletions

View File

@ -15,6 +15,10 @@ animation or modifiers into account:
When is used on evaluated object all modifiers are taken into account.
.. note:: The result mesh is owned by the object. It can be freed by calling `object.to_mesh_clear()`.
.. note::
The result mesh must be treated as temporary, and can not be referenced from objects in the main
database. If the mesh intended to be used in a persistent manner use bpy.data.meshes.new_from_object()
instead.
.. note:: If object does not have geometry (i.e. camera) the functions returns None.
"""
import bpy

View File

@ -17,7 +17,7 @@ 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.
.. 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

View File

@ -895,7 +895,8 @@ void RNA_api_object(StructRNA *srna)
RNA_def_function_ui_description(
func,
"Create a Mesh data-block from the current state of the object. The object owns the "
"data-block. To force free it use to_mesh_clear()");
"data-block. To force free it use to_mesh_clear(). "
"The result is temporary and can not be used by objects from the main database");
RNA_def_function_flag(func, FUNC_USE_REPORTS);
parm = RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object");
RNA_def_function_return(func, parm);