Package rst.scene

This package contains data type definitions that describe arrangements and properties of objects in three dimensional scenes.

Messages

digraph message_graph { fontname="Arial"; fontsize=11; stylesheet="../_static/graphs.css"; node [fontsize=11,fontname="Arial"] edge [fontsize=11,fontname="Arial"] "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObjects" TITLE="Structure rst.scene.SceneObjects" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">SceneObjects</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObject" TITLE="Structure rst.scene.SceneObject" TARGET="_parent">SceneObject</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObjects.scene_object" TITLE="Field rst.scene.SceneObjects.scene_object" TARGET="_parent" PORT="scene_object">scene_object</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "3" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObject" TITLE="Structure rst.scene.SceneObject" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">SceneObject</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObject.name" TITLE="Field rst.scene.SceneObject.name" TARGET="_parent" PORT="name">name</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObject.kind" TITLE="Field rst.scene.SceneObject.kind" TARGET="_parent" PORT="kind">kind</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose" TITLE="Structure rst.geometry.Pose" TARGET="_parent">Pose</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObject.center" TITLE="Field rst.scene.SceneObject.center" TARGET="_parent" PORT="center">center</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Shape3DFloat" TITLE="Structure rst.geometry.Shape3DFloat" TARGET="_parent">Shape3DFloat</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObject.shape" TITLE="Field rst.scene.SceneObject.shape" TARGET="_parent" PORT="shape">shape</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "7" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Shape3DFloat" TITLE="Structure rst.geometry.Shape3DFloat" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Shape3DFloat</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat" TITLE="Structure rst.geometry.BoundingBox3DFloat" TARGET="_parent">BoundingBox3DFloat</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Shape3DFloat.box" TITLE="Field rst.geometry.Shape3DFloat.box" TARGET="_parent" PORT="box">box</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "8" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat" TITLE="Structure rst.geometry.BoundingBox3DFloat" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">BoundingBox3DFloat</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose" TITLE="Structure rst.geometry.Pose" TARGET="_parent">Pose</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.transformation" TITLE="Field rst.geometry.BoundingBox3DFloat.transformation" TARGET="_parent" PORT="transformation">transformation</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.width" TITLE="Field rst.geometry.BoundingBox3DFloat.width" TARGET="_parent" PORT="width">width</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.depth" TITLE="Field rst.geometry.BoundingBox3DFloat.depth" TARGET="_parent" PORT="depth">depth</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT32.html#FLOAT32" TITLE="Fundamental FLOAT32" TARGET="_parent">FLOAT32</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.BoundingBox3DFloat.height" TITLE="Field rst.geometry.BoundingBox3DFloat.height" TARGET="_parent" PORT="height">height</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "4" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose" TITLE="Structure rst.geometry.Pose" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Pose</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation" TITLE="Structure rst.geometry.Translation" TARGET="_parent">Translation</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose.translation" TITLE="Field rst.geometry.Pose.translation" TARGET="_parent" PORT="translation">translation</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation" TITLE="Structure rst.geometry.Rotation" TARGET="_parent">Rotation</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Pose.rotation" TITLE="Field rst.geometry.Pose.rotation" TARGET="_parent" PORT="rotation">rotation</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "6" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation" TITLE="Structure rst.geometry.Rotation" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Rotation</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qw" TITLE="Field rst.geometry.Rotation.qw" TARGET="_parent" PORT="qw">qw</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qx" TITLE="Field rst.geometry.Rotation.qx" TARGET="_parent" PORT="qx">qx</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qy" TITLE="Field rst.geometry.Rotation.qy" TARGET="_parent" PORT="qy">qy</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.qz" TITLE="Field rst.geometry.Rotation.qz" TARGET="_parent" PORT="qz">qz</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Rotation.frame_id" TITLE="Field rst.geometry.Rotation.frame_id" TARGET="_parent" PORT="frame_id">frame_id</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "5" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation" TITLE="Structure rst.geometry.Translation" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">Translation</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.x" TITLE="Field rst.geometry.Translation.x" TARGET="_parent" PORT="x">x</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.y" TITLE="Field rst.geometry.Translation.y" TARGET="_parent" PORT="y">y</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.z" TITLE="Field rst.geometry.Translation.z" TARGET="_parent" PORT="z">z</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.frame_id" TITLE="Field rst.geometry.Translation.frame_id" TARGET="_parent" PORT="frame_id">frame_id</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "1" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObjectQuery" TITLE="Structure rst.scene.SceneObjectQuery" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">SceneObjectQuery</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObjectQuery.name_filter" TITLE="Field rst.scene.SceneObjectQuery.name_filter" TARGET="_parent" PORT="name_filter">name_filter</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-scene.html#rst.scene.SceneObjectQuery.kind_filter" TITLE="Field rst.scene.SceneObjectQuery.kind_filter" TARGET="_parent" PORT="kind_filter">kind_filter</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "2":scene_object -> "3" []; "3":shape -> "7" []; "3":center -> "4" []; "7":box -> "8" []; "8":transformation -> "4" []; "4":rotation -> "6" []; "4":translation -> "5" []; }

clearer: should be made invisible via css

Message SceneObjectQuery

class rst.scene.SceneObjectQuery

Query specification for selecting scene object by name and/or kind.

Code author: David Klotz <dklotz@techfak.uni-bielefeld.de>

name_filter
Type:ASCII-STRING

Regular expression selecting only objects with matching names.

kind_filter
Type:ASCII-STRING

Regular expression selecting only objects with matching kinds.

Hint: to match multiple object kinds in a query, use the regular expression construct:

(KIND1|KIND2|...)

Download this file

message SceneObjectQuery {

    /**
     * Regular expression selecting only objects with matching names.
     */
    optional string name_filter = 1 [default = ".*"];

    /**
     * Regular expression selecting only objects with matching kinds.
     *
     * Hint: to match multiple object kinds in a query, use the
     * regular expression construct:
     *
     *   (KIND1|KIND2|...)
     */
    optional string kind_filter = 2 [default = ".*"];

}

Message SceneObjects

class rst.scene.SceneObjects

A set of scene objects.

Code author: David Klotz <dklotz@techfak.uni-bielefeld.de>

scene_object
Type:array of rst.scene.SceneObject

The set of scene objects.

Empty collection of scene objects is allowed.

The order of scene objects is not significant.

Download this file

message SceneObjects {

    /**
     * The set of scene objects.
     *
     * Empty collection of scene objects is allowed.
     *
     * The order of scene objects is not significant.
     */
    repeated SceneObject scene_object = 1;

}

Message SceneObject

class rst.scene.SceneObject

Geometry and location within a 3D scene of an uniquely identifiable object.

Code author: David Klotz <dklotz@techfak.uni-bielefeld.de>

name
Type:ASCII-STRING

A unique name.

kind
Type:ASCII-STRING

The kind of the object, e.g.: “chair”, “painting”, etc.

center
Type:rst.geometry.Pose

Geometrical object position and orientation in the world coordinate system.

shape
Type:rst.geometry.Shape3DFloat

Geometric shape of the object.

All transformations are relative to center.

Download this file

message SceneObject {

    /**
     * A unique name.
     */
    required string name = 1;

    /**
     * The kind of the object, e.g.: "chair", "painting", etc.
     */
    optional string kind = 2;

    /**
     * Geometrical object position and orientation in the world
     * coordinate system.
     */
    required geometry.Pose center = 3;

    /**
     * Geometric shape of the object.
     *
     * All transformations are relative to @ref .center.
     */
    optional geometry.Shape3DFloat shape = 4;

}