Skip to content

Commit a513cba

Browse files
tetovgonzalocasas
andauthored
Update src/compas_fab/robots/planning_scene.py
Co-Authored-By: Gonzalo Casas <[email protected]>
1 parent 90708ee commit a513cba

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/compas_fab/robots/planning_scene.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,10 +211,14 @@ def remove_collision_mesh(self, id):
211211
def append_collision_mesh(self, collision_mesh, scale=False):
212212
"""Append a collision mesh to the planning scene.
213213
214-
Adds or appends :class:`CollisionMesh` to :class:`PlanningScene` using
215-
`id`. This means that if there's already a :class:`CollisionMesh` in the
216-
planning scene it will be merged with the :class:`CollisionMesh` given
217-
as an argument to the method.
214+
Appends a :class:`CollisionMesh` to the :class:`PlanningScene` using
215+
``id`` as an identifier of a group or cluster of collision meshes. If the group
216+
does not exist, it will be created implicitly; if it does exist, the meshes will be
217+
appended to it instead.
218+
219+
Grouping meshes under a common identifier allows to remove them all
220+
in one operation, using the :meth:`~PlanningScene.remove_collision_mesh` with
221+
the group identifier.
218222
219223
Parameters
220224
----------

0 commit comments

Comments
 (0)