SDFormat v1.7 Bindings

Warning

If you want to use these bindings explicitly, you need to import them first:

import skbot.ignition.sdformat.bindings.v17 as v17

Scikit-bot’s SDFormat bindings are realized as a set of dataclasses. Each class corresponds to a unique element found within SDFormat XML and has an attribute for every attribute and child of the corresponding SDFormat element. Names generally match the names used within SDFormat; however, are adapted to python convention where needed.

Elements

v17.actor.Actor([skin, animation, script, ...])

A special kind of model which can have a scripted motion.

v17.collision.Collision([laser_retro, ...])

The collision properties of a link.

v17.geometry.Geometry([empty, box, ...])

The shape of the visual or collision object.

v17.joint.Joint([parent, child, ...])

A joint connects two links with kinematic and dynamic properties.

v17.light.Light([cast_shadows, diffuse, ...])

The light element describes a light source.

v17.link.Link([gravity, enable_wind, ...])

A physical link with inertia, collision, and visual properties.

v17.material.Material([script, shader, ...])

The material of the visual element.

v17.model.Model([static, self_collide, ...])

The model element defines a complete robot or any other physical object.

v17.physics.Physics([max_step_size, ...])

The physics tag specifies the type and properties of the dynamics engine.

v17.scene.Scene([ambient, background, sky, ...])

Specifies the look of the environment.

v17.sdf.Sdf([world, model, actor, light, ...])

SDFormat base element that can include 0-N models, actors, lights, and/or worlds.

v17.sensor.Sensor([always_on, update_rate, ...])

The sensor tag describes the type and properties of a sensor.

v17.state.State([sim_time, wall_time, ...])

Parameters

v17.state.Model([joint, model, scale, ...])

Model state.

v17.visual.Visual([cast_shadows, ...])

The visual properties of the link.

v17.world.World([audio, wind, include, ...])

The world element encapsulates an entire world description including: models, scene, physics, and plugins.