Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKen Hughes <khughes@pacific.edu>2008-10-05 18:31:40 +0400
committerKen Hughes <khughes@pacific.edu>2008-10-05 18:31:40 +0400
commite99ff615d78132bf206ab7fbf572d3d63f345a75 (patch)
treeddf27fe1e48c7e2669b23f7ca7754cbf0dbcacb6
parent333b7c3668d16f73e3f8e1c1d17a8b4e0f527419 (diff)
Python API
---------- Change documentation for Object.getSize(), Object.getEuler(), Object.getLocation() to clear up confusion about 'localspace' parameter.
-rw-r--r--source/blender/python/api2_2x/doc/Object.py20
1 files changed, 10 insertions, 10 deletions
diff --git a/source/blender/python/api2_2x/doc/Object.py b/source/blender/python/api2_2x/doc/Object.py
index 49cb14d1e66..d56a547911e 100644
--- a/source/blender/python/api2_2x/doc/Object.py
+++ b/source/blender/python/api2_2x/doc/Object.py
@@ -264,7 +264,7 @@ class Object:
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 @@ class Object:
"""
@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 @@ class Object:
"""
@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 @@ class Object:
"""
@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.