[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [16935] trunk/blender/source/blender/ python/api2_2x/doc/Object.py: Python API

[Ken Hughes]

Revision: 16935
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=16935
Author:   khughes
Date:     2008-10-05 16:31:40 +0200 (Sun, 05 Oct 2008)

Log Message:
-----------
Python API
----------
Change documentation for Object.getSize(), Object.getEuler(), Object.getLocation() to clear up confusion about 'localspace' parameter.

Modified Paths:
--------------
    trunk/blender/source/blender/python/api2_2x/doc/Object.py

Modified: trunk/blender/source/blender/python/api2_2x/doc/Object.py
===================================================================
--- trunk/blender/source/blender/python/api2_2x/doc/Object.py	2008-10-05 12:06:55 UTC (rev 16934)
+++ trunk/blender/source/blender/python/api2_2x/doc/Object.py	2008-10-05 14:31:40 UTC (rev 16935)
@@ -264,7 +264,7 @@
 
 	B{Note}:
 	When dealing with properties and functions such as LocX/RotY/getLocation(), getSize() and getEuler(),
-	keep in mind that these transformation properties are relative to the object's parent (if any).
+	keep in mind that these transformation properties are relative to the object itself, ignoring any other transformations.
 
 	To get these values in worldspace (taking into account vertex parents, constraints, etc.)
 	pass the argument 'worldspace' to these functions.
@@ -780,9 +780,9 @@
 		"""
 		@type space: string
 		@param space: The desired space for the size:
-			- localspace: (default) relative to the object's parent;
-			- worldspace: absolute, taking vertex parents, tracking and
-					Ipo's into account;
+			- localspace: (default) location without other transformations
+			- worldspace: location taking vertex parents, tracking and
+					Ipos into account
 		Returns the object's localspace rotation as Euler rotation vector (rotX, rotY, rotZ).  Angles are in radians.
 		@rtype: Py_Euler
 		@return: A python Euler. Data is wrapped when euler is present.
@@ -812,9 +812,9 @@
 		"""
 		@type space: string
 		@param space: The desired space for the location:
-			- localspace: (default) relative to the object's parent;
-			- worldspace: absolute, taking vertex parents, tracking and
-				Ipo's into account;
+			- localspace: (default) location without other transformations
+			- worldspace: location taking vertex parents, tracking and
+				Ipos into account
 		Returns the object's location (x, y, z).
 		@return: (x, y, z)
 
@@ -895,9 +895,9 @@
 		"""
 		@type space: string
 		@param space: The desired space for the size:
-			- localspace: (default) relative to the object's parent;
-			- worldspace: absolute, taking vertex parents, tracking and
-				Ipo's into account;
+			- localspace: (default) location without other transformations
+			- worldspace: location taking vertex parents, tracking and
+					Ipos into account
 		Returns the object's size.
 		@return: (SizeX, SizeY, SizeZ)
 		@note: the worldspace size will not return negative (flipped) scale values.