Skip to content

Commit e011267

Browse files
committed
add note in docstring instead
1 parent 79f8a82 commit e011267

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/compas/scene/sceneobject.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,13 @@ class SceneObject(TreeNode):
5454
The node in the scene tree which represents the scene object.
5555
guids : list[object]
5656
The GUIDs of the items drawn in the visualization context.
57-
frame : :class:`compas.geometry.Frame`
58-
The frame of the local coordinate system of the scene object.
5957
transformation : :class:`compas.geometry.Transformation`
6058
The local transformation of the scene object in relation to its parent object.
6159
worldtransformation : :class:`compas.geometry.Transformation`
62-
The transformation of the scene object in world coordinates.
60+
The global transformation of the scene object in world coordinates, computed by multiplying all transformations from the scene object to the root of the scene tree.
61+
(NOTE: Changed from 2.11.0, there will no longer be the option of additional transformation in relation to the object's frame)
62+
frame : :class:`compas.geometry.Frame`
63+
The frame of the local coordinate system of the scene object, derived from the `worldtransformation`.
6364
color : :class:`compas.colors.Color`
6465
The color of the object.
6566
contrastcolor : :class:`compas.colors.Color`, readon-only
@@ -169,7 +170,6 @@ def transformation(self, transformation):
169170
@property
170171
def worldtransformation(self):
171172
# type: () -> compas.geometry.Transformation
172-
# NOTE: Behaviour change from 2.11.0, there will no longer be the option of additional transformation in relation to the object's frame
173173
transformations = [self.transformation] if self.transformation else []
174174
parent = self.parent
175175
while parent and not parent.is_root:

0 commit comments

Comments
 (0)