pyrobosim.core.locations.Location.__init__

Location.__init__(name=None, category=None, pose=None, parent=None, color=None, is_open=True, is_locked=False, is_charger=False)

Creates a location instance.

Parameters:

• name (str, optional) – Name of the location.

• category (str) – Location category (e.g., "table").

• pose (pyrobosim.utils.pose.Pose) – Pose of the location (required).

• parent (Entity) – Parent of the location (typically a pyrobosim.core.room.Room)

• color (list[float] | tuple[float, float, float] | str) –

  Visualization color. Input can be:

  • an (R, G, B) tuple or list in the range (0.0, 1.0).

  • a string (e.g., “red”).

  • a hexadecimal string (e.g., “#FF0000”).

  If using a category with a defined color, this parameter overrides the category color.

• is_open (bool, optional) – If True, the location is open, otherwise it is closed.

• is_locked (bool, optional) – If True, the location is locked, meaning it cannot be opened or closed.

• is_charger (bool, optional) – If True, the robot charges its battery at this location.