show

Show map, roadmap, and path

Since R2019b

Syntax

show(prm)

show(prm,Name,Value)

Description

show(prm) shows the map and the roadmap, specified as prm in a figure window. If no roadmap exists, update is called. If a path is computed before calling show, the path is also plotted on the figure.

show(prm,Name,Value) sets the specified Value to the property Name.

Input Arguments

prm — Roadmap path planner

mobileRobotPRM object

Roadmap path planner, specified as a mobileRobotPRM object.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Path','off'

Parent — Axes to plot the map

Axes object | UIAxes object

Axes to plot the map specified as a comma-separated pair consisting of "Parent" and either an Axes or UIAxesobject. See axes or uiaxes.

Map — Map display option

"on" (default) | "off"

Map display option, specified as the comma-separated pair consisting of "Map" and either "on" or "off".

Roadmap — Roadmap display option

"on" (default) | "off"

Roadmap display option, specified as the comma-separated pair consisting of "Roadmap" and either "on" or "off".

Path — Path display option

"on" (default) | "off"

Path display option, specified as "on" or "off". This controls whether the computed path is shown in the plot.

Version History

Introduced in R2019b