Rasterized rendering

module:

navground.sim.ui.render

Rasterizes SVG using cairosvg.

image_for_world(world: World, background_color: str = 'snow', **kwargs: Any) → ndarray[Any, dtype[uint8]]

Renders the world as a raw image

Parameters:

• world – The world to be rendered

• background_color – A valid SVG color for the background

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.

Returns:

An RGB image as a numpy array

png_for_world(world: World, background_color: str = 'snow', dpi: int = 96, **kwargs: Any) → bytes

Renders the world as an png image

Parameters:

• world – The world to be rendered

• background_color – A valid SVG color for the background

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.

Returns:

A png bytestring

pdf_for_world(world: World, background_color: str = 'snow', **kwargs: Any) → bytes

Renders the world as an pdf image

Parameters:

• world – The world to be rendered

• background_color – A valid SVG color for the background

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.

Returns:

A pdf bytestring