concepts.benchmark.manip_tabletop.pybullet_tabletop.TableTopEnv#

class TableTopEnv[source]#

Bases: BulletEnvBase

TableTopEnv is a environment for manipulating tools in a 3D but table-top-only environment. So there is only minimal amount of 3D information involved.

The environment will be simulated by pybullet.

Methods

add_bar(size_2d, thickness, location_2d[, ...])

add_box(size, location_2d[, name, static, ...])

add_cliport_workspace()

add_container(size_2d, depth, location_2d[, ...])

add_igibson_object_by_category(category, ...)

add_l_shape(size1_2d, size2_2d, thickness, ...)

add_l_shape_with_tip(size1_2d, size2_2d, ...)

add_ocrtoc_object(identifier, location_3d[, ...])

add_plate(scale, location_2d[, name, ...])

add_region(size_2d, location_2d[, name, ...])

Add a visual-only region indicator to the environment.

add_robot([robot, pos])

Add a robot to the environment.

add_shape_net_core_object(synset_identifier, ...)

add_t_shape(size1_2d, size2_2d, thickness, ...)

add_t_shape_with_tip(size1_2d, size2_2d, ...)

add_thin_plate(scale, location_2d[, name, ...])

add_workspace([large])

Add a table-top workspace to the environment.

add_ycb_simplified_object(identifier, ...[, ...])

find_igibson_object_by_category(category)

get_support(body_id[, return_name])

initialize_shapenet_core_loader(shapenet_dir)

list_ocrtoc_objects()

list_shape_net_core_objects()

list_ycb_simplified_objects()

reset()

restore()

Restore the environment to the last saved state.

seed(seed)

set_default_debug_camera([distance])

Set the default debug camera of the environment.

set_executor(executor)

Attributes

CLIPORT_PLANE_FILE

CLIPORT_WORKSPACE_FILE

PLANE_FILE

PLANE_LARGE_FILE

WORKSPACE_FILE

WORKSPACE_LARGE_FILE

client

executor

igibson_root

np_random

ocrtoc_root

p

shapenet_core_loader

w

world

ycb_simple_root

__init__(client=None, executor=None, seed=1234)[source]#
Parameters:
__new__(**kwargs)#
add_bar(size_2d, thickness, location_2d, name='bar-shape', *, static=False, quat=(0, 0, 0, 1))[source]#
Parameters:
Return type:

int

add_box(size, location_2d, name='box', *, static=False, z_height=0, mass=0.2, lateral_friction=1.0, color_rgba=(1, 0.34, 0.34, 1.), quat=None)[source]#
Parameters:
Return type:

int

add_cliport_workspace()[source]#
add_container(size_2d, depth, location_2d, name='container', *, static=True, color_rgba=None, quat=None)[source]#
Parameters:
Return type:

int

add_igibson_object_by_category(category, location_3d, scale=1.0, name=None, *, urdf_file=None, static=False, quat=(0, 0, 0, 1))#
Parameters:
add_l_shape(size1_2d, size2_2d, thickness, location_2d, name='l-shape', *, static=False, quat=(0, 0, 0, 1))[source]#
Parameters:
Return type:

int

add_l_shape_with_tip(size1_2d, size2_2d, size3_2d, thickness, location_2d, name='l-shape-with-tip', *, static=False, quat=(0, 0, 0, 1))[source]#
Parameters:
Return type:

int

add_ocrtoc_object(identifier, location_3d, scale=1.0, name=None, *, static=False, quat=(0, 0, 0, 1))#
Parameters:
add_plate(scale, location_2d, name='plate', *, static=False, z_height=0.0)[source]#
Parameters:
Return type:

int

add_region(size_2d, location_2d, name='region', *, color_rgba=(0.5, 0.5, 0.5, 1))[source]#

Add a visual-only region indicator to the environment.

Parameters:
Returns:

the body id of the region.

Return type:

int

add_robot(robot='panda', pos=None)[source]#

Add a robot to the environment.

Parameters:

  • robot (str) – the type of the robot. Currently only ['ur5', 'panda'] are supported.

  • pos (Tuple[float, float, float] | List[float] | ndarray | None) – the initial position of the robot. If not given, the robot will be placed at the origin.

Returns:

the body id of the robot.

Return type:

int

add_shape_net_core_object(synset_identifier, model_identifier, location_3d, scale=1.0, name=None, *, static=False, quat=(0, 0, 0, 1))#
Parameters:
add_t_shape(size1_2d, size2_2d, thickness, location_2d, name='t-shape', *, static=False, quat=(0, 0, 0, 1))[source]#
Parameters:
Return type:

int

add_t_shape_with_tip(size1_2d, size2_2d, size3_2d, thickness, location_2d, name='t-shape-with-tip', *, static=False, quat=(0, 0, 0, 1))[source]#
Parameters:
Return type:

int

add_thin_plate(scale, location_2d, name='plate', *, static=False, z_height=0.0)[source]#
Parameters:
Return type:

int

add_workspace(large=False)[source]#

Add a table-top workspace to the environment.

Returns:

the body id of the collision shape of the body.

Parameters:

large (bool) –

Return type:

int

add_ycb_simplified_object(identifier, location_3d, scale=1.0, name=None, *, static=False, quat=(0, 0, 0, 1))#
Parameters:
find_igibson_object_by_category(category)#
Parameters:

category (str) –

Return type:

List[str]

get_support(body_id, return_name=True)[source]#
Parameters:

  • body_id (int) –

  • return_name (bool) –

Return type:

List[str | int]

initialize_shapenet_core_loader(shapenet_dir)#
Parameters:

shapenet_dir (str) –

list_ocrtoc_objects()#
Return type:

List[str]

list_shape_net_core_objects()#
Return type:

Dict[str, Dict[str, Any]]

list_ycb_simplified_objects()#
Return type:

List[str]

reset()[source]#
Return type:

None

restore()[source]#

Restore the environment to the last saved state.

Return type:

None

seed(seed)#
Parameters:

seed (int) –

set_default_debug_camera(distance=1.5)[source]#

Set the default debug camera of the environment.

Parameters:

distance (float) –

set_executor(executor)[source]#
Parameters:

executor (PDSketchExecutor) –

CLIPORT_PLANE_FILE = 'assets://cliport/plane/plane.urdf'#
CLIPORT_WORKSPACE_FILE = 'assets://cliport/workspace/workspace.urdf'#
PLANE_FILE = 'assets://basic/plane/plane.urdf'#
PLANE_LARGE_FILE = 'assets://basic/plane/plane_large.urdf'#
WORKSPACE_FILE = 'assets://basic/plane/workspace.urdf'#
WORKSPACE_LARGE_FILE = 'assets://basic/plane/workspace_large.urdf'#
property client: BulletClient#
property executor: PDSketchExecutor#
property igibson_root: str#
property np_random: RandomState#
property ocrtoc_root: str#
property p#
property shapenet_core_loader: ShapeNetCoreLoader#
property w#
property world#
property ycb_simple_root: str#