Merge pull request #1279 from compas-dev/context

add description about scene context

Author: Licini

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `compas_rhino.install_with_pip`.
 * Added `before_draw` pluggable to `compas.scene.Scene.draw`.
 * Added `after_draw` pluggable to `compas.scene.Scene.draw`.
+* Added description in tutorial about `compas.scene.context`.
 
 ### Changed
 

docs/userguide/basics.visualisation.rst

@@ -114,3 +114,31 @@ To use a different scene object as the parent, the parent attribute of the scene
 >>> boxobj = scene.add(box, parent=pointobj)
 >>> boxobj.parent
 PointObject
+
+
+Scene Context
+=============
+
+Depending on where the code is executed, the "scene" will detect the current visualisation context.
+If the code is executed in the Rhino, the scene context will be automatically set as "Rhino". 
+
+>>> from compas.scene import Scene
+>>> from compas.geometry import Box
+>>> scene = Scene()
+>>> scene.context
+Rhino
+
+For every context, the appropriate scene object implementations will be used automatically.
+
+>>> box = Box.from_width_height_depth(1, 1, 1)
+>>> scene.add(box)
+<compas_rhino.scene.BoxObject>
+
+Users can also set the scene context manually:
+
+>>> scene = Scene(context="MyContextName")
+>>> scene.context
+MyContextName
+
+The currently supported contexts are: "Viewer", "Rhino", "Grasshopper", "Blender" and None.
+For working with different contexts please refer to the next section "Tutorial: Working in CAD".