sdformat 0.1.0

Parsing library for sdformat in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<element name="world" required="*">
  <description>The world element encapsulates an entire world description including: models, scene, physics, and plugins.</description>

  <attribute name="name" type="string" default="__default__" required="1">
    <description>Unique name of the world</description>
  </attribute>

  <element name="audio" required="0">
    <description>Global audio properties.</description>

    <element name="device" type="string" default="default" required="1">
      <description>Device to use for audio playback. A value of "default" will use the system's default audio device. Otherwise, specify a an audio device file"</description>
    </element>
  </element>

  <element name="wind" required="0">
    <description>The wind tag specifies the type and properties of the wind.</description>

    <element name="linear_velocity" type="vector3" default="0 0 0" required="0">
      <description>Linear velocity of the wind.</description>
    </element>
  </element>

  <element name="include" required="*">
    <description>
        Include resources from a URI. Included resources can only contain one 'model', 'light' or 'actor' element. The URI can point to a directory or a file. If the URI is a directory, it must conform to the model database structure (see /tutorials?tut=composition&amp;cat=specification&amp;#defining-models-in-separate-files).
    </description>
    <element name="uri" type="string" default="__default__" required="1">
      <description>URI to a resource, such as a model</description>
    </element>

    <element name="name" type="string" default="" required="0">
      <description>Override the name of the included entity.</description>
    </element>

    <element name="static" type="bool" default="false" required="0">
      <description>Override the static value of the included entity.</description>
    </element>

    <include filename="pose.sdf" required="0"/>
    <include filename="plugin.sdf" required="*"/>

    <element name="placement_frame" type="string" default="" required="0">
      <description>The frame inside the included entity whose pose will be set by the specified pose element. If this element is specified, the pose must be specified.</description>
    </element>
  </element>

  <element name="gravity" type="vector3" default="0 0 -9.8" required="1">
    <description>The gravity vector in m/s^2, expressed in a coordinate frame defined by the spherical_coordinates tag.</description>
  </element> <!-- End Gravity -->

  <element name="magnetic_field" type="vector3" default="5.5645e-6 22.8758e-6 -42.3884e-6" required="1">
    <description>The magnetic vector in Tesla, expressed in a coordinate frame defined by the spherical_coordinates tag.</description>
  </element> <!-- End Magnetic -->

  <include filename="atmosphere.sdf" required="1"/>
  <include filename="gui.sdf" required="0"/>
  <include filename="physics.sdf" required="+"/>
  <include filename="scene.sdf" required="1"/>
  <include filename="light.sdf" required="*"/>

  <include filename="frame.sdf" required="*"/>
  <include filename="model.sdf" required="*"/>
  <include filename="actor.sdf" required="*"/>
  <include filename="plugin.sdf" required="*"/>
  <include filename="road.sdf" required="*"/>
  <include filename="spherical_coordinates.sdf" required="0"/>

  <include filename="state.sdf" required="*"/>
  <include filename="population.sdf" required="*"/>
</element> <!-- End World -->