Worlds and objects

Object types, instances, worlds, setups and anchors, and how they fit together.

A skill never contains coordinates. It names objects and places on them, and the platform resolves those names against the world loaded at run time. Five terms carry that:

TermWhat it isWhere it lives
Object typeA kind of thing: its shape, joints and anchors. wellplate_stand, wellplate_shaker.objects/<type>/ in your project, or the mesh database
InstanceOne object of a type in a world, with an id, a display name and a pose. wellplate_stand_1.The world
WorldThe scene: tables and instances with their poses.worlds/<id>/
SetupThe robot rig: the arms, their grippers and where their bases stand.Named by setup in project.json
AnchorA named frame on an object type: a grasp point, a slot, a seat. top_center, slot_1.The type's object_model.yaml

How they connect:

  • A world places instances of types. The type's files come from your project's objects/<type>/ first, then from the mesh database. One type, many instances: the starter world has two wellplate_stand instances.
  • Tables are instances of the world too. A world owns its tables; the setup provides none.
  • A world is laid out in the frame of one setup: the coordinates are relative to that rig's arm bases.
  • A skill receives instances as inputs and asks for anchors by name. anchor(plate, "grasp_short") returns where that grasp is in the world now.

The usual order of work:

  1. Get the object types you need into your project, or rely on the catalog.
  2. Build a world: place instances on the tables and save it.
  3. Write skills against anchor names, and pick the world when you run.

Pages in this section

File formats

FileCovers
worlds/<id>/world_state.jsonStarting layouts and saved worlds
worlds/<id>/live_state.yamlTip pointers, seats, per-seat calibration
objects/<name>/<name>.object_model.yamlParts, articulation presets, anchors
project.jsonDefault workflow and world, and the setup
viewer.yamlNamed camera views for zeon look

Did this page help you?