Skip to content

Exhibit

Loris Sauter edited this page Jan 15, 2019 · 4 revisions

Exhibit Model

The exhibit represents an object that is on display in an exhibition.

Properties

  • position (Vector3f): The exhibit's position. In case this exhibit is attached to a wall the only x and y values are considered. Origin is the lower left corner of the wall.
  • size (Vector3f): The exhibit's size in meters. In case of an image, only x and y values are cosindered.
  • audio (String): The path to the dedicated audio to playe in close proximity of this exhibit. null if no such audio exists. Defaults to null.
  • light (boolean): Whether or not this exhibit has a dedicated spotlight. This value might be overridden by VREP settings. Defaults to false.
  • name (String): The exhibit's name.
  • type (IMAGE | MODEL): The exhibit's type. Images are usually attached to walls, models to rooms.
  • path (String): The path to the exhibit's representation. In case of an image this is an image file retrievable via VREM.
  • description: (String): An optional description of the exhibit.
  • metadata (String-String Map): An optional key-value store for additional information. Not supported yet by VREP.

Example

The following example JSON describes an exhibit of type image. The image's path under the documentRoot is images/room01/north/example.png. The image's width is 2m and its height is 1.62m. It is positioned 1.5m above ground and 5m from the left edge of the wall.

{
  "name" : "Example Image",
  "description" : "",
  "path" : "images/room01/north/example.png",
  "type" : "IMAGE",
  "size" : {
      "x" : 2.0,
      "y" : 1.62,
      "z" : 1.0
  },
  "position" : {
      "x" : 1.5,
      "y" : 1.5,
      "z" : 0.0
  }
}
Clone this wiki locally