Public Member Functions | Private Attributes
moveit_python.planning_scene_interface.PlanningSceneInterface Class Reference

A class for managing the state of the planning scene. More...

List of all members.

Public Member Functions

def __init__
def addBox
 Insert new box into planning scene.
def addCube
 Insert new cube to planning scene.
def addCylinder
 Insert new cylinder into planning scene.
def addMesh
 Insert a mesh into the planning scene.
def addSolidPrimitive
 Insert a solid primitive into planning scene.
def attachBox
 Attach a box into the planning scene.
def attachMesh
 Attach a mesh into the planning scene.
def clear
 Clear the planning scene of all objects.
def getKnownAttachedObjects
 Get a list of names of attached objects.
def getKnownCollisionObjects
 Get a list of names of collision objects.
def makeAttached
 Make an attachedCollisionObject.
def makeMesh
 Make a mesh collision object.
def makeSolidPrimitive
 Make a solid primitive collision object.
def removeAttachedObject
 Send message to remove object.
def removeCollisionObject
 Send message to remove object.
def sceneCb
 Update the object lists from a PlanningScene message.
def sendColors
 Actually send the colors to MoveIt!
def setColor
 Set the color of an object.
def waitForSync
 Wait for sync.

Private Attributes

 _attached
 _attached_objects
 _attached_pub
 _attached_removed
 _collision
 _colors
 _fixed_frame
 _mutex
 _objects
 _pub
 _removed
 _scene_pub
 _service

Detailed Description

A class for managing the state of the planning scene.

Parameters:
frameThe fixed frame in which planning is being done (needs to be part of robot?)
init_from_serviceWhether to initialize our list of objects by calling the service NOTE: this requires that said service be in the move_group launch file, which is not the default from the setup assistant.

Definition at line 44 of file planning_scene_interface.py.


Constructor & Destructor Documentation

def moveit_python.planning_scene_interface.PlanningSceneInterface.__init__ (   self,
  frame,
  init_from_service = True 
)

Definition at line 45 of file planning_scene_interface.py.


Member Function Documentation

def moveit_python.planning_scene_interface.PlanningSceneInterface.addBox (   self,
  name,
  size_x,
  size_y,
  size_z,
  x,
  y,
  z,
  wait = True 
)

Insert new box into planning scene.

Parameters:
nameName of the object
size_xThe x-dimensions size of the box
size_yThe y-dimensions size of the box
size_zThe z-dimensions size of the box
xThe x position in link_name frame
yThe y position in link_name frame
zThe z position in link_name frame
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 232 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.addCube (   self,
  name,
  size,
  x,
  y,
  z,
  wait = True 
)

Insert new cube to planning scene.

Parameters:
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 282 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.addCylinder (   self,
  name,
  height,
  radius,
  x,
  y,
  z,
  wait = True 
)

Insert new cylinder into planning scene.

Parameters:
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 208 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.addMesh (   self,
  name,
  pose,
  filename,
  wait = True 
)

Insert a mesh into the planning scene.

Parameters:
nameName of the object
poseA geometry_msgs/Pose for the object
filenameThe mesh file to load
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 171 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.addSolidPrimitive (   self,
  name,
  solid,
  pose,
  wait = True 
)

Insert a solid primitive into planning scene.

Parameters:
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 198 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.attachBox (   self,
  name,
  size_x,
  size_y,
  size_z,
  x,
  y,
  z,
  link_name,
  touch_links = None,
  detach_posture = None,
  weight = 0.0,
  wait = True 
)

Attach a box into the planning scene.

Parameters:
nameName of the object
size_xThe x-dimensions size of the box
size_yThe y-dimensions size of the box
size_zThe z-dimensions size of the box
xThe x position in link_name frame
yThe y position in link_name frame
zThe z position in link_name frame
link_nameName of link to attach this object to
touch_linksNames of robot links that can touch this object
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 258 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.attachMesh (   self,
  name,
  pose,
  filename,
  link_name,
  touch_links = None,
  detach_posture = None,
  weight = 0.0,
  wait = True 
)

Attach a mesh into the planning scene.

Parameters:
nameName of the object
poseA geometry_msgs/Pose for the object
filenameThe mesh file to load
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 184 of file planning_scene_interface.py.

Clear the planning scene of all objects.

Definition at line 94 of file planning_scene_interface.py.

Get a list of names of attached objects.

Definition at line 364 of file planning_scene_interface.py.

Get a list of names of collision objects.

Definition at line 357 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.makeAttached (   self,
  link_name,
  obj,
  touch_links,
  detach_posture,
  weight 
)

Make an attachedCollisionObject.

Definition at line 153 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.makeMesh (   self,
  name,
  pose,
  filename 
)

Make a mesh collision object.

Parameters:
nameName of the object
poseA geometry_msgs/Pose for the object
filenameThe mesh file to load

Definition at line 105 of file planning_scene_interface.py.

Make a solid primitive collision object.

Parameters:
nameName of the object
solidThe solid primitive to add
poseA geometry_msgs/Pose for the object
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.

Definition at line 142 of file planning_scene_interface.py.

Send message to remove object.

Parameters:
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.
Remove an attached object. 

Definition at line 309 of file planning_scene_interface.py.

Send message to remove object.

Parameters:
waitWhen true, we wait for planning scene to actually update, this provides immunity against lost messages.
Remove an object. 

Definition at line 288 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.sceneCb (   self,
  msg,
  initial = False 
)

Update the object lists from a PlanningScene message.

Recieve updates from move_group. 

Definition at line 327 of file planning_scene_interface.py.

Actually send the colors to MoveIt!

Definition at line 415 of file planning_scene_interface.py.

def moveit_python.planning_scene_interface.PlanningSceneInterface.setColor (   self,
  name,
  r,
  g,
  b,
  a = 0.9 
)

Set the color of an object.

Definition at line 404 of file planning_scene_interface.py.

Wait for sync.

Definition at line 371 of file planning_scene_interface.py.


Member Data Documentation

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.

Definition at line 45 of file planning_scene_interface.py.


The documentation for this class was generated from the following file:


moveit_python
Author(s): Michael Ferguson
autogenerated on Fri Aug 28 2015 11:32:16