Skip to content

Commit

Permalink
Properties and Attributes docstring of Tool class, introduced TCF and…
Browse files Browse the repository at this point in the history
… PCF terminology.
  • Loading branch information
yck011522 committed Apr 12, 2024
1 parent f43efc1 commit 314bfce
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions src/compas_fab/robots/tool.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,32 @@
class Tool(Data):
"""Represents a tool to be attached to the robot's flange.
Attributes
Properties
----------
visual : :class:`compas.datastructures.Mesh`
The visual mesh of the tool.
frame_in_tool0_frame : :class:`compas.geometry.Frame`
The frame of the tool in tool0 frame.
The tool coordinate frame (TCF) of the tool relative to the planner coordinate frame (PCF).
collision : :class:`compas.datastructures.Mesh`
The collision mesh representation of the tool.
name : :obj:`str`
The name of the `Tool`. Defaults to 'attached_tool'.
connected_to : :obj:`str`
The name of the `Link` to which the tool is attached. Defaults to ``None``.
Attributes
----------
tool_model : :class:`compas_robots.ToolModel`
The tool model.
attached_collision_meshes : :obj:`list` of :class:`compas_fab.robots.AttachedCollisionMesh`, read-only
The collision meshes of the tool.
name : :obj:`str`, read-only
The name of the `Tool`.
connected_to : :obj:`str`
The name of the `Link` to which the tool is attached.
frame : :class:`compas.geometry.Frame`
The tool coordinate frame (TCF) of the tool relative to the planner coordinate frame (PCF).
Examples
--------
>>> mesh = Mesh.from_stl(compas_fab.get('planning_scene/cone.stl'))
Expand Down

0 comments on commit 314bfce

Please sign in to comment.