pyrobosim.core.locations.Location.__init__

Location.__init__(*, name: str, category: str, parent: ~pyrobosim.core.types.Entity, pose: ~pyrobosim.utils.pose.Pose = Pose: [x=0.00, y=0.00, z=0.00, qw=1.000, qx=0.000, qy=-0.000, qz=0.000], color: ~typing.Sequence[float] | str | None = None, is_open: bool = True, is_locked: bool = False, is_charger: bool = False) → None

Creates a location instance.

Parameters:

• name – Name of the location.

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

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

• pose – Pose of the location (required).

• color –

  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 – If True, the location is open, otherwise it is closed.

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

• is_charger – If True, the robot charges its battery at this location.