-- added an optional "cage" parameter to mesh.getFromObject() to allow

   getting cage vertices from geometry objects

1 files changed, 7 insertions, 3 deletions

diff --git a/source/blender/python/api2_2x/doc/Mesh.py b/source/blender/python/api2_2x/doc/Mesh.py
index 263c4762a76..9e1b3e6610f 100644
--- a/source/blender/python/api2_2x/doc/Mesh.py
+++ b/source/blender/python/api2_2x/doc/Mesh.py
@@ -620,17 +620,21 @@ class Mesh:
   @type activeFace: int
   """
 
-  def getFromObject(name):
+  def getFromObject(name,cage=0):
     """
     Replace the mesh's existing data with the raw mesh data from a Blender
     Object.  This method supports all the geometry based objects (mesh, text,
     curve, surface, and meta).  If the object has modifiers, they will be
-    applied before to the object before extracting the vertex data.
-    @note: The mesh coordinates are in i{local space}, not the world space of
+    applied before to the object before extracting the vertex data unless
+    the B{cage} parameter is 1.
+    @note: The mesh coordinates are in I{local space}, not the world space of
     its object.  For world space vertex coordinates, each vertex location must
     be multiplied by the object's 4x4 transform matrix (see L{transform}).
     @type name: string
     @param name: name of the Blender object which contains the geometry data.
+    @type cage: int
+    @param cage: determines whether the original vertices or derived vertices
+    (for objects with modifiers) are used.  The default is derived vertices.
     """
 
   def calcNormals():