Skip to content

Footprint

Examples

Example 1

<Footprint>
  <Square width="3.0" height="3.0"/>
  <Height>
    0.0
  </Height>
  <MaxSpawnDistance>
    8
  </MaxSpawnDistance>
</Footprint>

Example 2

<Footprint>
  <Circle radius="0.5"/>
  <Height>
    0.0
  </Height>
  <MaxSpawnDistance>
    8
  </MaxSpawnDistance>
</Footprint>

XML Elements

The following elements can be used within this component:

Footprint

Square

Set the footprint to a square of the given size

Path: Footprint/Square

@width

Size of the footprint along the left/right direction (in meters)

Type: decimal (e.g. -10.0 or 0.0 or 2.5)

Path: Footprint/Square@width

@depth

Size of the footprint along the front/back direction (in meters)

Type: decimal (e.g. -10.0 or 0.0 or 2.5)

Path: Footprint/Square@depth

Circle

Set the footprint to a circle of the given size

Path: Footprint/Circle

@radius

Radius of the footprint (in meters)

Type: decimal (e.g. -10.0 or 0.0 or 2.5)

Path: Footprint/Circle@radius

Height

Vertical extent of the footprint (in meters)

Type: non-negative decimal

Path: Footprint/Height

MaxSpawnDistance

Farthest distance units can spawn away from the edge of this entity

Type: non-negative decimal

Path: Footprint/MaxSpawnDistance

RELAX NG Grammar

<define name="component.Footprint">
  <element name="Footprint">
    <interleave>
      <choice>
        <element name="Square">
          <attribute name="width">
            <data type="decimal">
              <param name="minExclusive">
              </param>
            </data>
          </attribute>
          <attribute name="depth">
            <data type="decimal">
              <param name="minExclusive">
              </param>
            </data>
          </attribute>
        </element>
        <element name="Circle">
          <attribute name="radius">
            <data type="decimal">
              <param name="minExclusive">
              </param>
            </data>
          </attribute>
        </element>
      </choice>
      <element name="Height">
        <ref name="nonNegativeDecimal"/>
      </element>
      <optional>
        <element name="MaxSpawnDistance">
          <ref name="nonNegativeDecimal"/>
        </element>
      </optional>
    </interleave>
  </element>
</define>