order_zone_points()

Article summary

Did you find this summary helpful?

Thank you for your feedback

Retrieve all the points that are composing a specified zone area.

Reference

Arguments	Type	Default value
zone_name	`str`		The requested zone on the map.
from_current_pose	`bool`	False	If `True`, sort from the current pose, if `False` sort from the center of the zone.

Dict with a bool if the points was sorted and the number of points.

Key	Type	Info
`ordered_points`	`bool`	`True` if the points were sorted successfully.
`num_points`	`int`	number of points.

Important note!

This function does not return the points, it only orders and stores them to be obtained with the function get_sorted_zone_point.

Exception	Condition
`RayaNavNotLocated`	The robot is not located on the map.
`RayaNavZonesNotFound`	No zones found on the map.
`RayaNavUnkownError`	An unknown error occurs.
`RayaWrongArgument`	`pos_unit` is neither `POS_UNIT.METERS` nor `POS_UNIT.PIXEL`.

Was this article helpful?

Table of contents