irsim.world.world3d#

Classes#

World3D

3D world wrapper that extends World with z range.

Module Contents#

class irsim.world.world3d.World3D(name: str, depth: float = 10.0, offset: list[float] | None = None, **kwargs: Any)[source]#

Bases: irsim.world.world.World

3D world wrapper that extends World with z range.

Initialize a 3D world extending the 2D world with depth.

Parameters:

  • name (str) – World name or YAML file path.

  • depth (float) – Z-depth of the world (range in z). Default 10.0.

  • offset (list[float] | None) – [x, y, z] world offset. If a 2D [x, y] is provided, z defaults to 0.

  • **kwargs – Forwarded to the base World constructor.

depth = 10.0#
offset = None#
z_range#